blueprints/import

Use this resource to import a blueprint in a specified format. The API supports bpmn, xml or zip (IBM® Blueworks Live export format) to import.

Note: API documentation migrated to IBM API Hub External link opens a new window or tab

. Find the latest updates and documentation for Blueworks Live APIs in API Hub.

Method summary

HTTP Method	Path	Description
POST	/bwl/blueprints/import	Import a blueprint in a specified format.

POST /bwl/blueprints/import

Description: Use this method to import a blueprint in a specific format.

Resource information

Requirements	Description
Response format	JSON
Requires authentication	Yes
Supports OAuth 2 client credentials	Yes using a User Service ID containing Artifact Authoring 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 hour. The rate limit is applied to the whole account. Even if different authentication methods are used, the single account-wide rate is applied across all users. When the rate limit for the API is exceeded for the account, 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-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
file	form-data	The file data.	Yes	RFC 1867 compliant multipart/form-data stream
name	form-data	Name of the process blueprint.	No	String
space-id	form-data	The identifier of the space to import the process within.	Yes	String

Response

Example input

Import BWL BPMN zip file or a BPMN file:

Using User Service ID OAuth 2 client credentials:

curl -i -X POST \
 'https://your_server_url/bwl/blueprints/import' \
 --header 'Content-Type: multipart/form-data' \
 --header 'Authorization: Bearer access_token' \
 --form 'space-id="5f6000cc60034"' \
 --form 'name="Process1"' \
 --form 'file=@/users/username/docs/onboarding.zip'

Using Service ID OAuth 2 client credentials:

curl -i -X POST \
 'https://your_server_url/bwl/blueprints/import' \
 --header 'Content-Type: multipart/form-data' \
 --header 'Authorization: Bearer access_token' \
 --header 'X-On-Behalf-Of: user_name@domain.com' \
 --header 'Authorization: Bearer access_token' \
 --form 'space-id="5f6000cc60034"' \
 --form 'name="Process1"' \
 --form 'file=@/users/username/docs/onboarding.zip'

Example output

{
  "artifacts: [
    {
      "artifact-id" : "130d43",
      "name" : "Onboarding Process"
    },
    {
      "artifact-id" : "130d43",
      "name" : "Linked - Onboarding Hiring"
    }
}

Response properties

artifact-id

The ID of the blueprint created

name

Name of the blueprint created

Response headers

Header name	Description
Retry-After	When the next request can be made, in number of seconds.

Response messages

HTTP code	Reason
200	The request was completed successfully.
400	There is 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.
429	The request exceeded the rate limit of the API for this account.