API Reference

Back Next

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 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 unique identifier of a consumer access, see Retrieve consumer accesses. To get the unique identifier of a consumer access from the Data Marketplace interface, open the consumer access. The consumer access page's URL contains the unique identifier. For example, in the URL https://{{CDMP_URL}}/access/e254491f-5795-49bd-be0b-385eb11d9d5a?dtn=Access~2e85 , the unique identifier is e254491f-5795-49bd-be0b-385eb11d9d5a .
Method	PUT

Property

Description

Endpoint

/api/v1/integration/consumerAccess/<consumerAccessId>/available

: Required. Enter the 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 unique identifier of a consumer access, see Retrieve consumer accesses.

To get the unique identifier of a consumer access from the

Data Marketplace

interface, open the consumer access. The consumer access page's URL contains the unique identifier.

For example, in the URL

https://{{CDMP_URL}}/access/e254491f-5795-49bd-be0b-385eb11d9d5a?dtn=Access~2e85

, the unique identifier is

e254491f-5795-49bd-be0b-385eb11d9d5a

Method

PUT

You can call a maximum of 100 APIs per minute.

Watch

Comments

0 COMMENTS

We’d like to hear from you! Log in to comment.