API Reference > Manage requests, orders and consumer accesses > Orders
  

Orders

An order is a request made by a Data User to gain access to a data collection. A Data User's order is reviewed by the stakeholders of the data collection who are responsible for the approval and fulfillment of the order.

Retrieve orders

Use REST APIs to retrieve the details of orders in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/orders/
Method
GET
Note: Before you call this API, consider the following:
For more information, see How to call a Data Marketplace API.

Request

The following table describes the parameters that you enter in the request query:
Parameter
Description
Additional Information
orderIds
Optional. Enter the system generated unique identifier of an order.
To get the system generated unique identifier of a order, open the order. The order page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/order/3d48daf6-5e75-4e1a-848c-b6821fc33f74?dtn=Order~579b, the system generated unique identifier is 3d48daf6-5e75-4e1a-848c-b6821fc33f74.
To enter more than one value, use the following format:
ids=<value1>&ids=<value2>
dataCollectionIds
Optional. Enter the system generated unique identifier of the ordered data collection.
For more information about how you can use an API to get the system generated unique identifier of a data collection, see Retrieve data collections.
To get the system generated unique identifier of a data collection from the Data Marketplace interface, open the data collection. The data collection page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/datacollection/25158afc-3dfb-44ef-8f3e-cec1e171d0f1?dtn=&tab=summary, the system generated unique identifier is 25158afc-3dfb-44ef-8f3e-cec1e171d0f1.
ordersCreatedBy
Optional. Enter the system generated unique identifier of the user accounts of the Data Users that placed the order.
To get the system generated unique identifier of a user account, navigate to My Services > Administrator > Users. On the Users page, click a user account. The user account page's URL contains the system generated unique identifier.
For example, in the URL /cloudUI/products/administer/main/usersAsset/0LH3xBJC9A6haZ26htGZyT, the system generated unique identifier is 0LH3xBJC9A6haZ26htGZyT.
collectionDataOwners
Optional. Enter the system generated unique identifier of the user accounts of the stakeholders that are assigned the Data Owner stakeholder role on the data collection.
To get the system generated system generated unique identifier of a user account, navigate to My Services > Administrator > Users. On the Users page, click a user account. The user account page's URL contains the system generated unique identifier.
For example, in the URL /cloudUI/products/administer/main/usersAsset/0LH3xBJC9A6haZ26htGZyT, the system generated unique identifier is 0LH3xBJC9A6haZ26htGZyT.
collectionTechOwners
Optional. Enter the system generated unique identifier of the user accounts of the stakeholders that are assigned the Technical Owner stakeholder role on the data collection.
To get the system generated unique identifier of a user account, navigate to My Services > Administrator > Users. On the Users page, click a user account. The user account page's URL contains the system generated unique identifier.
For example, in the URL /cloudUI/products/administer/main/usersAsset/0LH3xBJC9A6haZ26htGZyT, the system generated unique identifier is 0LH3xBJC9A6haZ26htGZyT.
status
Optional. Specify the status of the order.
Enter one of the following values:
  • - To find the orders that are approved for fulfillment, enter APPROVED.
  • - To find rejected orders, enter REJECTED.
  • - To find fulfilled orders, enter COMPLETE.
  • - To find cancelled orders, enter CANCELLED.
categoryIds
Optional. Enter the system generated unique identifier of the category that contains the ordered data collection.
For more information about how you can use an API to get the system generated unique identifier of a category, see Retrieve categories.
To get the system generated unique identifier of a category from the Data Marketplace interface, open the category. The category page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/category/view?ac=67417f72-e5ab-44f0-add9-a1e412c1ce13&dtn=_AfterEBF%20may20, the system generated unique identifier is 67417f72-e5ab-44f0-add9-a1e412c1ce13.
categoryOwners
Optional. System generated unique identifier of the owners of the category that contains the ordered data collection.
To get the system generated unique identifier of a user account, navigate to My Services > Administrator > Users. On the Users page, click a user account. The user account page's URL contains the system generated unique identifier.
For example, in the URL /cloudUI/products/administer/main/usersAsset/0LH3xBJC9A6haZ26htGZyT, the system generated unique identifier is 0LH3xBJC9A6haZ26htGZyT.
createdDateFrom
Optional. To find orders that were created between a date range, enter the initial date when the orders were created.
To specify a date, use the YYYY-MM-DD format. The value that you specify is automatically converted and stored in the Coordinated Universal Time (UTC) time standard.
If you have specified a value for the createdDateFrom parameter, ensure that you also enter a value for the createdDateTo parameter.
createdDateTo
Optional. To find orders that were created between a date range, enter the latest date when the orders were created.
To specify a date, use the YYYY-MM-DD format. The value that you specify is automatically converted and stored in the Coordinated Universal Time (UTC) time standard.
If you have specified a value for the createdDateTo parameter, ensure that you also enter a value for the createdDateFrom parameter.
modifiedDateFrom
Optional. To find orders that were modified between a date range, enter the initial date when the orders were modified.
To specify a date, use the YYYY-MM-DD format. The value that you specify is automatically converted and stored in the Coordinated Universal Time (UTC) time standard.
If you have specified a value for the modifiedDateFrom parameter, ensure that you also enter a value for the modifiedDateTo parameter.
modifiedDateTo
Optional. To find orders that were modified between a date range, enter the latest date when the orders were modified.
To specify a date, use the YYYY-MM-DD format. The value that you specify is automatically converted and stored in the Coordinated Universal Time (UTC) time standard.
If you have specified a value for the modifiedDateTo parameter, ensure that you also enter a value for the modifiedDateFrom parameter.
sortByField
Optional. Specify the parameters to sort the search results.
To sort the search results, enter one of the following values:
  • - ID
  • - STATUS
  • - CREATED_BY
  • - CREATED_ON
  • - MODIFIED_BY
  • - MODIFIED_ON
Default value is MODIFIED_ON.
sort
Optional. Set the sorting order of the search results.
You can sort the search results in the following order:
  • - To sort the search results by ascending order, enter ASC.
  • - To sort the search results by descending order, enter DESC.
Default value is DESC.
offset
Optional. Enter the starting index for the paginated results.
Default value is 0.
limit
Optional. Enter the maximum number of results.
Default value is 50.
Maximum value is 100.
Note: The API has no payload.

Example request

The following example shows how you can use an API to retrieve and display order details :
https://{{CDMP_URL}}/api/v1/integration/orders?status=APPROVED&ordersCreatedBy=User1&sortByField=MODIFIED_BY&sort=ASC

Response

When you pass the API query parameters in the REST client, the client displays a response for the parameter values that you have entered.
The following example shows the response of an API call to retrieve and display order details:
{
"processingTime": 460,
"offset": 0,
"limit": 50,
"totalCount": 2,
"objects": [
{
"justification": "Sales analytics",
"deliveryRequests": null,
"requestedProvisionedTargetRef": null,
"refId": "ORD-374",
"dataCollections": [
{
"id": "908626d6-39fb-4bdd-933d-8e275240c8c3",
"name": "DS",
"description": "DS",
"refId": "DCL-993",
"category": {
"id": "b51f8cc7-fd05-4759-a63b-342268c24e29",
"refId": "CAT-613",
"parentId": null,
"parentRefId": null,
"parent": null,
"name": "Category",
"description": "Category",
"status": "ACTIVE",
"effectiveStatus": "ACTIVE",
"hasChildCategory": false,
"hasActiveChildCategory": false,
"dataOwners": [],
"createdBy": {
"displayName": "Johnny Doe",
"id": "6bX1o0lH3UmbPuF0OF5lkj",
"name": "15Jul_CDMP_QE",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"createdOn": "2022-07-15T19:04:56.151Z",
"modifiedBy": {
"displayName": "Johnny Doe",
"id": "6bX1o0lH3UmbPuF0OF5lkj",
"name": "15Jul_CDMP_QE",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"modifiedOn": "2022-07-15T19:04:56.151Z"
},
"usageContexts": [],
"dataset": [],
"dataCollectionStatus": "PUBLISHED",
"dataOwners": [
{
"displayName": "Jane Doe",
"id": "11bnOFaMvrXc0kal2bPXUX",
"name": "Jane Doe",
"email": "jdoe@informatica.com",
"phone": "8758939746",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
}
],
"technicalOwners": [
{
"displayName": "John Doe",
"id": "aH2O7v8jSgqeZDYHe45NAJ",
"name": "John Doe",
"email": "jdoe@informatica.com",
"phone": "8758939746",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
}
],
"createdBy": {
"displayName": "User1",
"id": "6bX1o0lH3UmbPuF0OF5lkj",
"name": "User1_name",
"email": "ebc@xyz.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"createdOn": "2022-07-15T19:46:46.866Z",
"modifiedBy": {
"displayName": "Johnny Doe",
"id": "6bX1o0lH3UmbPuF0OF5lkj",
"name": "15Jul_CDMP_QE",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"modifiedOn": "2022-07-15T19:46:46.866Z"
}
],
"termsOfUse": [
{
"id": "1b6b2651-bed6-4cc6-bd41-2f1091cc07a1",
"termsOfUseId": null,
"termsOfUseRefId": null,
"generalTermsOfUse": "{"tosMessage":"general terms of use "}",
"name": Accessible,
"description": "This data is accessible to anyone in the organization",
"type": "ACCESSIBLE",
"status": "ENABLED",
"acknowledgement": false,
"parentId": null,
"referenceLink": null,
"createdOn": "2022-07-15T19:07:55.552Z"
}
],
"status": "APPROVED",
"id": "875a5d43-6d91-473c-ac42-eb02cfe059d9",
"usageContext": null,
"createdBy": {
"displayName": "Johnny Doe",
"id": "6bX1o0lH3UmbPuF0OF5lkj",
"name": "15Jul_CDMP_QE",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"userInfo": {},
"isGroup": "true"
},
"createdOn": "2022-07-15T19:47:28.598Z",
"modifiedBy": {
"displayName": "Johnny Doe",
"id": "6bX1o0lH3UmbPuF0OF5lkj",
"name": "15Jul_CDMP_QE",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"userInfo": {},
"isGroup": "true"
},
"modifiedOn": "2022-07-15T19:47:46.143Z"
},
{
"justification": "Standard retail tasks.",
"deliveryRequests": "No specification.",
"requestedProvisionedTargetRef": null,
"refId": "ORD-834",
"dataCollections": [
{
"id": "a290034e-0362-434f-a3cc-7f659e009fae",
"name": "Collection_TSKV1",
"description": "Automation",
"refId": "Collection_TSKV1",
"category": {
"id": "dac80150-bde3-4c8f-9129-9e56893de367",
"refId": "CAT-173",
"parentId": null,
"parentRefId": null,
"parent": null,
"name": "Category_TSKV1",
"description": "Automation",
"status": "ACTIVE",
"effectiveStatus": "ACTIVE",
"hasChildCategory": false,
"hasActiveChildCategory": true,
"dataOwners": [],
"createdBy": {
"displayName": "John Doe",
"id": "f400dUqjPuaiJ9KBrzOhiB",
"name": "John Doe",
"email": "jdoe@informatica.com",
"phone": "00000099999999999",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"createdOn": "2022-07-16T12:06:57.049Z",
"modifiedBy": {
"displayName": "John Doe",
"id": "f400dUqjPuaiJ9KBrzOhiB",
"name": "John Doe",
"email": "jdoe@informatica.com",
"phone": "00000099999999999",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"modifiedOn": "2022-07-16T12:06:57.049Z"
},
"usageContexts": null,
"dataset": null,
"dataCollectionStatus": "PUBLISHED",
"dataOwners": [],
"technicalOwners": [],
"createdBy": {
"displayName": "User1",
"id": "6bX1o0lH3UmbPuF0OF5lkj",
"name": "User1_name",
"email": "ebc@xyz.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"createdOn": "2022-07-16T12:07:04.596Z",
"modifiedBy": {
"displayName": "John Doe",
"id": "f400dUqjPuaiJ9KBrzOhiB",
"name": "John Doe",
"email": "jdoe@informatica.com",
"phone": "00000099999999999",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"modifiedOn": "2022-07-16T12:07:04.596Z"
}
],
"termsOfUse": [
{
"id": "1b6b2651-bed6-4cc6-bd41-2f1091cc07a1",
"termsOfUseId": null,
"termsOfUseRefId": null,
"generalTermsOfUse": "{"tosMessage":"general terms of use "}",
"name": Accessible,
"description": "This data is accessible to anyone in the organization",
"type": "ACCESSIBLE",
"status": "ENABLED",
"acknowledgement": false,
"parentId": null,
"referenceLink": null,
"createdOn": "2022-07-15T19:07:55.552Z"
}
],
"status": "APPROVED",
"id": "338a4dba-54f3-4a4b-b7d2-180c07dee68a",
"usageContext": null,
"costCenter": "ORG001-IQ",
"customFields”: [
{
"name”: "com.infa.odin.models.custom.ca_6713129624402817413",
"value”: "2023-04-19",
"values”: null
},
{
"name”: "com.infa.odin.models.custom.ca_4689891014995490684",
"value”: null,
"values”: ["Ferrari","Koenigsegg","Lamborghini"]
},
{
"name”: "com.infa.odin.models.custom.ca_1100233073247017453",
"value”: "Automobiles",
"values”: null
},
{
"name”: "com.infa.odin.models.custom.ca_6863327120603592729",
"value”: "Luxury Ride Services",
"values”: null
},
{
"name”: "com.infa.odin.models.custom.ca_5660854643729475562",
"value”: "true",
"values”: null
},
{
"name”: "com.infa.odin.models.custom.ca_1844904614209918604",
"value”: "European Manufacturers",
"values”: null
},
{
"name”: "com.infa.odin.models.custom.ca_1590048468319648867",
"value”: "10",
"values”: null
},
{
"name”: "com.infa.odin.models.custom.ca_62634611096284755",
"value”: "12.5",
"values”: null
},
{
"name”: "com.infa.odin.models.custom.ca_5429811987158518158",
"value”: "false",
"values”: null
},
{
"name”: "com.infa.odin.models.custom.ca_6366370263733010093",
"value”: "Cars",
"values”: null
}
],

"createdBy": {
"displayName": "John Doe",
"id": "f400dUqjPuaiJ9KBrzOhiB",
"name": "John Doe",
"email": "jdoe@informatica.com",
"phone": "00000099999999999",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"createdOn": "2022-07-16T12:07:54.597Z",
"modifiedBy": {
"displayName": "John Doe",
"id": "f400dUqjPuaiJ9KBrzOhiB",
"name": "John Doe",
"email": "jdoe@informatica.com",
"phone": "00000099999999999",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"modifiedOn": "2022-07-16T12:08:03.463Z"
}
]
}
The following table describes the parameters of each order that is retrieved:
Parameter
Description
offset
Starting index for the paginated results.
limit
Maximum number of results.
totalCount
Number of orders retrieved.
justification
The reason for the requirement of access to the data provided by the Data User at the time of order.
deliveryRequests
Delivery information of the order.
requestedProvisionedTargetRef
The delivery target requested by the Data User.
Note: If the value of the requestedProvisionedTargetRef parameter is null, the order is created without a specific delivery target but rather uses the default delivery template.
For more information about how you can retrieve the details of the default delivery template, see Retrieve delivery templates.
refId
Reference identifier of the order.
createdBy
Details of the user account that created the order.
createdOn
Date when the order was created.
modifiedBy
Details of the latest user account that modified the order.
modifiedOn
Date when the order was modified.
dataCollections > id
System generated unique identifier of the ordered data collection.
dataCollections > name
Name of the ordered data collection.
dataCollections > description
Purpose of the ordered data collection.
dataCollections > refId
Reference identifier of the ordered data collection.
dataCollections > category
Details of the category that contains the ordered data collection.
dataCollections > usageContexts
Details of the usage type that is used to specify the certified use of the ordered data collection.
dataCollections > dataCollectionStatus
The status indicates whether the data collection is discoverable by Data Users when they search for it. A data collection can have one of the following statuses:
  • - PUBLISHED. The data collection is discoverable to Data Users.
  • - UNPUBLISHED. The data collection isn't discoverable to Data Users.
dataCollections > dataOwners
Details of the stakeholders that are assigned the Data Owner stakeholder role on the data collection.
dataCollections > technicalOwners
Details of the stakeholders that are assigned the Technical Owner stakeholder role on the data collection.
dataCollections > createdBy
Details of the user account that created the ordered collection.
dataCollections > createdOn
Date when the ordered collection was created.
dataCollections > modifiedBy
Details of the latest user account that modified the ordered collection.
dataCollections > modifiedOn
Latest date when the ordered data collection was modified.
termsOfUse
Details of the terms of use that apply to the ordered data collection.
termsOfUse > id
System generated unique identifier of the terms of use snapshot. The terms of use snapshot represents the state of the terms of use of the data collection when the order was placed.
termsOfUse > termsOfUseId
System generated unique identifier of the terms of use that apply to the ordered data collection.
termsOfUse > termsOfUseRefId
Reference identifier of the terms of use that apply to the ordered data collection.
termsOfUse > generalTermsOfUse
Details of the general terms of use that apply to the ordered data collection.
termsOfUse > name
Name of the terms of use that apply to the ordered data collection.
termsOfUse > description
Description of the terms of use that apply to the ordered data collection.
termsOfUse > type
Type of the terms of use that apply to the ordered data collection. A terms of use can have one of the following types:
  • - ACCESSIBLE
  • - CONTROLLED
  • - RESTRICTED
termsOfUse > status
The status indicates whether the terms of use are available to be added to data collections. A terms of use can have one of the following statuses:
  • - ENABLED. The terms of use are available to be added to data collections.
  • - DISABLED. The terms of use isn't available to be added to data collections.
termsOfUse > acknowledgement
This parameter indicates whether the Data User is required to acknowledge the terms of use when they place an order. The parameter can be one of the following values:
  • - true. The Data User must acknowledge the terms of use when they place an order.
  • - false. The Data User doesn't need to acknowledge the terms of use when they place an order.
termsOfUse > referenceLink
Uniform resource identifier of the terms of use.
termsOfUse > createdOn
Date when the terms of use that apply to the ordered data collection were created.
status
Status of the order. An order can have one of the following statuses:
  • - APPROVED. The order is approved for fulfillment. A stakeholder of the ordered data collection must deliver the data to the Data User.
  • - REJECTED. The order was rejected by a stakeholder of the ordered data collection.
  • - COMPLETE. The ordered data was delivered to the Data User.
  • - CANCELLED. The order was cancelled.
id
System generated unique identifier of the order.
usageContext
Details of the usage context that the Data User selected at the time of order.
costCenter
Cost center of the Data User that placed the order.
customFields
The values entered in the custom fields specified by the Data User at the time of order.
Custom fields are additional properties for Data Marketplace objects that are defined by your Administrator in Metadata Command Center.
For more information about custom fields, see the Create custom fields for objects topic in the Set Up Data Marketplace help.
customFields > name
System generated unique identifier of the custom field.
For more information about how you can retrieve the custom field name as it appears on the Data Marketplace interface, see Retrieve custom fields.
customFields > value
The custom field value. This parameter can have only a single value.
customFields > values
The custom field value. This parameter can have multiple values.

Approve orders

Use REST APIs to approve orders in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/orders/<orderId>/approve
<orderId>: Required. Enter the system generated unique identifier of the order that you want to approve.
For more information about how you can use an API to get the system generated unique identifier of a order, see Retrieve orders.
To get the system generated unique identifier of a order from the Data Marketplace interface, open the order. The order page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/order/3d48daf6-5e75-4e1a-848c-b6821fc33f74?dtn=Order~579b, the system generated unique identifier is 3d48daf6-5e75-4e1a-848c-b6821fc33f74.
Method
PUT
Note: You can call a maximum of 100 APIs per minute.

Request

The following table describes the parameters that you enter in the request query:
Parameter
Description
Additional Information
comment
Optional. Enter a comment about the action taken.
-
costCenter
Optional. Enter a cost center value.
You can use this parameter to modify the cost center that the Data User entered at the time of order.
The following table describes the parameters that you enter in the body of the API payload:
Parameter
Description
Additional Information
customFields
The values entered in the custom fields, as specified by the Data User at the time of order.
You can use this parameter to modify the additional information that the Data User entered at the time of order.
Whether you must enter a value or not enter a value in a custom field is determined by how the custom field was defined by your Administrator in Metadata Command Center.
Custom fields are additional properties for Data Marketplace objects that are defined by your Administrator in Metadata Command Center. For more information about custom fields, see the Create custom attributes for objects topic in the Set Up Data Marketplace help.
customFields > name
The system generated unique identifier of the custom field that is present in the order checkout form.
For more information about how you can retrieve the system generated unique identifier of a custom field, see Retrieve custom fields.
customFields > value
The custom field value.
This parameter can have only a single value.
customFields > values
The custom field value.
This parameter can have multiple values.

Example request

The following example shows how you can use an API to approve an order:
Request query
https://{{CDMP_URL}}/api/v1/integration/orders/16e32a13-6fba-4f1a-a337-e0aeecf9fab4/approve
Request body

{
"customFields": [
{
"name": "com.infa.odin.models.custom.ca_6713129624402817413",
"value": "2023-04-19"
},
{
"name": "com.infa.odin.models.custom.ca_1590048468319648867",
"value": 10
},
{
"name": "com.infa.odin.models.custom.ca_5660854643729475562",
"value": true
},
{
"name": "com.infa.odin.models.custom.ca_62634611096284755",
"value": 12.5
},
{
"name": "com.infa.odin.models.custom.ca_4689891014995490684",
"values": ["Ferrari","Koenigsegg","Lamborghini"]
},
{
"name": "com.infa.odin.models.custom.ca_5429811987158518158",
"value": false

},
{
"name": "com.infa.odin.models.custom.ca_1100233073247017453",
"value": "Automobiles"

},
{
"name": "com.infa.odin.models.custom.ca_1844904614209918604",
"value": "European Manufacturers"

},
{
"name": "com.infa.odin.models.custom.ca_6863327120603592729",
"value": "Luxury Ride Services"

}

]
}

Response

When you pass the API query parameters in the REST client, the client displays a response for the parameter values that you have entered.
The following example shows the response of an API call to approve an order:
{
"justification": "Justification",
"deliveryRequests": "This order is to be approved from CAI",
"requestedProvisionedTargetRef": “d02e28ea-6686-4954-85c7-d60c33e4e9c5”,
"refId": "ORD-693",
"status": "APPROVED",
"id": "16e32a13-6fba-4f1a-a337-e0aeecf9fab4",
"createdBy": {
"displayName": "User1",
"id": "6bX1o0lH3UmbPuF0OF5lkj",
"name": "User1_name",
"email": "ebc@xyz.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"createdOn": "2022-07-21T17: 17: 16.901Z",
"modifiedBy": {
"displayName": "User1",
"id": "6bX1o0lH3UmbPuF0OF5lkj",
"name": "User1_name",
"email": "ebc@xyz.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"modifiedOn": "2022-07-22T07: 47: 23.384Z",
"costCenter": "ORG001-IQ"
}

The following table describes the parameters of each order that is approved:
Parameter
Description
justification
Business justification of the action taken on the order.
deliveryRequests
Delivery information of the order.
requestedProvisionedTargetRef
The delivery target requested by the Data User.
Note: If the value of the requestedProvisionedTargetRef parameter is null, the order is created without a specific delivery target but rather uses the default delivery template.
For more information about how you can retrieve the details of the default delivery template, see Retrieve delivery templates.
refId
Reference identifier of the order.
status
Status of the order. An order can have one of the following statuses:
  • - APPROVED. The order is approved for fulfillment. A stakeholder of the ordered data collection must deliver the data to the Data User.
  • - REJECTED. The order was rejected by a stakeholder of the ordered data collection.
  • - COMPLETE. The ordered data was delivered to the Data User.
  • - CANCELLED. The order was cancelled.
id
System generated unique identifier of the order.
createdBy > displayName
Name of the user that placed the order.
createdBy > id
Reference identifier of the order creator's user account.
createdBy > name
Username of the user that placed the order.
createdBy > email
Email address of the user that placed the order.
createdBy > phone
Contact number of the user that placed the order.
createdBy > status
The status indicates whether or not a user account or user group is active. A user account or user group can have one of the following statuses:
  • - ACTIVE. The user account or user group is active.
  • - INACTIVE. The user account or user group is not active.
createdBy > userInfo
Details retrieved from the My Data page of the user account that placed the order.
createdBy > isGroup
This parameter indicates whether the user account is part of a group. This parameter can have one of the following values:
  • - true. The user account is part of a group
  • - false. The user account isn't part of a group
createdOn
Date when the order was placed.
modifiedBy > displayName
Name of the last user that modified the order.
modifiedBy > id
Reference identifier of the user account of the last user that modified the order.
modifiedBy > name
Username of the last user that modified the order.
modifiedBy > email
Email address of the last user that modified the order.
modifiedBy > phone
Contact number of the last user that modified the order.
modifiedBy > status
The status indicates whether or not a user account or user group is active. A user account or user group can have one of the following statuses:
  • - ACTIVE. The user account or user group is active.
  • - INACTIVE. The user account or user group is not active.
modifiedBy > userInfo
Details retrieved from the My Data page of the user account that last modified the order.
modifiedBy > isGroup
This parameter indicates whether the user account is part of a group. This parameter can have one of the following values:
  • - true. The user account is part of a group
  • - false. The user account isn't part of a group
modifiedOn
Latest date when the order was modified.
costCenter
The cost center of the Data User that placed the order.

Reject orders

Use REST APIs to reject orders in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/orders/<orderId>/reject
<orderId>: Required. Enter the system generated unique identifier of the order that you want to reject.
For more information about how you can use an API to get the system generated unique identifier of a order, see Retrieve orders.
To get the system generated unique identifier of a order from the Data Marketplace interface, open the order. The order page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/order/3d48daf6-5e75-4e1a-848c-b6821fc33f74?dtn=Order~579b, the system generated unique identifier is 3d48daf6-5e75-4e1a-848c-b6821fc33f74.
Method
PUT
Note: You can call a maximum of 100 APIs per minute.

Request

The following table describes the parameters that you enter in the request query:
Parameter
Description
comment
Optional. Enter a comment about the action taken.
Note: The API has no payload.

Example request

The following example shows how you can use an API to reject an order:
https://{{CDMP_URL}}/api/v1/integration/orders/16e32a13-6fba-4f1a-a337-e0aeecf9fab4/reject

Response

When you pass the API query parameters in the REST client, the client displays a response for the parameter values that you have entered.
The following example shows the response of an API call to reject an order:
{
"justification": "Justification",
"deliveryRequests": "This order is to be cancelled from CAI",
"requestedProvisionedTargetRef": “d02e28ea-6686-4954-85c7-d60c33e4e9c5”,
"refId": "ORD-693",
"status": "CANCELLED",
"id": "ORD-693",
"createdBy": {
"displayName": "User1",
"id": "6bX1o0lH3UmbPuF0OF5lkj",
"name": "User1_name",
"email": "ebc@xyz.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"createdOn": "2022-07-21T17: 17: 16.901Z",
"modifiedBy": {
"displayName": "User1",
"id": "6bX1o0lH3UmbPuF0OF5lkj",
"name": "User1_name",
"email": "ebc@xyz.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"modifiedOn": "2022-07-22T07: 47: 23.384Z"
}

The following table describes the parameters of each order that is rejected:
Parameter
Description
justification
Business justification of the action taken on the order.
deliveryRequests
Delivery information of the order.
requestedProvisionedTargetRef
The delivery target requested by the Data User.
Note: If the value of the requestedProvisionedTargetRef parameter is null, the order is created without a specific delivery target but rather uses the default delivery template.
For more information about how you can retrieve the details of the default delivery template, see Retrieve delivery templates.
refId
Reference identifier of the order.
status
Status of the order. An order can have one of the following statuses:
  • - APPROVED. The order is approved for fulfillment. A stakeholder of the ordered data collection must deliver the data to the Data User.
  • - REJECTED. The order was rejected by a stakeholder of the ordered data collection.
  • - COMPLETE. The ordered data was delivered to the Data User.
  • - CANCELLED. The order was cancelled.
id
System generated unique identifier of the order.
createdBy > displayName
Name of the user that placed the order.
createdBy > id
Reference identifier of the order creator's user account.
createdBy > name
Username of the user that placed the order.
createdBy > email
Email address of the user that placed the order.
createdBy > phone
Contact number of the user that placed the order.
createdBy > status
The status indicates whether or not a user account or user group is active. A user account or user group can have one of the following statuses:
  • - ACTIVE. The user account or user group is active.
  • - INACTIVE. The user account or user group is not active.
createdBy > userInfo
Details retrieved from the My Data page of the user account that placed the order.
createdBy > isGroup
This parameter indicates whether the user account is part of a group. This parameter can have one of the following values:
  • - true. The user account is part of a group
  • - false. The user account isn't part of a group
createdOn
Date when the order was placed.
modifiedBy > displayName
Name of the last user that modified the order.
modifiedBy > id
Reference identifier of the user account of the last user that modified the order.
modifiedBy > name
Username of the last user that modified the order.
modifiedBy > email
Email address of the last user that modified the order.
modifiedBy > phone
Contact number of the last user that modified the order.
modifiedBy > status
The status indicates whether or not a user account or user group is active. A user account or user group can have one of the following statuses:
  • - ACTIVE. The user account or user group is active.
  • - INACTIVE. The user account or user group is not active.
modifiedBy > userInfo
Details retrieved from the My Data page of the user account that last modified the order.
modifiedBy > isGroup
This parameter indicates whether the user account is part of a group. This parameter can have one of the following values:
  • - true. The user account is part of a group
  • - false. The user account isn't part of a group
modifiedOn
Latest date when the order was modified.

Fulfill orders

Use REST APIs to fulfill orders in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/orders/<orderId>/fulfill
<orderId>: Required. Enter the system generated unique identifier of the order that you want to fulfill.
For more information about how you can use an API to get the system generated unique identifier of a order, see Retrieve orders.
To get the system generated unique identifier of a order from the Data Marketplace interface, open the order. The order page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/order/3d48daf6-5e75-4e1a-848c-b6821fc33f74?dtn=Order~579b, the system generated unique identifier is 3d48daf6-5e75-4e1a-848c-b6821fc33f74.
Method
PUT
Note: You can call a maximum of 100 APIs per minute.

Request

The following table describes the parameters that you enter in the request query:
Parameter
Description
Additional Information
deliveryTargetId
Required. Enter the system generated unique identifier of the delivery target that you want to use to deliver the data.
For more information about how you can use an API to get the unique identifier of a delivery target, see Retrieve delivery targets.
comment
Optional. Enter a comment about the action taken.
-
costCenter
Optional. Enter a cost center value.
You can use this parameter to modify the cost center that the Data User entered at the time of order.
The following table describes the parameters that you enter in the body of the API payload:
Parameter
Description
Additional Information
customFields
The values entered in the custom fields as specified by the Data User at the time of order.
You can use this parameter to modify the additional information that the Data User entered at the time of order.
Whether you must enter a value or not enter a value in a custom field is determined by how the custom field was defined by your Administrator in Metadata Command Center.
Custom fields are additional properties for Data Marketplace objects that are defined by your Administrator in Metadata Command Center. For more information about custom fields, see the Create custom attributes for objects topic in the Set Up Data Marketplace help.
customFields > name
The system generated unique identifier of the custom field that is present in the order checkout form.
For more information about how you can retrieve the system generated unique identifier of a custom field, see Retrieve custom fields.
customFields > value
The custom field value.
This parameter can have only a single value.
customFields > values
The custom field value.
This parameter can have multiple values.

Example request

The following example shows how you can use an API to fulfill an order:
Request query
https://{{CDMP_URL}}/api/v1/integration/orders/16e32a13-6fba-4f1a-a337-e0aeecf9fab4/fulfill?deliveryTargetId=16e32a13-6fba-4f1a-a337-e0aeecf9fab4
Request body

{
"customFields": [
{
"name": "com.infa.odin.models.custom.ca_6713129624402817413",
"value": "2023-04-19"
},
{
"name": "com.infa.odin.models.custom.ca_1590048468319648867",
"value": 10
},
{
"name": "com.infa.odin.models.custom.ca_5660854643729475562",
"value": true
},
{
"name": "com.infa.odin.models.custom.ca_62634611096284755",
"value": 12.5
},
{
"name": "com.infa.odin.models.custom.ca_4689891014995490684",
"values": ["Ferrari","Koenigsegg","Lamborghini"]
},
{
"name": "com.infa.odin.models.custom.ca_5429811987158518158",
"value": false
},
{
"name": "com.infa.odin.models.custom.ca_1100233073247017453",
"value": "Automobiles"
},
{
"name": "com.infa.odin.models.custom.ca_1844904614209918604",
"value": "European Manufacturers"
},
{
"name": "com.infa.odin.models.custom.ca_6863327120603592729",
"value": "Luxury Ride Services"
}
]
}

Response

When you pass the API query parameters in the REST client, the client displays a response for the parameter values that you have entered.
The following example shows the response of an API call to fulfill an order:
{
"Result": {
"id": "8002f8f4-99ae-4389-8588-45442fe49969",
"refId": "ACC-756",
"status": "AVAILABLE",
"accessGrantedOn": "2022-07-22T08:37:41.415Z",
"order": {
"justification": "Sales analytics",
"deliveryRequests": "This order is to be fulfilled from CAI",
"requestedProvisionedTargetRef": "d02e28ea-6686-4954-85c7-d60c33e4e9c5",
"refId": "ORD-693",
"dataCollections": [
{
"id": "e40b023f-4064-4974-9705-4d510bd14b26",
"name": "Collection - Order",
"description": "Collection to place order on",
"refId": "DCL-341",
"category": {
"id": "e979b800-91ec-4e2d-8271-53e289935d78",
"refId": "CAT-736",
"parentId": null,
"parentRefId": null,
"parent": null,
"name": "Category with collections under it",
"description": " Category with collections under it ",
"status": "ACTIVE",
"effectiveStatus": "ACTIVE",
"hasChildCategory": false,
"hasActiveChildCategory": false,
"dataOwners": [],
"createdBy": {
"displayName": "John Doe",
"id": "f400dUqjPuaiJ9KBrzOhiB",
"name": "John Doe",
"email": "jdoe@informatica.com",
"phone": "00000099999999999",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"createdOn": "2022-07-18T11:05:08.794Z",
"modifiedBy": {
"displayName": "John Doe",
"id": "f400dUqjPuaiJ9KBrzOhiB",
"name": "John Doe",
"email": "jdoe@informatica.com",
"phone": "00000099999999999",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"modifiedOn": "2022-07-18T11:05:08.794Z"
},
"usageContexts": [],
"dataset": [],
"dataCollectionStatus": "PUBLISHED",
"dataOwners": [],
"technicalOwners": [],
"createdBy": {
"displayName": "John Doe",
"id": "f400dUqjPuaiJ9KBrzOhiB",
"name": "John Doe",
"email": "jdoe@informatica.com",
"phone": "00000099999999999",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"createdOn": "2022-07-18T11:05:12.935Z",
"modifiedBy": {
"displayName": "John Doe",
"id": "f400dUqjPuaiJ9KBrzOhiB",
"name": "John Doe",
"email": "jdoe@informatica.com",
"phone": "00000099999999999",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"modifiedOn": "2022-07-18T11:05:12.935Z"
}
],
"termsOfUseSnapshots": [],
"status": "COMPLETE",
"inheritedGroupIds": [],
"id": "0a7341db-b5b2-4673-a5fe-c7b731d1bd5c",
"usageContext": {},
"createdBy": {
"displayName": "Johnny Doe",
"id": "6bX1o0lH3UmbPuF0OF5lkj",
"name": "15Jul_CDMP_QE",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
},
"createdOn": "2022-07-22T08:34:30.288Z",
"modifiedBy": {
"displayName": "Johnny Doe",
"id": "6bX1o0lH3UmbPuF0OF5lkj",
"name": "15Jul_CDMP_QE",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE"
"userInfo": {},
"isGroup": "true"
},
"modifiedOn": "2022-07-22T08:37:46.974Z",
"costCenter": "ORG001-IQ"
},
"deliveryTarget": {
"id": "d02e28ea-6686-4954-85c7-d60c33e4e9c5",
"name": "XLSX over IPFS",
"description": "An excel workbook sent over IPFS.",
"isDefault": false,
"status": "ACTIVE",
"physicalLocation": "AK",
"targetSystemReference": "AK",
"deliveryTemplate": {
"id": "9bf52d89-7ade-479b-ad88-d657064e6301",
"name": "XLSX over IPFS",
"description": "An excel workbook sent over IPFS.",
"isDefault": false,
"status": "ACTIVE",
"managedAccess": "DISABLED",
"deliveryType": "MANUAL",
"templateOwners": [],
"targetSystemReference": "AK",
"defaultPhysicalLocation": "AK",
"deliveryMethods": null,
"deliveryFormats": null,
"createdBy": "6bX1o0lH3UmbPuF0OF5lkj",
"createdOn": "2022-07-19T12:40:50.855Z",
"modifiedBy": "6bX1o0lH3UmbPuF0OF5lkj",
"modifiedOn": "2022-07-19T17:42:55.341Z"
},
"deliveryMethod": {
"id": "f8b34c4f-bd69-4dd6-9d41-221075444abf",
"name": "AK",
"status": "ACTIVE",
"createdBy": "6bX1o0lH3UmbPuF0OF5lkj",
"createdOn": "2022-07-19T12:40:24.123Z",
"modifiedBy": "6bX1o0lH3UmbPuF0OF5lkj",
"modifiedOn": "2022-07-19T12:40:31.332Z"
},
"deliveryFormat": {
"id": "c6fbbaa4-68f4-4005-a1fb-80bb34ec3707",
"name": "AK",
"status": "ACTIVE",
"createdBy": "6bX1o0lH3UmbPuF0OF5lkj",
"createdOn": "2022-07-19T12:39:44.926Z",
"modifiedBy": "6bX1o0lH3UmbPuF0OF5lkj",
"modifiedOn": "2022-07-19T12:39:52.834Z"
},
"dataCollection": {
"id": "e40b023f-4064-4974-9705-4d510bd14b26",
"name": "123456789021658142310877",
"description": "CollectionDescSkearch221658142310875",
"refId": "DCL-341",
"category": {},
"usageContexts": [],
"dataset": [],
"dataCollectionStatus": "PUBLISHED",
"dataOwners": [],
"technicalOwners": [],
"createdBy": {
"displayName": "John Doe",
"id": "f400dUqjPuaiJ9KBrzOhiB",
"name": "John Doe",
"email": "jdoe@informatica.com",
"phone": "00000099999999999",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"createdOn": "2022-07-18T11:05:12.935Z",
"modifiedBy": {
"displayName": "John Doe",
"id": "f400dUqjPuaiJ9KBrzOhiB",
"name": "John Doe",
"email": "jdoe@informatica.com",
"phone": "00000099999999999",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"modifiedOn": "2022-07-18T11:05:12.935Z"
},
"createdBy": "6bX1o0lH3UmbPuF0OF5lkj",
"createdOn": "2022-07-22T08:34:08.916Z",
"modifiedBy": "6bX1o0lH3UmbPuF0OF5lkj",
"modifiedOn": "2022-07-22T08:34:08.916Z"
},
"dataCollection": {
"id": "e40b023f-4064-4974-9705-4d510bd14b26",
"name": "123456789021658142310877",
"description": "CollectionDescSkearch221658142310875",
"refId": "DCL-341",
"category": {
"id": "e979b800-91ec-4e2d-8271-53e289935d78",
"refId": "CAT-736",
"parentId": null,
"parentRefId": null,
"parent": null,
"name": "CategorySkearchName221658142307670",
"description": "CategorySkearchDesc221658142307671",
"status": "ACTIVE",
"effectiveStatus": "ACTIVE",
"hasChildCategory": false,
"hasActiveChildCategory": false,
"dataOwners": [],
"createdBy": {
"displayName": "John Doe",
"id": "f400dUqjPuaiJ9KBrzOhiB",
"name": "John Doe",
"email": "jdoe@informatica.com",
"phone": "00000099999999999",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"createdOn": "2022-07-18T11:05:08.794Z",
"modifiedBy": {
"displayName": "John Doe",
"id": "f400dUqjPuaiJ9KBrzOhiB",
"name": "John Doe",
"email": "jdoe@informatica.com",
"phone": "00000099999999999",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"modifiedOn": "2022-07-18T11:05:08.794Z"
},
"usageContexts": [],
"dataset": [],
"dataCollectionStatus": "PUBLISHED",
"dataOwners": [],
"technicalOwners": [],
"createdBy": {
"displayName": "John Doe",
"id": "f400dUqjPuaiJ9KBrzOhiB",
"name": "John Doe",
"email": "jdoe@informatica.com",
"phone": "00000099999999999",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"createdOn": "2022-07-18T11:05:12.935Z",
"modifiedBy": {
"displayName": "John Doe",
"id": "f400dUqjPuaiJ9KBrzOhiB",
"name": "John Doe",
"email": "jdoe@informatica.com",
"phone": "00000099999999999",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"modifiedOn": "2022-07-18T11:05:12.935Z"
},
"termsOfUseSnapshots": [
{
"id": "26c594c2-4b78-4e6b-b171-22364b4eadc8",
"termsOfUseId": null,
"termsOfUseRefId": null,
"generalTermsOfUse": "{"tosMessage\":"General TOU Order Submission"}",
"name": Accessible,
"description": "This data is available to everyone in the organization",
"type": "ACCESSIBLE",
"status": "ENABLED",
"acknowledgement": false,
"parentId": null,
"referenceLink": null,
"createdOn": "2022-07-21T14:44:05.962Z"
}
],
"consumer": {
"displayName": "Johnny Doe",
"id": "6bX1o0lH3UmbPuF0OF5lkj",
"name": "15Jul_CDMP_QE",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"usageContext": {
"id": "7dead27e-9d00-4a05-b286-70bef9c91402",
"name": "uc",
"description": null,
"status": "ACTIVE"
},
"createdBy": {
"displayName": "User1",
"id": "6bX1o0lH3UmbPuF0OF5lkj",
"name": "User1_name",
"email": "ebc@xyz.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"createdOn": "2022-07-22T08:37:41.764Z",
"modifiedBy": {
"displayName": "User1",
"id": "6bX1o0lH3UmbPuF0OF5lkj",
"name": "User1_name",
"email": "ebc@xyz.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": "true"
},
"modifiedOn": "2022-07-22T08:37:41.764Z"
}
}

The following table describes the parameters of each order that is fulfilled:
Parameter
Description
id
System generated unique identifier of the consumer access that is created after the order is fulfilled.
refId
Referenced identifier of the consumer access that is created after the order is fulfilled.
status
Status of the consumer access that is created after the order is fulfilled.
A consumer access can have the following statuses:
  • - AVAILABLE. The Data User has access to the data collection.
  • - PENDING_WITHDRAW. A request is submitted to withdraw the Data User's access to the data collection.
  • - WITHDRAWN. The Data User's access to the data collection is withdrawn.
Note: For a consumer access that is created after an order is fulfilled, the status is always AVAILABLE.
accessGrantedOn
Date when the order was fulfilled.
order > justification
The reason for the requirement of access to the data provided by the Data User at the time of order.
order > deliveryRequests
Delivery information of the order.
order > requestedProvisionedTargetRef
The delivery target requested by the Data User.
Note: If the value of the requestedProvisionedTargetRef parameter is null, the order is created without a specific delivery target but rather uses the default delivery template.
For more information about how you can retrieve the details of the default delivery template, see Retrieve delivery templates.
order > termsOfUseSnapshots
Details of the terms of use snapshot represents the state of the terms of use of the data collection when the order was placed.
order > status
Status of the order. An order can have one of the following statuses:
  • - APPROVED. The order is approved for fulfillment. A stakeholder of the ordered data collection must deliver the data to the Data User.
  • - REJECTED. The order was rejected by a stakeholder of the ordered data collection.
  • - COMPLETE. The ordered data was delivered to the Data User.
  • - CANCELLED. The order was cancelled.
order > inheritedGroupIds
System generated unique identifier of the stakeholders of the ordered data collection.
order > id
System generated unique identifier of the order.
order > usageContext
Details of the usage context that the Data User selected at the time of order.
order > createdBy
Details of the user account that created the order.
order > createdOn
Date when the order was created.
order > modifiedBy
Details of the latest user account that modified the order.
order > modifiedOn
Date when the order was modified.
order > refId
Reference identifier of the order.
order > dataCollections > id
System generated unique identifier of the data collection.
order > dataCollections > name
Name of the data collection.
order > dataCollections > description
Purpose of the data collection.
order > dataCollections > refId
Reference identifier of the data collection.
order > dataCollections > category
Details of the category of the data collection.
order > dataCollections > usageContexts
Details of the usage type that is used to specify the certified use of the data collection.
order > dataCollections > dataset
Details of the data assets that the data collection contains.
order > dataCollections > dataCollectionStatus
The status determines whether the data collection is discoverable by Data Users when they search for it. A data collection can have one of the following statuses:
  • - PUBLISHED. The data collection is discoverable to Data Users.
  • - UNPUBLISHED. The data collection isn't discoverable to Data Users.
order > dataCollections > dataOwners
Details of the stakeholders that are assigned the Data Owner stakeholder role on the data collection.
order > dataCollections > technicalOwners
Details of the stakeholders that are assigned the Technical Owner stakeholder role on the data collection.
order > dataCollections > createdBy
Details of the user account that created the data collection.
order > dataCollections > createdOn
Date when the data collection was created.
order > dataCollections > modifiedBy
Details of the latest user account that modified the data collection.
order > dataCollections > modifiedOn
Latest date when the data collection was modified.
deliveryTarget
Details of the delivery target that was used to deliver the data to the Data User.
deliveryTarget > id
System generated unique identifier of the delivery target.
deliveryTarget > name
Name of the delivery target.
deliveryTarget > description
Description of the delivery target.
deliveryTarget > isDefault
This parameter indicates whether the delivery target is the default delivery option for a data collection. The parameter can have one of the following values:
  • - true. The delivery template is the default delivery option for a data collection.
  • - false. The delivery template isn't the default delivery option for a data collection.
deliveryTarget > status
The status indicates whether the delivery target is available for use to the Data Users that order the data collection. A delivery target can have one of the following statuses:
  • - ACTIVE. The delivery target is available.
  • - INACTIVE. The delivery target is unavailable.
deliveryTarget > physicalLocation
Default location where the data is delivered.
Note: If the value of the managedAccess parameter is ENABLED, the data won't be delivered to the location that is specified in the physicalLocation parameter. Instead, the data will be delivered to a location that is generated at the time of order fulfillment. The generated location is unique to each order that is fulfilled using this target.
For more information, see the Integrate Data Marketplace with other Informatica services topic in the Set Up Data Marketplace help.
deliveryTarget > targetSystemReference
Default system where the data is delivered.
deliveryTarget > deliveryTemplate
Details of the delivery template based on which the delivery target was created.
deliveryTarget > deliveryMethod
Details of the delivery method.
deliveryTarget > deliveryFormat
Details of the delivery format.
deliveryTarget > dataCollection
Details of the data collection to which the delivery target is assigned.
deliveryTarget > createdBy
Details of the user account that created the delivery target.
deliveryTarget > createdOn
Date when the delivery target was created.
deliveryTarget > modifiedBy
Details of the latest user account that modified the delivery target.
deliveryTarget > modifiedOn
Latest date when the delivery target was modified.
costCenter
Cost center of the Data User that was granted access to the data collection.
consumer
Details of the Data User that was granted access to the data collection.
usageContext
Details of the usage context that the Data User selected at the time of order.
createdBy
Details of the user account that fulfilled the order that is associated with the consumer access.
createdOn
Date when the order that is associated with the consumer access was fulfilled.
modifiedBy
Details of the latest user account that modified the consumer access.
modifiedOn
Latest date when the consumer access was modified.

Cancel orders

Use REST APIs to cancel orders in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/orders/<orderId>/cancel
<orderId>: Required. Enter the system generated identifier of the order that you want to cancel.
For more information about how you can use an API to get the system generated unique identifier of a order, see Retrieve orders.
To get the system generated unique identifier of a order from the Data Marketplace interface, open the order. The order page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/order/3d48daf6-5e75-4e1a-848c-b6821fc33f74?dtn=Order~579b, the system generated unique identifier is 3d48daf6-5e75-4e1a-848c-b6821fc33f74.
Method
PUT
Note: You can call a maximum of 100 APIs per minute.

Request

The following table describes the parameters that you enter in the request query:
Parameter
Description
comment
Optional. Enter a comment about the action taken.
Note: The API has no payload.

Example request

The following example shows how you can use an API to cancel an order:
https://{{CDMP_URL}}/api/v1/integration/orders/16e32a13-6fba-4f1a-a337-e0aeecf9fab4/cancel

Response

When you pass the API query parameters in the REST client, the client displays a response for the parameter values that you have entered.
The following example shows the response of an API call to cancel an order:
{
"justification": "Standard sales team process.",
"deliveryRequests": "1",
"requestedProvisionedTargetRef": "AWS",
"refId": "947ac3d1-662e-4d3a-a421-12ee38606539-180469874bc",
"status": "CANCELLED",
"id": "ORD-693",
"createdBy": {
"displayName": "John Doe",
"id": "User1",
"name": "username1",
"email": "abc@xyz.com",
"phone": "2020202023",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
}
"createdOn": "2022-03-20T10:50:39.251Z",
"modifiedBy": {
"displayName": "Jane Doe",
"id": "User2",
"name": "username2",
"email": "xyz@abc.com",
"phone": "2020202021",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
}
"modifiedOn": "2022-04-20T10:50:39.251Z"
}
The following table describes the parameters of each order that is cancelled:
Parameter
Description
justification
The reason for the requirement of access to the data provided by the Data User at the time of order.
deliveryRequests
Delivery information of the order.
requestedProvisionedTargetRef
The delivery target requested by the Data User.
Note: If the value of the requestedProvisionedTargetRef parameter is null, the order is created without a specific delivery target but rather uses the default delivery template.
For more information about how you can retrieve the details of the default delivery template, see Retrieve delivery templates.
refId
Reference identifier of the order.
status
Status of the order. An order can have one of the following statuses:
  • - APPROVED. The order is approved for fulfillment. A stakeholder of the ordered data collection must deliver the data to the Data User.
  • - REJECTED. The order was rejected by a stakeholder of the ordered data collection.
  • - COMPLETE. The ordered data was delivered to the Data User.
  • - CANCELLED. The order was cancelled.
id
System generated unique identifier of the order.
createdBy > displayName
Name of the user that placed the order.
createdBy > id
Reference identifier of the order creator's user account.
createdBy > name
Username of the user that placed the order.
createdBy > email
Email address of the user that placed the order.
createdBy > phone
Contact number of the user that placed the order.
createdBy > status
The status indicates whether or not a user account or user group is active. A user account or user group can have one of the following statuses:
  • - ACTIVE. The user account or user group is active.
  • - INACTIVE. The user account or user group is not active.
createdBy > userInfo
Details retrieved from the My Data page of the user account that placed the order.
createdBy > isGroup
This parameter indicates whether the user account is part of a group. This parameter can have one of the following values:
  • - true. The user account is part of a group
  • - false. The user account isn't part of a group
createdOn
Date when the order was placed.
modifiedBy > displayName
Name of the last user that modified the order.
modifiedBy > id
Reference identifier of the user account of the last user that modified the order.
modifiedBy > name
Username of the last user that modified the order.
modifiedBy > email
Email address of the last user that modified the order.
modifiedBy > phone
Contact number of the last user that modified the order.
modifiedBy > status
The status indicates whether or not a user account or user group is active. A user account or user group can have one of the following statuses:
  • - ACTIVE. The user account or user group is active.
  • - INACTIVE. The user account or user group is not active.
modifiedBy > userInfo
Details retrieved from the My Data page of the user account that last modified the order.
modifiedBy > isGroup
This parameter indicates whether the user account is part of a group. This parameter can have one of the following values:
  • - true. The user account is part of a group
  • - false. The user account isn't part of a group
modifiedOn
Latest date when the order was modified.

Delete orders

If you placed an order accidentally or if an order is obsolete, you can use a REST API to delete the order.
Note: To delete a fulfilled order, ensure that you have already deleted its associated consumer access. For more information about how you can delete a consumer access, see Delete consumer accesses.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/orders/<orderId>
<orderId>: Required. Enter the system generated unique identifier of the order that you want to delete.
For more information about how you can use an API to get the system generated unique identifier of a order, see Retrieve orders.
To get the system generated unique identifier of a order from the Data Marketplace interface, open the order. The order page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/order/3d48daf6-5e75-4e1a-848c-b6821fc33f74?dtn=Order~579b, the system generated unique identifier is 3d48daf6-5e75-4e1a-848c-b6821fc33f74.
Method
DELETE
Note: You can call a maximum of 100 APIs per minute.

Request

The API has no payload.

Example request

The following example shows how you can use an API to delete an order:
https://{{CDMP_URL}}/api/v1/integration/orders/16e32a13-6fba-4f1a-a337-e0aeecf9fab4

Response

When you pass the API query parameters in the REST client, the client displays a response for the parameter values that you have entered.
If you see the following response code, it means that the order is deleted successfully:
204 OK code