Compliance API

Compliance API Reference

get  /archivist/v1/compliance/{asset_identity}

List all compliance status relevant to an asset

Description:

{
  "compliance": [
    {
      "compliance_policy_identity": "compliance_policies/0000-0000-000000000-00000000",
      "compliant": false
    }
  ],
  "compliant": false,
  "compliant_at": "2019-11-27T14:44:19Z"
}
Response Parameter Type Description
compliance array simple compliance status against a compliance policy.
compliant boolean overall compliance status for the asset
compliant_at string time at which compliance is determined
next_page_token string Token to retrieve the next page of results or empty if there are none.
Responses Description
200A successful response.
206The number of compliance statements exceeds the servers limit.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to access the requested resource.
404Returned when the asset with the id does not exist.
defaultAn unexpected error response.

get  /archivist/v1/compliance_policies

Description:

{
  "compliance_policies": [
    {
      "asset_filter": [
        {
          "or": [
            "attributes.arc_location_identity:locations/5eef2b71-35c1-4376-a166-6c64bfa72f4b"
          ]
        }
      ],
      "compliance_type": "COMPLIANCE_SINCE",
      "description": "sample compliance policy",
      "display_name": "my compliance policy",
      "event_display_type": "tracked event",
      "identity": "compliance_policies/463fab3a-bae5-4349-8f76-f6454da20c9d",
      "time_period_seconds": 86400
    }
  ],
  "next_page_token": "NDYzZmFiM2EtYmFlNS00MzQ5LThmNzYtZjY0NTRkYTIwYzlkCg=="
}
Response Parameter Type Description
compliance_policies array compliance policy
next_page_token string
Responses Description
200A successful response.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to access the requested resource.
404Returned when the asset with the id does not exist.
defaultAn unexpected error response.

post  /archivist/v1/compliance_policies

Description:

{
  "asset_filter": [
    {
      "or": [
        "attributes.arc_location_identity:locations/5eef2b71-35c1-4376-a166-6c64bfa72f4b"
      ]
    }
  ],
  "compliance_type": "COMPLIANCE_SINCE",
  "description": "Ensure Maintenance is performed daily",
  "display_name": "Daily Maintenance",
  "event_display_type": "Maintenance Performed",
  "time_period_seconds": 86800
}
Parameter Type Description
asset_filter array Filter
closing_event_display_type string this is the corelated event type
compliance_type policy type
description string descripton
display_name string display name
dynamic_variability number number of standard deviations - required for DYNAMIC_TOLERANCE
dynamic_window string valid period for policy - required for DYNAMIC_TOLERANCE
event_display_type string this is the target event_display_type - always required
richness_assertions array Filter
time_period_seconds string time delta - required for SINCE and PERIOD_OUTSTANDING

{
  "asset_filter": [
    {
      "or": [
        "attributes.arc_location_identity:locations/5eef2b71-35c1-4376-a166-6c64bfa72f4b"
      ]
    }
  ],
  "compliance_type": "COMPLIANCE_SINCE",
  "description": "Ensure Maintenance is performed daily",
  "display_name": "Daily Maintenance",
  "event_display_type": "Maintenance Performed",
  "identity": "compliance_policies/463fab3a-bae5-4349-8f76-f6454da20c9d",
  "time_period_seconds": 86800
}
Response Parameter Type Description
asset_filter array Filter
closing_event_display_type string
compliance_type
description string
display_name string
dynamic_variability number
dynamic_window string
event_display_type string
identity string
richness_assertions array Filter
time_period_seconds string
Responses Description
200A successful response.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to access the requested resource.
404Returned when the asset with the id does not exist.
defaultAn unexpected error response.

delete  /archivist/v1/{identity}

Description:

{
  "asset_filter": [
    {
      "or": [
        "attributes.arc_location_identity:locations/5eef2b71-35c1-4376-a166-6c64bfa72f4b"
      ]
    }
  ],
  "compliance_type": "COMPLIANCE_SINCE",
  "description": "Ensure Maintenance is performed daily",
  "display_name": "Daily Maintenance",
  "event_display_type": "Maintenance Performed",
  "identity": "compliance_policies/463fab3a-bae5-4349-8f76-f6454da20c9d",
  "time_period_seconds": 86800
}
Response Parameter Type Description
asset_filter array Filter
closing_event_display_type string
compliance_type
description string
display_name string
dynamic_variability number
dynamic_window string
event_display_type string
identity string
richness_assertions array Filter
time_period_seconds string
Responses Description
200A successful response.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to access the requested resource.
404Returned when the asset with the id does not exist.
defaultAn unexpected error response.

get  /archivist/v1/{identity}

Description:

{
  "asset_filter": [
    {
      "or": [
        "attributes.arc_location_identity:locations/5eef2b71-35c1-4376-a166-6c64bfa72f4b"
      ]
    }
  ],
  "compliance_type": "COMPLIANCE_SINCE",
  "description": "Ensure Maintenance is performed daily",
  "display_name": "Daily Maintenance",
  "event_display_type": "Maintenance Performed",
  "identity": "compliance_policies/463fab3a-bae5-4349-8f76-f6454da20c9d",
  "time_period_seconds": 86800
}
Response Parameter Type Description
asset_filter array Filter
closing_event_display_type string
compliance_type
description string
display_name string
dynamic_variability number
dynamic_window string
event_display_type string
identity string
richness_assertions array Filter
time_period_seconds string
Responses Description
200A successful response.
401Returned when the user is not authenticated to the system.
403Returned when the user is not authorized to access the requested resource.
404Returned when the asset with the id does not exist.
defaultAn unexpected error response.

Edit this page on GitHub