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

Consumer accesses

A record that indicates a Data User's access to a data collection, along with other details such as the date of delivery, details of the stakeholder that delivered the data, and the delivery option that was used for the delivery.

Create consumer accesses

Use a REST API to create a consumer access in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/consumerAccess
Method
POST

Request

In the body of the API payload, enter the following parameters:
Parameter
Description
Additional Information
refId
Optional. Enter a reference identifier for the consumer access.
If you don't specify a reference identifier, Data Marketplace automatically assigns a unique value to the object. The reference identifier that Data Marketplace automatically generates contains a prefix. The Administrator can specify the prefix of the automatically generated reference identifier in Metadata Command Center.
If you want to specify a reference identifier, ensure that you enter a unique value. Ensure that you don't use the prefix value that is configured in Metadata Command Center.
status
Optional. Specify a status for the consumer access that you want to create.
Enter one of the following values:
  • - For a consumer access where the Data User has access to the data collection, enter AVAILABLE.
  • - For a consumer access that is awaiting withdrawal, enter PENDING_WITHDRAW.
  • - For a consumer access that is withdrawn, enter WITHDRAWN.
Default value is AVAILABLE.
dataCollectionId
Required. Enter the system generated unique identifier of the data collection to which the Data User was granted access.
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.
deliveryTargetId
Required. Enter the system generated unique identifier of the delivery target that was used to deliver the data.
For more information about how you can use an API to get the system generated unique identifier of a delivery target, see Retrieve delivery targets.
consumerUserId
Required. Enter the system generated unique identifier of the user account that was granted access to 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.
accessGrantedOn
Optional. Enter the date on which the Data User was granted access to the data collection.
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.
usageContextId
Optional. Enter the system generated unique identifier of the usage type used to specify the context in which the data is to be used as provided by the Data User that was granted access to the collection.
For more information about how you can use an API to get the system generated unique identifier of a usage type, see Retrieve usage type.
costCenter
Optional. Enter the cost center of the Data User that was granted access to the data collection.
-

Example request

The following example shows how you can use an API to create consumer accesses:

{
"refId": "CAS710",
"status": "WITHDRAWN",
"dataCollectionId": "ed76133s-86vb-53rt-2914-677d73r4a7c5",
"deliveryTargetId": "ad90417f-28bf-44ea-8204-127d70a4a7c9",
"consumerUserId": "d00be828-d47c-4e9f-a65f-502ba6b633f9",
"accessGrantedOn": "2022-09-15T17:04:29.382Z",
"usageContextId": "8npzPxKim0XjHE4es2gkAc",
"costCenter": "Retail-100IEQ"
}

Response

When you pass the API payload 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 create consumer accesses:

{
"processingTime": 489,
"id": "407225ad-7870-4678-8169-43829d80c4bc",
"refId": "CAS710"
}
The following table describes the parameters of each consumer access that is created:
Parameter
Description
id
System generated unique identifier of the consumer access that is created.
refId
Reference identifier of the consumer access that is created.

Retrieve consumer accesses

Use a REST API to retrieve the details of consumer accesses in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/consumerAccess
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
consumerAccessIds
Optional. Enter the system generated unique identifier of a consumer access.
To get the system generated unique identifier of a consumer access, open the consumer access. The consumer access page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/access/e254491f-5795-49bd-be0b-385eb11d9d5a?dtn=Access~2e85, the system generated unique identifier is e254491f-5795-49bd-be0b-385eb11d9d5a.
To enter more than one value, use the following format:
ids=<value1>&ids=<value2>
dataCollectionIds
Optional. Enter the system generated unique identifier of the data collection to which the Data User was granted access.
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.
deliveryTemplateIds
Optional. Enter the system generated unique identifier of the delivery template that was used to deliver the data to the Data User.
For more information about how you can use an API to get the system generated unique identifier of a delivery template, see Retrieve delivery templates.
consumerAccessCreatedBy
Optional. Enter the system generated unique identifier of the user account that created the consumer access.
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 consumer accesses that were created between a date range, enter the initial date when the consumer accesses 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 consumer accesses that were created between a date range, enter the latest date when the consumer accesses 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.
status
Optional. Specify the status of the consumer access.
Enter one of the following values:
  • - To find consumer accesses where the Data User has access to the data collection, enter AVAILABLE.
  • - To find consumer accesses that are pending withdrawal, enter PENDING_WITHDRAW.
  • - To find consumer accesses that are withdrawn, WITHDRAWN.
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 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.
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 the details of a consumer access:
https://{{CDMP_URL}}/api/v1/integration/consumerAccess?consumerAccessIds=40b32fbd-538a-4369-9246-d18b7998f011&status=AVAILABLE&sortByField=ID&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 the details of a consumer access:
{
"processingTime": 436,
"offset": 0,
"limit": 50,
"totalCount": 1,
"objects": [
{
"id": "40b32fbd-538a-4369-9246-d18b7998f011",
"refId": "ACC-131",
"status": "AVAILABLE",
"accessGrantedOn": "2022-09-14T13:30:36.405Z",
"costCenter": "Retail-IQO3456",
"order": {
"justification": "Required for the Q3 sales reporting.",
"deliveryRequests": null,
"requestedProvisionedTargetRef": "b441a10a-d64d-4801-94d8-145e805001c4",
"refId": "ORD-345",
"dataCollections": null,
"termsOfUseSnapshots": null,
"status": "COMPLETE",
"id": "b986ae59-7fc9-414c-98d7-14c7a1671023",
"usageContext": null,
"createdBy": {
"displayName": "Johnny Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"createdOn": "2022-09-14T13:30:36.405Z",
"modifiedBy": {
"displayName": "Johnny Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"modifiedOn": "2022-09-14T13:30:36.405Z",
"costCenter": "Retail-IQO3456"
},
"deliveryTarget": {
"id": "b441a10a-d64d-4801-94d8-145e805001c4",
"name": "IPFS Delivery",
"description": "Use this template to deliver data via IPFS.",
"isDefault": true,
"status": "ACTIVE",
"physicalLocation": "ipfs://{cid}/path/to/subresource/cat.jpg",
"targetSystemReference": "IPFS",
"deliveryTemplate": {
"id": "1c865800-86ca-4280-8cdd-89dda66c013c",
"name": "IPFS",
"description": "Use this template to deliver data via IPFS.",
"color": null,
"isDefault": true,
"status": "ACTIVE",
"managedAccess": "DISABLED",
"deliveryType": "AUTOMATIC",
"templateOwners": [
{
"displayName": "Johnny Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
}
],
"targetSystemReference": "IPFS",
"defaultPhysicalLocation": "ipfs://{cid}/path/to/subresource/cat.jpg",
"deliveryMethods": null,
"deliveryFormats": null,
"createdBy": "8npzPxKim0XjHE4es2gkAc",
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": "8npzPxKim0XjHE4es2gkAc",
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"deliveryMethod": {
"id": "string",
"name": "string",
"status": "ACTIVE",
"createdBy": "8npzPxKim0XjHE4es2gkAc",
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": "8npzPxKim0XjHE4es2gkAc",
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"deliveryFormat": {
"id": "e0f8af4d-c0f0-4c02-af03-5b9b2ce43253",
"name": "CSV",
"status": "Deliver data as a CSV file.",
"createdBy": "8npzPxKim0XjHE4es2gkAc",
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": "8npzPxKim0XjHE4es2gkAc",
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"dataCollection": {
"id": "e1765e74-7907-4a8a-a622-3ed5532c796f",
"name": "Retail Sales Report",
"description": "Sales reports for the retail outlets.",
"refId": "DCL-672",
"category": {},
"usageContexts": null,
"dataset": null,
"dataCollectionStatus": "PUBLISHED",
"dataOwners": [],
"technicalOwners": [],
"createdBy": {
"displayName": "Janet Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jtdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": {
"displayName": "Janet Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jtdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"createdBy": "8npzPxKim0XjHE4es2gkAc",
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": "8npzPxKim0XjHE4es2gkAc",
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"dataCollection": {
"id": "e1765e74-7907-4a8a-a622-3ed5532c796f",
"name": "Retail Sales Report",
"description": "Sales reports for the retail outlets.",
"refId": "DCL-672",
"category": null,
"usageContexts": null,
"dataset": null,
"dataCollectionStatus": "PUBLISHED",
"dataOwners": [
{
"displayName": "Janet Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jtdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
}
],
"technicalOwners": [
{
"displayName": "Johnny Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
}
],
"createdBy": {
"displayName": "Jane Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": {
"displayName": "Jane Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"termsOfUseSnapshots": [
{
"id": "e37bf0c7-faf3-4902-8bcc-485d80cc8bb9",
"termsOfUseId": null,
"termsOfUseRefId": null,
"generalTermsOfUse": "This data must not be accessed via unauthorized devices.",
"name": null,
"description": null,
"type": null,
"status": null,
"acknowledgement": null,
"parentId": "null,
"referenceLink": null,
"createdOn": "2022-09-14T11:57:00.446Z"
}
],
"consumer": {
"displayName": "John Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"usageContext": {
"id": "9669f6ab-affc-4106-a583-48a6b580b930",
"name": "Sales Use",
"description": "This is for sales reporting tasks.",
"color": null,
"status": "ACTIVE"
},
"createdBy": {
"displayName": "Jane Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"createdOn": "2022-09-14T13:30:36.726Z",
"modifiedBy": {
"displayName": "Jane Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"modifiedOn": "2022-09-15T13:59:40.472Z"
}
]
}
The following table describes the parameters of each consumer access that is retrieved:
Parameter
Description
offset
Starting index for the paginated results.
limit
Maximum number of results.
totalCount
Number of consumer accesses retrieved.
id
System generated unique identifier of the consumer access.
refId
Reference identifier of the consumer access.
status
Status of the consumer access.
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.
accessGrantedOn
Date on which the Data User was granted access to the data collection.
costCenter
Cost center of the Data User that was granted access to the data collection.
order
Details of the order placed by the Data User that was granted access to the data collection.
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 > refId
Reference identifier of the order.
order > dataCollections
Details of the ordered data collection.
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.
order > id
System generated unique identifier of the order.
order > usageContext
Details of the usage type that the Data User selected at the time of order.
order > createdBy
Details of the user account that ordered the data collection.
order > createdOn
Date when the order was created.
order > modifiedBy
Details of the latest user account that modified the order.
order > modifiedOn
Latest date when the order was modified.
order > costCenter
Cost center of the Data User that ordered the data collection.
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
Status of the delivery target.
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.
dataCollection
Details of the data collection for which the Data User was granted access.
dataCollection > id
System generated unique identifier of the data collection.
dataCollection > name
Name of the data collection.
dataCollection > description
Purpose of the data collection.
dataCollection > refId
Reference identifier of the data collection.
dataCollection > category
Details of the category of the data collection.
dataCollection > usageContexts
Details of the usage type that is used to specify the certified use of the data collection.
dataCollection > dataset
Details of the data assets that the data collection contains.
dataCollection > 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.
dataCollection > dataOwners
Details of the stakeholders that are assigned the Data Owner stakeholder role on the data collection.
dataCollection > technicalOwners
Details of the stakeholders that are assigned the Technical Owner stakeholder role on the data collection.
dataCollection > createdBy
Details of the user account that created the data collection.
dataCollection > createdOn
Date when the data collection was created.
dataCollection > modifiedBy
Details of the latest user account that modified the data collection.
dataCollection > modifiedOn
Latest date when the data collection was modified.
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.
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 created the consumer access.
createdOn
Date when the consumer access was created.
modifiedBy
Details of the latest user account that modified the consumer access.
modifiedOn
Latest date when the consumer access was modified.

Make consumer accesses available

Use a REST API to make consumer accesses available in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/consumerAccess/<consumerAccessId>/available
<consumerAccessId>: Required. Enter the system generated identifier of the consumer access whose status you want to set to AVAILABLE.
For more information about how you can use an API to get the system generated unique identifier of a consumer access, see Retrieve consumer accesses.
To get the system generated unique identifier of a consumer access from the Data Marketplace interface, open the consumer access. The consumer access page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/access/e254491f-5795-49bd-be0b-385eb11d9d5a?dtn=Access~2e85, the system generated unique identifier is e254491f-5795-49bd-be0b-385eb11d9d5a.
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 make a consumer access available:
https://{{CDMP_URL}}/api/v1/integration/consumerAccess/794a215f-5479-4b55-8e1b-a4866ec9fe82/available?comment=Request%20Granted

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 make a consumer access available:

{
"id": "794a215f-5479-4b55-8e1b-a4866ec9fe82",
"refId": "ACC-246",
"status": "AVAILABLE",
"accessGrantedOn": "2022-09-14T13:30:36.405Z",
"costCenter": "Retail-IQO3456",
"order": {
"justification": "Required for the Q3 sales reporting.",
"deliveryRequests": null,
"requestedProvisionedTargetRef": "b441a10a-d64d-4801-94d8-145e805001c4",
"refId": "ORD-337",
"dataCollections": null,
"termsOfUseSnapshots": null,
"status": "COMPLETE",
"id": "b986ae59-7fc9-414c-98d7-14c7a1671023",
"usageContext": null,
"createdBy": {
"displayName": "Johnny Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"createdOn": "2022-09-14T13:30:36.405Z",
"modifiedBy": {
"displayName": "Johnny Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"modifiedOn": "2022-09-14T13:30:36.405Z",
"costCenter": "Retail-IQO3456"
},
"deliveryTarget": {
"id": "b441a10a-d64d-4801-94d8-145e805001c4",
"name": "IPFS Delivery",
"description": "Use this template to deliver data via IPFS.",
"isDefault": true,
"status": "ACTIVE",
"physicalLocation": "ipfs://{cid}/path/to/subresource/cat.jpg",
"targetSystemReference": "IPFS",
"deliveryTemplate": {
"id": "1c865800-86ca-4280-8cdd-89dda66c013c",
"name": "IPFS",
"description": "Use this template to deliver data via IPFS.",
"color": null,
"isDefault": true,
"status": "ACTIVE",
"managedAccess": "DISABLED",
"deliveryType": "AUTOMATIC",
"templateOwners": [
{
"displayName": "Johnny Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
}
],
"targetSystemReference": "IPFS",
"defaultPhysicalLocation": "ipfs://{cid}/path/to/subresource/cat.jpg",
"deliveryMethods": null,
"deliveryFormats": null,
"createdBy": "8npzPxKim0XjHE4es2gkAc",
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": "8npzPxKim0XjHE4es2gkAc",
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"deliveryMethod": {
"id": "f8f8as4d-c0f0-3r11-fr04-7b7h2ce46731",
"name": "IPFS",
"status": "ACTIVE",
"createdBy": "8npzPxKim0XjHE4es2gkAc",
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": "8npzPxKim0XjHE4es2gkAc",
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"deliveryFormat": {
"id": "e0f8af4d-c0f0-4c02-af03-5b9b2ce43253",
"name": "CSV",
"status": "Deliver data as a CSV file.",
"createdBy": "8npzPxKim0XjHE4es2gkAc",
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": "8npzPxKim0XjHE4es2gkAc",
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"dataCollection": {
"id": "e1765e74-7907-4a8a-a622-3ed5532c796f",
"name": "Retail Sales Report",
"description": "Sales reports for the retail outlets.",
"refId": "DCL-834",
"category": null,
"usageContexts": null,
"dataset": null,
"dataCollectionStatus": "PUBLISHED",
"dataOwners": [],
"technicalOwners": [],
"createdBy": {
"displayName": "Janet Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jtdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": {
"displayName": "Janet Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jtdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"createdBy": "8npzPxKim0XjHE4es2gkAc",
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": "8npzPxKim0XjHE4es2gkAc",
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"dataCollection": {
"id": "e1765e74-7907-4a8a-a622-3ed5532c796f",
"name": "Retail Sales Report",
"description": "Sales reports for the retail outlets.",
"refId": "DCL-834",
"category": null,
"usageContexts": null,
"dataset": null,
"dataCollectionStatus": "PUBLISHED",
"dataOwners": [
{
"displayName": "Janet Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jtdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
}
],
"technicalOwners": [
{
"displayName": "Johnny Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
}
],
"createdBy": {
"displayName": "Jane Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": {
"displayName": "Jane Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"termsOfUseSnapshots": [
{
"id": "e37bf0c7-faf3-4902-8bcc-485d80cc8bb9",
"termsOfUseId": null,
"termsOfUseRefId": null,
"generalTermsOfUse": "This data must not be accessed via unauthorized devices.",
"name": null,
"description": null,
"type": null,
"status": null,
"acknowledgement": null,
"parentId": "null,
"referenceLink": null,
"createdOn": "2022-09-14T11:57:00.446Z"
}
],
"consumer": {
"displayName": "John Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"usageContext": {
"id": "9669f6ab-affc-4106-a583-48a6b580b930",
"name": "Sales Use",
"description": "This is for sales reporting tasks.",
"color": null,
"status": "ACTIVE"
},
"createdBy": {
"displayName": "Jane Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"createdOn": "2022-09-14T13:30:36.726Z",
"modifiedBy": {
"displayName": "Jane Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"modifiedOn": "2022-09-15T13:59:40.472Z"
}
The following table describes the parameters of each consumer access that is made available to Data Users:
Parameter
Description
id
System generated unique identifier of the consumer access.
refId
Reference identifier of the consumer access.
status
Status of the consumer access.
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.
accessGrantedOn
Date on which the Data User was granted access to the data collection.
costCenter
Cost center of the Data User that was granted access to the data collection.
order
Details of the order placed by the Data User that was granted access to the data collection.
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 > refId
Reference identifier of the order.
order > dataCollections
Details of the ordered data collection.
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.
order > id
System generated unique identifier of the order.
order > usageContext
Details of the usage type that the Data User selected at the time of order.
order > createdBy
Details of the user account that ordered the data collection.
order > createdOn
Date when the order was created.
order > modifiedBy
Details of the latest user account that modified the order.
order > modifiedOn
Latest date when the order was modified.
order > costCenter
Cost center of the Data User that ordered the data collection.
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
Status of the delivery target.
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.
dataCollection
Details of the data collection for which the Data User was granted access.
dataCollection > id
System generated unique identifier of the data collection.
dataCollection > name
Name of the data collection.
dataCollection > description
Purpose of the data collection.
dataCollection > refId
Reference identifier of the data collection.
dataCollection > category
Details of the category of the data collection.
dataCollection > usageContexts
Details of the usage type that is used to specify the certified use of the data collection.
dataCollection > dataset
Details of the data assets that the data collection contains.
dataCollection > 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.
dataCollection > dataOwners
Details of the stakeholders that are assigned the Data Owner stakeholder role on the data collection.
dataCollection > technicalOwners
Details of the stakeholders that are assigned the Technical Owner stakeholder role on the data collection.
dataCollection > createdBy
Details of the user account that created the data collection.
dataCollection > createdOn
Date when the data collection was created.
dataCollection > modifiedBy
Details of the latest user account that modified the data collection.
dataCollection > modifiedOn
Latest date when the data collection was modified.
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.
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 created the consumer access.
createdOn
Date when the consumer access was created.
modifiedBy
Details of the latest user account that modified the consumer access.
modifiedOn
Latest date when the consumer access was modified.

Submit consumer access withdrawals

Use a REST API to submit a request to withdraw a Data User's access to a data collection.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/consumerAccess/<consumerAccessId>/pending_withdraw
<consumerAccessId>: Required. Enter the system generated identifier of the consumer access for which you want to request a withdrawal.
For more information about how you can use an API to get the system generated unique identifier of a consumer access, see Retrieve consumer accesses.
To get the system generated unique identifier of a consumer access from the Data Marketplace interface, open the consumer access. The consumer access page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/access/e254491f-5795-49bd-be0b-385eb11d9d5a?dtn=Access~2e85, the system generated unique identifier is e254491f-5795-49bd-be0b-385eb11d9d5a.
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 submit a withdrawal request for a consumer access:
https://{{CDMP_URL}}/api/v1/integration/consumerAccess/794a215f-5479-4b55-8e1b-a4866ec9fe82/pending_withdraw?comment=Request%20Withdraw

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 submit a withdrawal request for a consumer access:

{
"id": "794a215f-5479-4b55-8e1b-a4866ec9fe82",
"refId": "ACC-246",
"status": "PENDING_WITHDRAW",
"accessGrantedOn": "2022-09-14T13:30:36.405Z",
"costCenter": "Retail-IQO3456",
"order": {
"justification": "Required for the Q3 sales reporting.",
"deliveryRequests": null,
"requestedProvisionedTargetRef": "b441a10a-d64d-4801-94d8-145e805001c4",
"refId": "ORD-337",
"dataCollections": null,
"termsOfUseSnapshots": null,
"status": "COMPLETE",
"id": "b986ae59-7fc9-414c-98d7-14c7a1671023",
"usageContext": null,
"createdBy": {
"displayName": "Johnny Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"createdOn": "2022-09-14T13:30:36.405Z",
"modifiedBy": {
"displayName": "Johnny Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"modifiedOn": "2022-09-14T13:30:36.405Z",
"costCenter": "Retail-IQO3456"
},
"deliveryTarget": {
"id": "b441a10a-d64d-4801-94d8-145e805001c4",
"name": "IPFS Delivery",
"description": "Use this template to deliver data via IPFS.",
"isDefault": true,
"status": "ACTIVE",
"physicalLocation": "ipfs://{cid}/path/to/subresource/cat.jpg",
"targetSystemReference": "IPFS",
"deliveryTemplate": {
"id": "1c865800-86ca-4280-8cdd-89dda66c013c",
"name": "IPFS",
"description": "Use this template to deliver data via IPFS.",
"color": null,
"isDefault": true,
"status": "ACTIVE",
"managedAccess": "DISABLED",
"deliveryType": "AUTOMATIC",
"templateOwners": [
{
"displayName": "Johnny Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
}
],
"targetSystemReference": "IPFS",
"defaultPhysicalLocation": "ipfs://{cid}/path/to/subresource/cat.jpg",
"deliveryMethods": null,
"deliveryFormats": null,
"createdBy": "8npzPxKim0XjHE4es2gkAc",
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": "8npzPxKim0XjHE4es2gkAc",
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"deliveryMethod": {
"id": "f8f8as4d-c0f0-3r11-fr04-7b7h2ce46731",
"name": "IPFS",
"status": "ACTIVE",
"createdBy": "8npzPxKim0XjHE4es2gkAc",
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": "8npzPxKim0XjHE4es2gkAc",
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"deliveryFormat": {
"id": "e0f8af4d-c0f0-4c02-af03-5b9b2ce43253",
"name": "CSV",
"status": "Deliver data as a CSV file.",
"createdBy": "8npzPxKim0XjHE4es2gkAc",
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": "8npzPxKim0XjHE4es2gkAc",
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"dataCollection": {
"id": "e1765e74-7907-4a8a-a622-3ed5532c796f",
"name": "Retail Sales Report",
"description": "Sales reports for the retail outlets.",
"refId": "DCL-834",
"category": null,
"usageContexts": null,
"dataset": null,
"dataCollectionStatus": "PUBLISHED",
"dataOwners": [],
"technicalOwners": [],
"createdBy": {
"displayName": "Janet Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jtdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": {
"displayName": "Janet Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jtdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"createdBy": "8npzPxKim0XjHE4es2gkAc",
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": "8npzPxKim0XjHE4es2gkAc",
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"dataCollection": {
"id": "e1765e74-7907-4a8a-a622-3ed5532c796f",
"name": "Retail Sales Report",
"description": "Sales reports for the retail outlets.",
"refId": "DCL-834",
"category": null,
"usageContexts": null,
"dataset": null,
"dataCollectionStatus": "PUBLISHED",
"dataOwners": [
{
"displayName": "Janet Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jtdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
}
],
"technicalOwners": [
{
"displayName": "Johnny Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
}
],
"createdBy": {
"displayName": "Jane Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": {
"displayName": "Jane Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"termsOfUseSnapshots": [
{
"id": "e37bf0c7-faf3-4902-8bcc-485d80cc8bb9",
"termsOfUseId": null,
"termsOfUseRefId": null,
"generalTermsOfUse": "This data must not be accessed via unauthorized devices.",
"name": null,
"description": null,
"type": null,
"status": null,
"acknowledgement": null,
"parentId": "null,
"referenceLink": null,
"createdOn": "2022-09-14T11:57:00.446Z"
}
],
"consumer": {
"displayName": "John Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"usageContext": {
"id": "9669f6ab-affc-4106-a583-48a6b580b930",
"name": "Sales Use",
"description": "This is for sales reporting tasks.",
"color": null,
"status": "ACTIVE"
},
"createdBy": {
"displayName": "Jane Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"createdOn": "2022-09-14T13:30:36.726Z",
"modifiedBy": {
"displayName": "Jane Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"modifiedOn": "2022-09-15T13:59:40.472Z"
}
The following table describes the parameters of each consumer access for which a withdrawal request is submitted:
Parameter
Description
id
System generated unique identifier of the consumer access.
refId
Reference identifier of the consumer access.
status
Status of the consumer access.
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.
accessGrantedOn
Date on which the Data User was granted access to the data collection.
costCenter
Cost center of the Data User that was granted access to the data collection.
order
Details of the order placed by the Data User that was granted access to the data collection.
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 > refId
Reference identifier of the order.
order > dataCollections
Details of the ordered data collection.
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.
order > id
System generated unique identifier of the order.
order > usageContext
Details of the usage type that the Data User selected at the time of order.
order > createdBy
Details of the user account that ordered the data collection.
order > createdOn
Date when the order was created.
order > modifiedBy
Details of the latest user account that modified the order.
order > modifiedOn
Latest date when the order was modified.
order > costCenter
Cost center of the Data User that ordered the data collection.
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
Status of the delivery target.
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.
dataCollection
Details of the data collection for which the Data User was granted access.
dataCollection > id
System generated unique identifier of the data collection.
dataCollection > name
Name of the data collection.
dataCollection > description
Purpose of the data collection.
dataCollection > refId
Reference identifier of the data collection.
dataCollection > category
Details of the category of the data collection.
dataCollection > usageContexts
Details of the usage type that is used to specify the certified use of the data collection.
dataCollection > dataset
Details of the data assets that the data collection contains.
dataCollection > 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.
dataCollection > dataOwners
Details of the stakeholders that are assigned the Data Owner stakeholder role on the data collection.
dataCollection > technicalOwners
Details of the stakeholders that are assigned the Technical Owner stakeholder role on the data collection.
dataCollection > createdBy
Details of the user account that created the data collection.
dataCollection > createdOn
Date when the data collection was created.
dataCollection > modifiedBy
Details of the latest user account that modified the data collection.
dataCollection > modifiedOn
Latest date when the data collection was modified.
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.
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 created the consumer access.
createdOn
Date when the consumer access was created.
modifiedBy
Details of the latest user account that modified the consumer access.
modifiedOn
Latest date when the consumer access was modified.

Withdraw consumer accesses

Use a REST API to the withdraw a Data User's access to a data collection.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/consumerAccess/<consumerAccessId>/withdrawn
<consumerAccessId>: Required. Enter the system generated unique identifier of the consumer access for which you want to withdraw.
For more information about how you can use an API to get the system generated unique identifier of a consumer access, see Retrieve consumer accesses.
To get the system generated unique identifier of a consumer access from the Data Marketplace interface, open the consumer access. The consumer access page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/access/e254491f-5795-49bd-be0b-385eb11d9d5a?dtn=Access~2e85, the system generated unique identifier is e254491f-5795-49bd-be0b-385eb11d9d5a.
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 withdraw a consumer access:
https://{{CDMP_URL}}/api/v1/integration/consumerAccess/794a215f-5479-4b55-8e1b-a4866ec9fe82/withdrawn?comment=Request%20Withdraw

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 withdraw a consumer access:

{
"id": "794a215f-5479-4b55-8e1b-a4866ec9fe82",
"refId": "ACC-246",
"status": "WITHDRAWN",
"accessGrantedOn": "2022-09-14T13:30:36.405Z",
"costCenter": "Retail-IQO3456",
"order": {
"justification": "Required for the Q3 sales reporting.",
"deliveryRequests": null,
"requestedProvisionedTargetRef": "b441a10a-d64d-4801-94d8-145e805001c4",
"refId": "ORD-337",
"dataCollections": {},
"termsOfUseSnapshots": null,
"status": "COMPLETE",
"id": "b986ae59-7fc9-414c-98d7-14c7a1671023",
"usageContext": null,
"createdBy": {
"displayName": "Johnny Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"createdOn": "2022-09-14T13:30:36.405Z",
"modifiedBy": {
"displayName": "Johnny Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"modifiedOn": "2022-09-14T13:30:36.405Z",
"costCenter": "Retail-IQO3456"
},
"deliveryTarget": {
"id": "b441a10a-d64d-4801-94d8-145e805001c4",
"name": "IPFS Delivery",
"description": "Use this template to deliver data via IPFS.",
"isDefault": true,
"status": "ACTIVE",
"physicalLocation": "ipfs://{cid}/path/to/subresource/cat.jpg",
"targetSystemReference": "IPFS",
"deliveryTemplate": {
"id": "1c865800-86ca-4280-8cdd-89dda66c013c",
"name": "IPFS",
"description": "Use this template to deliver data via IPFS.",
"color": null,
"isDefault": true,
"status": "ACTIVE",
"managedAccess": "DISABLED",
"deliveryType": "AUTOMATIC",
"templateOwners": [
{
"displayName": "Johnny Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
}
],
"targetSystemReference": "IPFS",
"defaultPhysicalLocation": "ipfs://{cid}/path/to/subresource/cat.jpg",
"deliveryMethods": null,
"deliveryFormats": null,
"createdBy": "8npzPxKim0XjHE4es2gkAc",
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": "8npzPxKim0XjHE4es2gkAc",
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"deliveryMethod": {
"id": "f8f8as4d-c0f0-3r11-fr04-7b7h2ce46731",
"name": "IPFS",
"status": "ACTIVE",
"createdBy": "8npzPxKim0XjHE4es2gkAc",
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": "8npzPxKim0XjHE4es2gkAc",
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"deliveryFormat": {
"id": "e0f8af4d-c0f0-4c02-af03-5b9b2ce43253",
"name": "CSV",
"status": "Deliver data as a CSV file.",
"createdBy": "8npzPxKim0XjHE4es2gkAc",
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": "8npzPxKim0XjHE4es2gkAc",
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"dataCollection": {
"id": "e1765e74-7907-4a8a-a622-3ed5532c796f",
"name": "Retail Sales Report",
"description": "Sales reports for the retail outlets.",
"refId": "DCL-834",
"category": null,
"usageContexts": null,
"dataset": null,
"dataCollectionStatus": "PUBLISHED",
"dataOwners": [],
"technicalOwners": [],
"createdBy": {
"displayName": "Janet Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jtdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": {
"displayName": "Janet Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jtdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"createdBy": "8npzPxKim0XjHE4es2gkAc",
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": "8npzPxKim0XjHE4es2gkAc",
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"dataCollection": {
"id": "e1765e74-7907-4a8a-a622-3ed5532c796f",
"name": "Retail Sales Report",
"description": "Sales reports for the retail outlets.",
"refId": "DCL-834",
"category": null,
"usageContexts": null,
"dataset": null,
"dataCollectionStatus": "PUBLISHED",
"dataOwners": [
{
"displayName": "Janet Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jtdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
}
],
"technicalOwners": [
{
"displayName": "Johnny Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jydoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
}
],
"createdBy": {
"displayName": "Jane Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"createdOn": "2022-09-14T11:57:00.446Z",
"modifiedBy": {
"displayName": "Jane Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"modifiedOn": "2022-09-14T11:57:00.446Z"
},
"termsOfUseSnapshots": [
{
"id": "e37bf0c7-faf3-4902-8bcc-485d80cc8bb9",
"termsOfUseId": null,
"termsOfUseRefId": null,
"generalTermsOfUse": "This data must not be accessed via unauthorized devices.",
"name": null,
"description": null,
"type": null,
"status": null,
"acknowledgement": null,
"parentId": "null,
"referenceLink": null,
"createdOn": "2022-09-14T11:57:00.446Z"
}
],
"consumer": {
"displayName": "John Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"usageContext": {
"id": "9669f6ab-affc-4106-a583-48a6b580b930",
"name": "Sales Use",
"description": "This is for sales reporting tasks.",
"color": null,
"status": "ACTIVE"
},
"createdBy": {
"displayName": "Jane Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"createdOn": "2022-09-14T13:30:36.726Z",
"modifiedBy": {
"displayName": "Jane Doe",
"id": "6k7aaGYrSOsfN7RFlPH1YU",
"name": "23Aug_CDMP_QE1",
"email": "jdoe@informatica.com",
"phone": "555-243-456",
"status": "ACTIVE",
"userInfo": {},
"isGroup": true
},
"modifiedOn": "2022-09-15T13:59:40.472Z"
}
The following table describes the parameters of each consumer access that is withdrawn:
Parameter
Description
id
System generated unique identifier of the consumer access.
refId
Reference identifier of the consumer access.
status
Status of the consumer access.
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.
accessGrantedOn
Date on which the Data User was granted access to the data collection.
costCenter
Cost center of the Data User that was granted access to the data collection.
order
Details of the order placed by the Data User that was granted access to the data collection.
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 > refId
Reference identifier of the order.
order > dataCollections
Details of the ordered data collection.
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.
order > id
System generated unique identifier of the order.
order > usageContext
Details of the usage type that the Data User selected at the time of order.
order > createdBy
Details of the user account that ordered the data collection.
order > createdOn
Date when the order was created.
order > modifiedBy
Details of the latest user account that modified the order.
order > modifiedOn
Latest date when the order was modified.
order > costCenter
Cost center of the Data User that ordered the data collection.
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
Status of the delivery target.
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.
dataCollection
Details of the data collection for which the Data User was granted access.
dataCollection > id
System generated unique identifier of the data collection.
dataCollection > name
Name of the data collection.
dataCollection > description
Purpose of the data collection.
dataCollection > refId
Reference identifier of the data collection.
dataCollection > category
Details of the category of the data collection.
dataCollection > usageContexts
Details of the usage type that is used to specify the certified use of the data collection.
dataCollection > dataset
Details of the data assets that the data collection contains.
dataCollection > 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.
dataCollection > dataOwners
Details of the stakeholders that are assigned the Data Owner stakeholder role on the data collection.
dataCollection > technicalOwners
Details of the stakeholders that are assigned the Technical Owner stakeholder role on the data collection.
dataCollection > createdBy
Details of the user account that created the data collection.
dataCollection > createdOn
Date when the data collection was created.
dataCollection > modifiedBy
Details of the latest user account that modified the data collection.
dataCollection > modifiedOn
Latest date when the data collection was modified.
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.
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 created the consumer access.
createdOn
Date when the consumer access was created.
modifiedBy
Details of the latest user account that modified the consumer access.
modifiedOn
Latest date when the consumer access was modified.

Delete consumer accesses

Use a REST API to delete withdrawn consumer accesses in Data Marketplace.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v1/integration/consumerAccess/<consumerAccessId>
<consumerAccessId>: Required. Enter the system generated unique identifier of the consumer access that you want to delete.
For more information about how you can use an API to get the system generated unique identifier of a consumer access, see Retrieve consumer accesses.
To get the system generated unique identifier of a consumer access from the Data Marketplace interface, open the consumer access. The consumer access page's URL contains the system generated unique identifier.
For example, in the URL https://{{CDMP_URL}}/access/e254491f-5795-49bd-be0b-385eb11d9d5a?dtn=Access~2e85, the system generated unique identifier is e254491f-5795-49bd-be0b-385eb11d9d5a.
Method
DELETE
To invoke this API, ensure your user profile is assigned the Data Marketplace Administrator role.
Alternatively, ensure that your user profile is assigned a role for which the following privileges and permissions are enabled:
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 consumer access:
https://{{CDMP_URL}}/api/v1/integration/consumerAccess/794a215f-5479-4b55-8e1b-a4866ec9fe82

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 consumer access is deleted successfully:
204 OK code