Import - AcceleratorKMS - Version 3.12 - Help - Hexagon

AcceleratorKMS API Guide

Language
English
Product
AcceleratorKMS
Search by Category
Help
AcceleratorKMS Version
3.12

Use the Import API to create content in AcceleratorKMS from existing JSON content.

URL

https://AcceleratorKMS_URL/api/Document/Import

Where:

AcceleratorKMS_URL is replaced with your AcceleratorKMS instance.

HTTP Verb

Make an HTTP Post 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 POST’s content response as JSON format

Designates the POST’s content response as JSON format

Parameters

Import API accepts the following parameters:

Parameter

Description

[in] document

A Mandatory DocumentModel parameter.

Imported documents require JSON string format and the request body must adhere to ApiModel.ContentModel.

[in] updateExisting

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

  • If "true" is passed - Document (if already exists) is updated in AcceleratorKMS.

  • If "false" is passed - User is notified that a similar document already exists in AcceleratorKMS and the operation is aborted.

[in] debug

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

  • If "true" is passed - Importing to AcceleratorKMS is not done. Rather, a simulation of import is shown. For more information, see the endpoint return value.

  • If "false" is passed - The document is imported into AcceleratorKMS.

[out] return

Import.ImportResult

For more information about "DocumentModel" and "ImportResult", see AcceleratorKMS Import Models documentation.