API on data processing in Analytical workspaces

Function¶

It launches the necessary data processing to export, import, duplicate and update Analytical workspaces.

Protocol¶

Open RESTful API

Data processing on Analytical Workspace¶

Analytical Workspace Export¶

APIs for running the export of an Analytical Workspace

Runs the export of the Analytical Workspace workspace_code from the environment indicated via database_id.

Method¶

POST

URL¶

/aih/export/v1/database_id/workspace_code

Parameters¶

Parameter	type	Required	Description
date	boolean	Optional	Includes the Analytical Workspace data in the export, in addition to the setup. Values: true/false Default: false.

Examples

Copy

{
    "data": true
}

Data returned¶

The response returns the following ID in JSON format:

dataprocessingId = data processing ID.

Copy

{
    "dataprocessingId":"FF8081817A4264E5017A42D08E3C21EB"
}

API for checking an Analytical Workspace's export status

Returns the export process status.

Method¶

GET

URL¶

/aih/export/v1/dataprocessingId

Data returned¶

The response returns the data processing status in JSON format:

status: RUNNING/FAILED/COMPLETED

Status	Description
RUNNING	Running
FAILED	Failed
COMPLETED	Completed successfully

exportedFileNames: produced file names

Copy

{
    "requestDateTime": "2021-06-25T10:56:42.850+0000",
    "status": "COMPLETED",
    "parameters": [
        {
            "exportedFileNames": "export_DB_USER_1_20230206115313820.awex"
        }
    ]
}

API for stopping an Analytical Workspace export

Stops the export.

Method¶

DELETE

URL¶

/aih/export/v1/dataprocessingId

Data returned¶

The response returns the following ID in JSON format:

message = Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"

Message	Description
Stop on dataprocessingOid	Data Processing was stopped
Notify on dataprocessingOid	Data processing requested to be stopped but still in progress

Copy

{
    "message": "Stop on dataprocessingOid FF8081817A4264E5017A42D08E3C21EB"
}

Analytical Workspace import¶

API for running the import of an Analytical Workspace

Runs the import of the Analytical Workspace contained in an export file, indicated in the body using filename, on the environment identified with database_id.

Method¶

POST

URL¶

/aih/import/v1/database_id

Properties in JSON format¶

The following properties can be included in JSON format in the body of the request.

Property	Description	Options
filename	Mandatory. Identifies the file to import.	It is possible to specify: - an individual file name - a list of file names (separator character = ;) - all files with .awex extension (filename = *)
endpoint	Endpoint to be used if the file is located in a remote directory. See .	-
dir	Directory on which files reside	If an Endpoint is specified, it allows the sub-directory to be specified based on the Endpoint’s root. If an Endpoint has not been specified, the following can be specified: - empty field = directory configured as a CCH Tagetik writable folder - relative path = writable folder sub-directory - absolute path = specified generic directory (see the in the System Administration module)

Examples

Copy

Import of 'export.awex' file from the Writable folder

{
    "filename": "export.awex",
    "endpoint": "",
    "dir": ""
}

Copy

Import of 'export.awex' file from the 'C:\impexp' directory

{
    "filename": "export.awex",
    "endpoint": "",
    "dir": "C:\impexp"
}

Copy

Import of 'export.awex' file via SFTP endpoint

{
    "filename": "export.awex",
    "endpoint": "SFTP",
    "dir": ""
}

Copy

Import of "export.awex" file on the "tmp" sub-directory of the SFTP endpoint

{
    "filename": "export.awex",
    "endpoint": "SFTP",
    "dir": "tmp"
}

Copy

Import of files "export_1_of_2.awex" and "export_2_of_2.awex" on the SFTP endpoint

{
    "filename": "export_1_of_2.awex;export_2_of_2.awex",
    "endpoint": "SFTP",
    "dir": ""
}

Copy

Import of all files with ".awex" extension present on the SFTP endpoint

{
    "filename": "*",
    "endpoint": "SFTP",
    "dir": ""
}

Data returned¶

In the response, the following ID will be returned in JSON format:

dataprocessingId = data processing ID

Copy

{
    "dataprocessingId":"FF8081817A4264E5017A42D08E3C21EB"
}

API for checking an Analytical Workspace's import status

Returns the import process status.

Method¶

GET

URL¶

/aih/import/v1/dataprocessingId

Data returned¶

The response returns the data processing status in JSON format:

status: RUNNING/FAILED/COMPLETED

Status	Description
RUNNING	Running
FAILED	Failed
COMPLETED	Completed successfully

Copy

{
    "requestDateTime": "2021-06-25T10:56:42.850+0000",
    "status": "COMPLETED",
    "parameters": []
}

API for stopping an Analytical Workspace import

Stops the import.

Method¶

DELETE

URL¶

/aih/import/v1/dataprocessingId

Data returned¶

The response returns the following ID in JSON format:

message = Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"

Message	Description
Stop on dataprocessingOid	Data Processing was stopped
Notify on dataprocessingOid	Data processing requested to be stopped but still in progress

Copy

{
    "message": "Stop on dataprocessingOid FF8081817A4264E5017A42D08E3C21EB"
}

Analytical Workspace Duplication¶

API to duplicate an Analytical workspace

Duplicates the Analytical Workspace source_workspace_code from the environment indicated by database_id.

Method¶

POST

URL¶

/aih/clone/v1/database_id/source_workspace_code

Parameters¶

Parameter	type	Required	Description
targetWorkspaceCode	text	Mandatory	Analytical Workspace code to be created.
targetWorkspaceDescriptions	***	Mandatory	List of descriptions to be assigned to the created Analytical Workspace.
date	boolean	Optional	Includes the data of the duplicated Analytical workspace in the duplication. Values: true/false Default: false.
forms	boolean	Optional	Includes in the duplication the forms related to the duplicated Analytical workspace. Values: true/false Default: false.

Examples

Copy

{
    "targetWorkspaceCode":"001",
    "targetWorkspaceDescriptions": {
        "it":"Nuovo AW",
        "en": "New AW"
    },
    "data":true,
    "forms":false
}

Data returned¶

The response returns the following ID in JSON format:

dataprocessingId = data processing ID.

Copy

{
    "dataprocessingId":"FF8081817A4264E5017A42D08E3C21EB"
}

API to check the duplication status of an Analytical workspace

Returns the status of duplication data processing.

Method¶

GET

URL¶

/aih/clone/v1/dataprocessingId

Data returned¶

The response returns the data processing status in JSON format:

status: RUNNING/FAILED/COMPLETED

Status	Description
RUNNING	Running
FAILED	Failed
COMPLETED	Completed successfully

Copy

{
    "requestDateTime": "2021-06-25T10:56:42.850+0000",
    "status": "COMPLETED",
    "parameters": []
}

API for aborting the duplication of an Analytical workspace

Interrupts duplication.

Method¶

DELETE

URL¶

/aih/clone/v1/dataprocessingId

Data returned¶

The response returns the following ID in JSON format:

message = Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"

Message	Description
Stop on dataprocessingOid	Data Processing was stopped
Notify on dataprocessingOid	Data processing requested to be stopped but still in progress

Copy

{
    "message": "Stop on dataprocessingOid FF8081817A4264E5017A42D08E3C21EB"
}

Analytical Workspace Update¶

API to perform the update of an Analytical workspace

Updates he Analytical Workspace target_workspace_code from the environment indicated via database_id.

Method¶

POST

URL¶

/aih/update/v1/database_id/target_workspace_code

Parameters¶

Parameter	type	Required	Description
sourceType	text	Mandatory	Specifies the source type of the update. Values: LOCAL, FILE
disableDataManagementAudit	boolean	Optional	Disable the 'Data Management' item in the audit Values: true/false Default: false
dtpOperationSortingType	text	Optional	Indicates how the operations of a DTP are updated. Values: REORDER_USING_CODES, APPEND Default: REORDER_USING_CODES
sourceWorkspaceCode	text	Mandatory, definable only if sourceType = LOCAL	Analytical Workspace code to update from.
date	boolean	Optional, definable only if sourceType = LOCAL	Includes data from the source Analytical workspace in the update. Values: true/false Default: false.
filename	text	Mandatory, definable only if sourceType = FILE	Identifies the file to import. It is possible to specify: - an individual file name - a list of file names (separator character = ;) - all files with .awex extension (filename = *)
endpoint	text	Optional, definable only if sourceType = FILE	Endpoint to be used if the file is located in a remote directory. See .
dir	text	Optional, definable only if sourceType = FILE	Directory in which the files are located. If an Endpoint is specified, it allows the sub-directory to be specified based on the Endpoint’s root. If an Endpoint has not been specified, the following can be specified: - empty field = directory configured as a CCH Tagetik writable folder - relative path = writable folder sub-directory - absolute path = specified generic directory (see the in the System Administration module)

Examples

Copy

{
    "sourceType": "LOCAL",
    "dtpOperationSortingType": "REORDER_USING_CODES",
    "sourceWorkspaceCode":"005",
    "data": true
}

Copy

{
    "sourceType": "FILE",
    "dtpOperationSortingType": "APPEND",
    "filename":"export.awex",
    "endpoint":"",
    "dir":"tmp"
}

Data returned¶

The response returns the following ID in JSON format:

dataprocessingId = data processing ID.

Copy

{
    "dataprocessingId":"FF8081817A4264E5017A42D08E3C21EB"
}

API to check the update status of an Analytical workspace

Returns the status of the update data processing.

Method¶

GET

URL¶

/aih/update/v1/dataprocessingId

Data returned¶

The response returns the data processing status in JSON format:

status: RUNNING/FAILED/COMPLETED

Status	Description
RUNNING	Running
FAILED	Failed
COMPLETED	Completed successfully

Copy

{
    "requestDateTime": "2021-06-25T10:56:42.850+0000",
    "status": "COMPLETED",
    "parameters": []
}

API to interrupt the update of an Analytical workspace

Stops the update.

Method¶

DELETE

URL¶

/aih/update/v1/dataprocessingId

Data returned¶

The response returns the following ID in JSON format:

message = Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"

Message	Description
Stop on dataprocessingOid	Data Processing was stopped
Notify on dataprocessingOid	Data processing requested to be stopped but still in progress

Copy

{
    "message": "Stop on dataprocessingOid FF8081817A4264E5017A42D08E3C21EB"
}

DTP export of an Analytical Workspace¶

API for exporting a DTP from an Analytical workspace

Runs the export of the DTP dtp_code belonging to the Analytical Workspace workspace_code from the environment indicated via database_id.

Method¶

POST

URL¶

/aih/dtpexport/v1/database_id/workspace_code/dtp_code

Parameters¶

None

Data returned¶

The response returns the following ID in JSON format:

dataprocessingId = data processing ID.

Copy

{
    "dataprocessingId":"FF8081817A4264E5017A42D08E3C21EB"
}

API to check the export status of a DTP from an Analytical workspace

Returns the status of the DTP export processing.

Method¶

GET

URL¶

/aih/dtpexport/v1/dataprocessingId

Data returned¶

The response returns the data processing status in JSON format:

status: RUNNING/FAILED/COMPLETED

Status	Description
RUNNING	Running
FAILED	Failed
COMPLETED	Completed successfully

exportedFileNames: produced file names

Copy

{
    "requestDateTime": "2021-06-25T10:56:42.850+0000",
    "status": "COMPLETED",
    "parameters": [
        {
            "exportedFileNames": "DTP_export_DB_USER_1_20230206115313820.awex"
        }
    ]
}

API to abort a DTP export of an Analytical workspace

Stops DTP export.

Method¶

DELETE

URL¶

/aih/dtpexport/v1/dataprocessingId

Data returned¶

The response returns the following ID in JSON format:

message = Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"

Message	Description
Stop on dataprocessingOid	Data Processing was stopped
Notify on dataprocessingOid	Data processing requested to be stopped but still in progress

Copy

{
    "message": "Stop on dataprocessingOid FF8081817A4264E5017A42D08E3C21EB"
}

DTP import of an Analytical Workspace¶

API to import a DTP from an Analytical workspace

Imports a DTP from the Analytical workspace workspace_code, on the environment identified with database_id.

Method¶

POST

URL¶

/aih/dtpimport/v1/database_id/workspace_code

Properties in JSON format¶

The following properties can be included in JSON format in the body of the request.

Parameter	type	Required	Description
filename	text	Mandatory	Identifies the file to import. It is possible to specify: - an individual file name - a list of file names (separator character = ;) - all files with .awex extension (filename = *)
endpoint	text	Optional	Endpoint to be used if the file is located in a remote directory. See .
dir	text	Optional	Directory in which the files are located. If an Endpoint is specified, it allows the sub-directory to be specified based on the Endpoint’s root. If an Endpoint has not been specified, the following can be specified: - empty field = directory configured as a CCH Tagetik writable folder - relative path = writable folder sub-directory - absolute path = specified generic directory (see the in the System Administration module)

Examples

Copy

{
    "filename": "DTP_export.awex",
    "endpoint": "",
    "dir": "tmp"
}

Copy

{
    "filename": "DTP_export.awex",
    "endpoint": "SFTP",
    "dir": ""
}

Data returned¶

In the response, the following ID will be returned in JSON format:

dataprocessingId = data processing ID

Copy

{
    "dataprocessingId":"FF8081817A4264E5017A42D08E3C21EB"
}

API to check the import status of a DTP from an Analytical workspace

Returns the status of the DTP import data processing.

Method¶

GET

URL¶

/aih/dtpimport/v1/dataprocessingId

Data returned¶

The response returns the data processing status in JSON format:

status: RUNNING/FAILED/COMPLETED

Status	Description
RUNNING	Running
FAILED	Failed
COMPLETED	Completed successfully

Copy

{
    "requestDateTime": "2021-06-25T10:56:42.850+0000",
    "status": "COMPLETED",
    "parameters": []
}

API to interrupt the import of a DTP from an Analytical workspace

Stops the import of DTP.

Method¶

DELETE

URL¶

/aih/dtpimport/v1/dataprocessingId

Data returned¶

The response returns the following ID in JSON format:

message = Stop on dataprocessingOid dataprocessingId" / "Notify on dataprocessingOid dataprocessingId"

Message	Description
Stop on dataprocessingOid	Data Processing was stopped
Notify on dataprocessingOid	Data processing requested to be stopped but still in progress

Copy

{
    "message": "Stop on dataprocessingOid FF8081817A4264E5017A42D08E3C21EB"
}