Processing Information REST Endpoints

Sort by

Task Path Method

Extensibility/Processing Information

The process information resource lets you view, create, update, and delete processing information in the Extensibility Solution at the runtime. The resource is a ECMAScript 6 that is run by the EDK (Extensibility Developement Kit) on an EDK based adapter in order to perform the aftermarket extension processing.

Note:

How find out the resource owner and classifier to be used in ProcessingInformation REST URL.

The type/resource for which the ProcessingInformation to be uploaded is already known, for example 'ShoppingCartOracle'.

Perform GET ALL call on schema service with the sample URL as 'apiManagement/jsonSchemas'. Find the type/resource name in the above REST response and get to know its schema location. For example in the REST response, href for 'ShoppingCartOracle' is https:///apiManagement/jsonSchemas/oracle/buying/ShoppingCartOracle.schema.json where '/oracle/buying/' is the schema location. The resource owner and classifier are 'oracle' and 'buying' respectively.

The ProcessingInformation can be formed using the schema location obtained above. The example ProcessingInformation URL is 'apiManagement/processingInformation/{adapter-id}/customerManagement/{api-version}/schemas/oracle/buying/ShoppingCartOracle'

Enabled the additional ProcessingInformation validation through Adapter Capabilities Management.

We have enabled the additional validation based on Adapter Capabilities Management during the ProcessingInformation upload.

ProcessingInformation is only allowed to be uploaded if the corresponding adapter supports such capability.

Any existing ProcessingInformations those are not allowed to be updated (due to adapter supported capabilities or incase it was uploaded with wrong schema location in the URL ) should be deleted first. Then correct the ProcessingInformation URL and re-upload.

The ProcessingInformation written and uploaded by the Tenant should not contain and process any sort of sensitive/confidential information. The ProcessingInformation can contain the business logic in the form of ECMA script but should not contain any PII data.

Refer the details of the REST API user role required to generate the OAuth token for respective services and their HTTP operations, provided in the Access Roles for Resources topic. Example if you want to generate the OAuth token for 'Generation Rules' service and for POST operation, you would use 'EXTENSION_RULES_CREATE' as a user role.

Create processing information

Method: post

Path: /apiManagement/processingInformation/{adapter-id}/{api-name}/{api-version}/schemas/{resource-owner}/{classifier}/{id}

Delete a processing information

Method: delete

Path: /apiManagement/processingInformation/{adapter-id}/{api-name}/{api-version}/schemas/{resource-owner}/{classifier}/{id}

Get a processing information

Method: get

Path: /apiManagement/processingInformation/{adapter-id}/{api-name}/{api-version}/schemas/{resource-owner}/{classifier}/{id}

Get all processing information

Method: get

Path: /apiManagement/processingInformation/{adapter-id}/{api-name}/{api-version}/schemas/{resource-owner}/{classifier}/

Replace a processing information

Method: put

Path: /apiManagement/processingInformation/{adapter-id}/{api-name}/{api-version}/schemas/{resource-owner}/{classifier}/{id}