blueprints/{blueprint-id}/export

Use this resource to export a blueprint in a specified format.

Method summary

HTTP Method Path Description
GET /bwl/blueprints/{blueprint-id}/export Exports a blueprint in a specified format. You must have access to this blueprint.

GET /blueprints/{blueprint-id}/export

Description
Use this method to export a blueprint in a specified format.
Resource information
Requirements Description
Response format The format specified by the format parameter
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
blueprint-id Path The identifier of the blueprint to retrieve. Yes String
expand-all-subprocesses Query If true, all sub-processes are expanded in the process diagram export. By default, this parameter is false. No Boolean
format Query The format that you want your export to be in. The available options are: docx Yes String
include-activity-numbering Query If true, the activity numbers are included in the process diagram export. By default, this parameter is false. No Boolean
include-color-legend Query If true, the color legend is included in the process diagram export. By default, this parameter is false. No Boolean
include-custom-footer Query If true, the custom footer that was specified by an account admin in the Branding section of the Admin page is included in the export. The default value for this parameter depends on the value that was set by the account admin. No Boolean
include-linked-processes Query There are two possible values:
  • direct-only excludes indirectly linked processes. Only processes that are directly linked from this blueprint are included in the export.
  • all includes all linked processes.
If this parameter is omitted from the request, no linked processes are included in the export.		 No String
include-process-diagram Query If true, the process diagram is included in the export. By default, this parameter is true. No Boolean
include-property-details Query If true, the property details for each activity are included in the export. By default, this parameter is true. No Boolean
revision-id Query The version of the blueprint that you want to export. You can get a list of available version IDs using the Revision API. If you don't include this parameter, the latest version of the blueprint that is visible to you will be exported. No String
use-custom-property-order Query If true, the properties are arranged in the custom order that you set for them when you customized the properties in the Details view. If you did not set a custom order for the properties, they are arranged in the default order. By default, this parameter is false.

If the API is called by a Service ID, the properties are always arranged in the default order.

 No Boolean
Response
Example input
  • Using OAuth 2 client credentials:
    curl -i -H "Authorization: Bearer access_token"  
    "https://your_server_url/bwl/blueprints/13177b/export?format=docx"
Example output

File data.

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 or the version-id parameter that was provided identifies a blueprint 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:
  1. Download the rest-apis.zip file.
  2. Extract the openapi.yaml file.
  3. Open a web browser, and navigate to https://editor-next.swagger.io/.
  4. Import openapi.yaml using the File > Import File option.