LiveDocs Web API

livedocs/api/v1/blocks

GET Returns a listing of links to Live Blocks.

Description

The result can be refined by using a query string and pagination parameters.


Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
start-index query

The index at which the result set should start.

 Integer
max-results query

The maximum number of results to be returned. If there are more results in the matching result set, previous and next links will be included to point to preceding and following results respectively.

 Integer
q query

The query string used to filter the result set. The query string can contain a number of parameters to filter on various block properties. Double quotes (escape them as %22 in the request parameter) can be used to specify values with spaces or other special characters. Special characters like semicolon or double quote should be escaped using a backslash (so double quote becomes \%22).

Query parameters

  • ui-language:{value} : The code of the language on which the name and meta filters should apply. If omitted, all languages are searched.
  • name:{value}: Match only Blocks with the specified name.
  • meta:{meta-key}:{value}: Match only Blocks of which the specified meta field contains the specified value.
  • content-language:{value}: The code of the language on which the content filter should apply. If omitted, all languages are searched.
  • content:{value}: Match only Blocks of which the content contains the specified value.

Examples

/livedocs/api/v1/blocks/?q=ui-language:en+name:%22My+block%22+meta:type:Body+meta:formal:yes+content:Hello

 String

POST Create a new Live Block.

Description

The request body should contain the definition of the Live Block that is to be added.


Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String

Responses

201 The Live Block was created successfully. A relative link to the block will be returned in the response body. Additionally, an absolute link to the created Live Block will be set for the Location HTTP header in the response.

livedocs/api/v1/blocks/{path}

GET Retrieve the Live Block at the specified location.

Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
path path

The location of the desired Block.

 String

PUT Update or create the Live Block at the specified location.

Description

The request body should contain the definition of the Live Block that is to be added.


Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
path path

The location of the desired Block.

 String

DELETE Delete the Live Block at the specified location.

Description

The Live Block will be removed from the system, even if it is still used in Live Document Definitions.


Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
path path

The location of the desired Block.

 String

livedocs/api/v1/document-definitions

GET Returns a listing of links to Live Documentation Definitions.

Description

The result can be refined by using a query string and pagination parameters.


Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
start-index query

The index at which the result set should start.

 Integer
max-results query

The maximum number of results to be returned. If there are more results in the matching result set, previous and next links will be included to point to preceding and following results respectively.

 Integer
q query

The query string used to filter the result set. The query string can contain a number of parameters to filter on various Document Definition properties. Double quotes (escape them as %22 in the request parameter) can be used to specify values with spaces or other special characters. Special characters like semicolon or double quote should be escaped using a backslash (so double quote becomes \%22).

Query parameters

  • ui-language:{value} : The code of the language on which the name and meta filters should apply. If omitted, all languages are searched.
  • name:{value}: Match only Document Definitions with the specified name.
  • meta:{meta-key}:{value}: Match only Document Definitions of which the specified meta field contains the specified value.

Examples

/livedocs/api/v1/document-definitions/?q=ui-language:en+name:%22My+document%22+meta:type:claims

 String

POST Create a new Live Document Definition.

Description

The request body should contain the Live Document Definition that is to be added.


Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String

Responses

201 The Live Document Definition was created successfully. A relative link to the block will be returned in the response body. Additionally, an absolute link to the created Live Block will be set for the Location HTTP header in the response.

livedocs/api/v1/document-definitions/{path}

GET Retrieve the Live Document Definition at the specified location.

Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
path path

The location of the desired Document Definition.

 String

PUT Update or create the Live Document Definition at the specified location.

Description

The request body should contain the Live Document Definition that is to be added.


Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
path path

The location of the desired Document Definition.

 String

DELETE Delete the Live Document Definition at the specified location.

Description

The Live Document Definition will be removed from the system.


Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
path path

The location of the desired Document Definition.

 String

livedocs/api/v1/document-instances

GET Returns a listing of links to Live Documentation Instances.

Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
start-index query

The index at which the result set should start.

 Integer
max-results query

The maximum number of results to be returned. If there are more results in the matching result set, previous and next links will be included to point to preceding and following results respectively.

 Integer
q query

The query string used to filter the result set. The query string can contain a number of parameters to filter on various block properties. Double quotes (escape them as %22 in the request parameter) can be used to specify values with spaces or other special characters. Special characters like semicolon or double quote should be escaped using a backslash (so double quote becomes \%22).

Query parameters

  • ui-language:{value} : The code of the language on which the name and meta filters should apply. If omitted, all languages are searched.
  • name:{value}: Match only Document Instances with the specified name.
  • meta:{meta-key}:{value}: Match only Document Instances of which the specified meta field contains the specified value.

Examples

/livedocs/api/v1/document-instances/?q=ui-language:en+name:%22My+document%22+meta:type:claims

 String

POST Create a new Live Document Instance.

Description

This call has two modes.

  • In the first mode, the request body should contain the definition of the Live Document Instance that has to be added. No request parameters should be passed.
  • In the second mode, the Live Document Instance is generated, based on the document-definition-path, a datasource and the destination-language. The datasource can either be uploaded in the request body, or the path of an existing datasource can be specified in the datasource-path request parameter.

Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
document-definition-path query

The location of the Live Document Definition that should be used.

 String
datasource-path query

The location of the data resource that should be used (see Integration). If this parameter is not set in the second mode, the datasource should be uploaded as request body.

 String
destination-language query

The code of the language that should be used for the contents of the Live Document Instance.

 String

Responses

201 The Live Document Instance was created successfully. A relative link to the document will be returned in the response body. Additionally, an absolute link to the created Live Document Instance will be set for the Location HTTP header in the response.

livedocs/api/v1/document-instances/{path}

GET Retrieve the Live Document Instance at the specified location.

Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
path path

The location of the desired Live Document Instance.

 String

PUT Update or create the Live Document Instance at the specified location.

Description

This call has two modes.

  • In the first mode, the request body should contain the definition of the Live Document Instance that has to be put. No request parameters should be passed.
  • In the second mode, the Live Document Instance is generated, based on the document-definition-path, a datasource and the destination-language. The datasource can either be uploaded in the request body, or the path of an existing datasource can be specified in the datasource-path request parameter.

Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
path path

The location of the desired Live Document Instance.

 String
document-definition-path query

The location of the Live Document Definition that should be used.

 String
datasource-path query

The location of the data resource that should be used (see Integration). If this parameter is not set in the second mode, the datasource should be uploaded as request body.

 String
destination-language query

The code of the language that should be used for the contents of the Live Document Instance.

 String

DELETE Delete the Live Document Instance at the specified location.

Description

The Live Document Instance will be removed from the system.


Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
path path

The location of the desired Live Document Instance.

 String

livedocs/api/v1/document-instances-ops/send

POST Simulates the 'Send' button from the user interface.

Description

See Actions. The Live Document Instance will be made available for final output generation.

This call has two modes.

  • In the first mode, the document-instance-path request parameter needs to specify which Instance needs to be sent.
  • In the second mode, the Live Document Instance is also generated, based on the document-definition-path, the datasource-path and the destination-language.

Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
document-instance-path query

The location of the Live Document Instance that needs to be sent.

 String
document-definition-path query

The location of the Live Document Definition that should be used.

 String
datasource-path query

The location of the data resource that should be used (see Integration). If this parameter is not set in the second mode, the datasource should be uploaded as request body.

 String
destination-language query

The code of the language that should be used for the contents of the Live Document Instance.

 String
action-id query

Indicates what action should be performed. This ID will be added to the Live Document Instance and can be used to decide on the delivery channel and the output format in Document Flow.

 String

livedocs/api/v1/datasources

GET Returns a listing of links to datasources.

Description

The result can be refined by using pagination parameters.


Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
start-index query

The index at which the result set should start.

 Integer
max-results query

The maximum number of results to be returned. If there are more results in the matching result set, previous and next links will be included to point to preceding and following results respectively.

 Integer

POST Create a new datasource.

Description

The request body should contain the datasource that is to be added.


Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String

Responses

201 The datasource was created successfully. A relative link to the datasource will be returned in the response body. Additionally, an absolute link to the created datasource will be set for the Location HTTP header in the response.

livedocs/api/v1/datasources/{path}

GET Retrieve the datasource at the specified location.

Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
path path

The location of the desired datasource.

 String

PUT Update or create the datasource at the specified location.

Description

The request body should contain the datasource that is to be added.


Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
path path

The location of the desired datasource.

 String

DELETE Delete the datasource at the specified location.

Description

The datasource will be removed from the system.


Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
path path

The location of the desired datasource.

 String

livedocs/api/v1/metadata

GET Returns a listing of links to metadata configuration.

Description

The result can be refined by using pagination parameters.


Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
start-index query

The index at which the result set should start.

 Integer
max-results query

The maximum number of results to be returned. If there are more results in the matching result set, previous and next links will be included to point to preceding and following results respectively.

 Integer

livedocs/api/v1/metadata/{id}

GET Retrieve the metadata configuration with the specified ID.

Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
id path

The ID of the metadata configuration that needs to be returned. Allowed values are block and document.

 String

PUT Update or create the metadata configuration with the specified ID.

Description

The request body should contain the metadata configuration that is to be added.


Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
id path

The ID of the metadata configuration that must be replaced. Allowed values are block and document.

 String

DELETE Delete the metadata configuration with the specified ID.

Description

The metadata configuration will be removed from the system.


Parameters

Name Located in Description Type
workspace-name query

The name of the workspace that needs to be used. If this parameter is absent, the active workspace of the user doing the request is used.

 String
account-name query

To be used together with the workspace-name request parameter. The name of the account that the workspace belongs to.

 String
id path

The ID of the metadata configuration that needs to be deleted. Allowed values are block and document.

 String