blueprints/{blueprint-id}

Use this resource to retrieve information about a specific blueprint.

Method summary

HTTP Method	Path	Description
GET	/bwl/blueprints/{blueprint-id}	Retrieves information about a specific blueprint. You must have access to this blueprint.

GET /blueprints/{blueprint-id}

Description: Use this method to return the details of a specific blueprint.

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
Rate Limited	IBM Blueworks Live applies a rate limit that determines how often this API can be called within a specific period. The allowed rate is 200 requests per minute for a single user. Once the rate limit for the API is exceeded for the user, the next request is rejected with status code 429 and response header Retry-After, which indicates the number of seconds when the next request can be made.

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
blueprint-id	Path	The identifier of the blueprint to retrieve.	Yes	String

Response

Example input

GET the details of a specific blueprint:

Using OAuth 2 client credentials:

curl -i -H "Authorization: Bearer access_token"  
    "https://your_server_url/bwl/blueprints/250012"

Example output

GET the details of a specific blueprint:

{
  "name": "MyBlueprint",
  "id": "250012",
  "type": "blueprint",
  "tags": [
    
  ],
  "milestones": [
    {
      "name": "Milestone 1",
      "id": "250016",
      "type": "milestone",
      "activities": [
        {
          "name": "Activity",
          "id": "25001a",
          "type": "activity",
          "sub-type": "normal",
          "attached-boundary-events" : [ {
              "name" : "Error",
              "id" : "2d0308",
              "type" : "boundary-event",
              "sub-type" : "error-event"
              }, {
              "name" : "Timer",
              "id" : "2f0b13",
              "type" : "boundary-event",
              "sub-type" : "timer-event"
              }, {
              "name" : "Message",
              "id" : "2f0b17",
              "type" : "boundary-event",
              "sub-type" : "message-event"
          } ],
          "text-annotation" : {
              "text" : "Activity annotation 1",
              "id" : "5c031f"
          }
        }
      ]
    },
    {
      "name": "Milestone 2",
      "id": "250018",
      "type": "milestone"
    }
  ],
  "space-ids": [
    "250006"
  ],
  "space-names": [
    "MySpace"
  ],
  "archived-state": "active",
  "published-state": "unpublished",
  "last-modified-date": "2017-02-03T22:41:41.384+0000",
  "last-modified-by-user": {
    "id": "50029",
    "full-name": "Edith Editor",
    "email-address": "edith"
  },
  "created-date": "2017-02-01T22:41:41.260+0000",
  "created-by-user": {
    "id": "50029",
    "full-name": "Edith Editor",
    "email-address": "edith"
  }
  "text-annotations" : [ {
    "text" : "Process annotation 1",
    "id" : "5d030c"
  }, {
    "text" : "Process annotation 2",
    "id" : "5d032d"
  } ]
}

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 because you have insufficient permissions for the specified blueprint.
404	The blueprint-id parameter identifies a blueprint that does not exist in this account.
429	The request exceeded the rate limit of the API.

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.