Get Content - AcceleratorKMS - Version 5.0 - Help - Hexagon

AcceleratorKMS API Guide

Language
English
Product
AcceleratorKMS
Search by Category
Help
AcceleratorKMS Version
5.1

Use the Get Content API to export content from AcceleratorKMS in a JSON format.

URL

https://AcceleratorKMS_URL/api/Content/Get

Where:

AcceleratorKMS_URL is replaced with your AcceleratorKMS instance.

HTTP Verb

Make an HTTP GET request using the following header and parameters.

Header

Key

Value

Description

Authorization

bearer <token>

Actual token value acquired from the authentication step

Content-Type

application/json

Designates the GET's content response as JSON format

Designates the GET's content response as JSON format

Parameters

Export API accepts the following parameters:

Parameter

Type

Description

[in] id

String

The identifier (GUID) of the content.

[in] includeAttachmentData

Boolean

An optional query string Boolean parameter that can accept either "true" or "false" [default]:

  • When "true" is passed, results include the Statement Attachment details.

  • When "false" is passed, results do not include the Statement Attachment details.

[in] includeStatementTypes

Boolean

An optional query string Boolean parameter that can accept either "true" or "false" [default]:

  • When "true" is passed, results include a list of all statement types and their details, that are used in content.

  • When "false" is passed, results do not include a list of all statement types that are used in the content.

[out] return

String

AcceleratorKms.Model.Api.ContentApiResponseModel

Exported documents respond with JSON string format that adheres to ApiModel.DocumentModel or ApiModel.FlowModel

For more information about "DocumentModel", "FlowModel" and "ContentApiResponseModel", see AcceleratorKMS API Reference document.

Sample Query

https://AcceleratorKMSUrl/api/Content/get?id=4a1c9351-bf94-4e03-ae8e-ba11e65e9f5d&includeStatementTypes=true