policies/{policy-id}/usage

Use this resource to retrieve the details of where a specific policy model is used.

Method summary

HTTP Method	Path	Description
GET	/bwl/policies/{policy-id}/usage	Returns information about where a specific policy model is used. You must have access to this policy model.

GET /policies/{policy-id}/usage

Description: Use this method to return the details of where a specific policy model is used.

Resource information

Requirements	Description
Response format	JSON
Requires authentication	Yes
Supports OAuth 2 client credentials	Yes using a User Service ID containing Artifact Reporting Category

Parameters

Name	Location	Description	Required	Type
X-IBM-API-Version	Header	The version of this API. If you are programming against the API, you MUST include the version. If omitted, the latest version of the API is used, which might be incompatible with prior versions. The current value is `1.0.0`.	No	String
X-On-Behalf-Of	Header	The user context. The value must be a username in the account. The user must have permission to perform the action in the account and in the specified parent space, if any.	Required if Service ID OAuth credentials are used. Not required when using User Service ID OAuth credential.	String
policy-id	Path	The identifier of the policy model to retrieve.	Yes	String

Response

Example input

GET the details of where a specific policy is used:

Using OAuth 2 client credentials:

curl -i -H "Authorization: Bearer access_token"  
    "https://your_server_url/bwl/policies/250062/usage"

Example output

GET the details of where a specific policy is used:

{
  "target-artifact-name": "MyPolicy",
  "target-artifact-id": "250062",
  "usage-count": 2,
  "used-by-artifacts": [
    {
      "id": "250036",
      "name": "AnotherBlueprint",
      "type": "blueprint",
      "space-ids": [
        "250006"
      ],
      "space-names": [
        "MySpace"
      ],
      "archived-state": "active",
      "published-state": "unpublished",
      "last-modified-date": "2017-01-03T22:41:41.384+0000",
      "last-modified-by-user": {
        "id": "50029",
        "full-name": "Edith Editor",
        "email-address": "edith"
      },
      "created-date": "2017-01-01T22:41:41.260+0000",
      "created-by-user": {
        "id": "50029",
        "full-name": "Edith Editor",
        "email-address": "edith"
      },
      "blueprint-items": [
        {
          "type": "activity",
          "id": "250038",
          "name": "AnotherBlueprint"
        }
      ]
    },
    {
      "id": "2500b1",
      "name": "MyDecision",
      "type": "decision",
      "space-ids": [
        "250006"
      ],
      "space-names": [
        "MySpace"
      ],
      "archived-state": "active",
      "published-state": "unpublished",
      "last-modified-date": "2017-03-03T22:41:41.384+0000",
      "last-modified-by-user": {
        "id": "50029",
        "full-name": "Edith Editor",
        "email-address": "edith"
      },
      "created-date": "2016-12-01T22:41:41.260+0000",
      "created-by-user": {
        "id": "50029",
        "full-name": "Edith Editor",
        "email-address": "edith"
      },
      "decision-items": [
        {
          "type": "sub-decision",
          "id": "2500b3",
          "name": "MyDecision"
        }
      ]
    }
  ]
}

Response messages

HTTP code	Reason
200	The request was completed successfully.
400	There was an error processing the request. Required parameters were missing or contained invalid values.
401	This user didn't pass authentication. This response could appear for the following reasons: An invalid username or password was provided. This user belongs to multiple accounts and an account wasn't specified in the request.
403	Access is forbidden.
404	The policy-id parameter identifies a policy that does not exist in this account.

More details

To get more details about the operations and response values, use a Swagger Editor to view the APIs:

Download the rest-apis.zip file.
Extract the openapi.yaml file.
Open a web browser, and navigate to https://editor-next.swagger.io/.
Import openapi.yaml using the File > Import File option.