API Reference > Manage requests, orders and consumer accesses > Data collection requests
  

Data collection requests

If a Data User cannot find a data collection that meets their requirement, they can request for the creation of a new data collection.

Retrieve data collection requests

Use a REST API to retrieve the details of data collection requests in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/requestNewDataCollections
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
requestIds
Optional. Enter the system generated unique identifier of a data collection request.
To get the system generated unique identifier of a data collection request, open the data collection request. The data collection request page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/datacollectionrequest/6e5964ec-e0aa-4eac-963a-3dae0fa1d639?dtn=Request~9b4d, the system generated unique identifier is 6e5964ec-e0aa-4eac-963a-3dae0fa1d639.
To enter more than one value, use the following format:
ids=<value1>&ids=<value2>
userIds
Optional. Enter the system generated unique identifier of the user that requested the new 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 data collection request.
Enter one of the following values:
  • - To find data collection requests that aren't completed, enter PENDING.
  • - To find the data collection requests where a new data collection was created in response to the request, enter COMPLETED.
  • - To find rejected data collection requests, enter REJECTED.
  • - To find cancelled data collection requests, enter CANCELLED.
createdDateFrom
Optional. To find data collection requests that were created between a date range, enter the initial date when the data collection requests 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 data collection requests that were created between a date range, enter the latest date when the data collection requests 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 data collection requests that were modified between a date range, enter the initial date when the data collection requests 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 data collection requests that were modified between a date range, enter the latest date when the data collection requests 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.
referencedDataCollectionIds
Optional. Enter the system generated unique identifier of the data collection based on which the new data collection is to be created.
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.
referencedCategoryIds
Optional. Enter the system generated unique identifier of the category in which the new data collection is to be created.
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.
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.
sortByField
Optional. Specify the parameters to sort the search results.
To sort the search results, enter one of the following values:
  • - ID
  • - JUSTIFICATION
  • - STATUS
  • - CREATED_BY
  • - CREATED_ON
  • - MODIFIED_BY
  • - MODIFIED_ON
Default value is sortByField > 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.
Note: The API has no payload.

Example request

The following example shows how you can use an API to retrieve the details of a data collection request:
https://{{CDMP_URL}}/api/v1/integration/requestNewDataCollections?requestIds=407225ad-7870-4678-8169-43829d80c4bc&sortByField=STATUS&sort=DESC

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 the details of a data collection request:
{
"processingTime": 486,
"offset": 0,
"limit": 50,
"totalCount": 1,
"objects": [
{
"id": "407225ad-7870-4678-8169-43829d80c4bc",
"refId": "d90574a4-417d-4c34-b9f1-4f2da5fc997a",
"justification": "None of the data collections contain retail information specific to the EMEA region.",
"costCenter": "Retail-2007IQ",
"referencedCategory": {
"id": "ad90417f-28bf-44ea-8204-127d70a4a7c9",
"name": "Retail",
"description": "This category contains information on the operational data of retail outlets.",
"refId": "d00be828-d47c-4e9f-a65f-502ba6b633f9",
"status": "ACTIVE",
"effectiveStatus": "ACTIVE"
},
"referencedDataCollection": {},
"createdDataCollection": {},
"usageContext": {},
"status": "PENDING",
"createdBy": {
"displayName": "John Doe",
"id": "8npzPxKim0XjHE4es2gkAc",
"name": "John Doe",
"email": "jdoe@informatica.com",
"phone": "2020202020",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"createdOn": "2022-09-15T17:04:29.382Z",
"modifiedBy": {
"displayName": "John Doe",
"id": "8npzPxKim0XjHE4es2gkAc",
"name": "John Doe",
"email": "jdoe@informatica.com",
"phone": "2020202020",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"modifiedOn": "2022-09-15T17:04:29.382Z"
}
]
}
The following table describes the parameters of each data collection request that is retrieved:
Parameter
Description
offset
Start index for paginated results.
limit
Maximum number of results.
totalCount
Number of data collection requests retrieved.
id
System generated unique identifier of the data collection request.
refId
Reference identifier of the data collection request.
justification
Business justification entered by the requestor of the new data collection.
costCenter
Cost center of the requestor of the new data collection.
referencedCategory
Details of the category in which the new data collection is to be created.
referencedCategory > id
System generated unique identifier of the category in which the new data collection is to be created.
referencedCategory > name
Name of the category in which the new data collection is to be created.
referencedCategory > description
Description of the category in which the new data collection is to be created.
referencedCategory > refId
Reference identifier of the category in which the new data collection is to be created.
referencedCategory > status
Status of the category in which the new data collection is to be created.
referencedCategory > effectiveStatus
The effective status of the category in which the new data collection is to be created.
referencedDataCollection
Details of the data collection based on which the new data collection is to be created.
createdDataCollection
Details of the new data collection that is created in response to the data collection request.
usageContext
Details of the usage context entered by the requestor of the new data collection.
status
Status of the data collection request. A data collection request can have one of the following statuses:
  • - PENDING. A request for a new data collection is submitted.
  • - COMPLETED. A new data collection was created in response to the request.
  • - REJECTED. The request was rejected by a stakeholder of the category or data collection.
  • - CANCELLED. The data collection request was cancelled by the Data User.
createdBy
Details of the user account that requested a new data collection.
createdOn
Date when the data collection request was created.
modifiedBy
Details of the latest user account that modified the data collection request.
modifiedOn
Latest date when the data collection request was modified.

Reject data collection requests

Use a REST API to reject a request for a new data collection in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/requestNewDataCollections/<Id>/reject
<Id>: Required. Enter the system generated unique identifier of the data collection request that you want to reject.
For more information about how you can use an API to get the system generated unique identifier of a data collection request, see Retrieve data collection requests.
To get the system generated unique identifier of a data collection request from the Data Marketplace interface, open the data collection request. The data collection request page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/datacollectionrequest/6e5964ec-e0aa-4eac-963a-3dae0fa1d639?dtn=Request~9b4d, the system generated unique identifier is 6e5964ec-e0aa-4eac-963a-3dae0fa1d639.
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 a data collection request:
https://{{CDMP_URL}}/api/v1/integration/requestNewDataCollections/d2313aed-330e-44a0-bcfa-380ee4a95a62/reject?comment=Reject%20DCR

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 data collection request is rejected successfully:
204 OK code

Fulfill data collection requests

Use a REST API to fulfill a request for a new data collection in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/requestNewDataCollections/<Id>/fulfill
<Id>: Required. Enter the system generated unique identifier of the data collection request that you want to fulfill.
For more information about how you can use an API to get the system generated unique identifier of a data collection request, see Retrieve data collection requests.
To get the system generated unique identifier of a data collection request from the Data Marketplace interface, open the data collection request. The data collection request page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/datacollectionrequest/6e5964ec-e0aa-4eac-963a-3dae0fa1d639?dtn=Request~9b4d, the system generated unique identifier is 6e5964ec-e0aa-4eac-963a-3dae0fa1d639.
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
dataCollectionId
Required. Enter the system generated unique identifier of the new data collection that is created in response to the data collection request.
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.
comment
Optional. Enter a comment about the action taken.
-
costCenter
Optional. Enter the cost center of the user that requested the new data collection.
If the requestor entered an incorrect or an invalid cost center, you can enter the correct cost center.
Note: The API has no payload.

Example request

The following example shows how you can use an API to fulfill data collection requests:
https://{{CDMP_URL}}/api/v1/integration/requestNewDataCollections/b9992251-e69d-4fdf-9bc1-f1e19f6c908a/fulfill?dataCollectionId=7c0198bb-7577-4791-822a-6a5c62ceff4c&comment=Fulfill%20DCR&costCenter=FulfillDCRCostCenter

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 data collection request is fulfilled successfully:
204 OK code

Cancel data collection requests

Use a REST API to cancel a request for a new data collection in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/requestNewDataCollections/<Id>/cancel
<Id>: Required. Enter the system generated unique identifier of the data collection request that you want to cancel.
For more information about how you can use an API to get the system generated unique identifier of a data collection request, see Retrieve data collection requests.
To get the system generated unique identifier of a data collection request from the Data Marketplace interface, open the data collection request. The data collection request page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/datacollectionrequest/6e5964ec-e0aa-4eac-963a-3dae0fa1d639?dtn=Request~9b4d, the system generated unique identifier is 6e5964ec-e0aa-4eac-963a-3dae0fa1d639.
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 a data collection request:
https://{{CDMP_URL}}/api/v1/integration/requestNewDataCollections/d2313aed-330e-44a0-bcfa-380ee4a95a62/cancel?comment=Cancel%20DCR

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 data collection request is cancelled successfully:
204 OK code

Delete data collection requests

If you submitted a data collection request accidentally or if a data collection request is obsolete, you can use a REST API to delete the request.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/requestNewDataCollections/<Id>
<Id>: Required. Enter the system generated unique identifier of the data collection request that you want to delete.
For more information about how you can use an API to get the system generated unique identifier of a data collection request, see Retrieve data collection requests.
To get the system generated unique identifier of a data collection request from the Data Marketplace interface, open the data collection request. The data collection request page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/datacollectionrequest/6e5964ec-e0aa-4eac-963a-3dae0fa1d639?dtn=Request~9b4d, the system generated unique identifier is 6e5964ec-e0aa-4eac-963a-3dae0fa1d639.
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 a data collection request:
https://{{CDMP_URL}}/api/v1/integration/requestNewDataCollections/d2313aed-330e-44a0-bcfa-380ee4a95a62

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 data collection request is deleted successfully:
204 OK code