ASK INFAPreview
{ "processingTime": 4190, "offset": 0, "limit": 50, "totalCount": 1, "objects": [ { "id": "16e32a13-6fba-4f1a-a337-e0aeecf9fab4", "refId": "Target345", "name": "AWS-1", "description": "Data to be made available in a CSV file hosted on AWS, this is to be sent via FTP.", "isDefault": true, "status": "ACTIVE", "physicalLocation": "AWS", "targetSystemReference": "Axon", "deliveryTemplate": { "id": "7f280b8a-35fb-4325-ada0-2bf5654b4891", "refId": "Template345", "name": "AWS", "description": "Send an excel file via FTP", "isDefault": true, "status": "ACTIVE", "managedAccess": "DISABLED", "deliveryType": "MANUAL", "templateOwners": [ { "displayName": "John Doe", "id": "9f280b8a-35fb-4325-ada0-2bf5654b4892", "name": "username1", "email": "abc@xyz.com", "phone": "2020202023", "status": "ACTIVE", "userInfo": { "initials": "string", "avatarColor": "string", "description": "string", "title": "string", "timeZoneId": "string" } } ], "targetSystemReference": "Axon", "defaultPhysicalLocation": "AWS", "deliveryMethods": [ { "id": "5wd2a13-9fha-4f1a-b317-e0vvtcf9efe4", "refId": "Method345", "name": "FTP", "status": "ACTIVE", "createdBy": "User2", "createdOn": "2022-04-20T10:50:39.251Z", "modifiedBy": "User1", "modifiedOn": "2022-04-20T10:50:39.251Z" } ], "deliveryFormats": [ { "id": "3h32a13-9cdf-4f1a-b317-e0ttecf9def4", "refId": "Format345", "name": "XSLX", "status": "ACTIVE", "createdBy": "User2", "createdOn": "2022-04-20T10:50:39.251Z", "modifiedBy": "User1", "modifiedOn": "2022-04-20T10:50:39.251Z" } ], "createdBy": "User2", "createdOn": "2022-04-20T10:50:39.251Z", "modifiedBy": "User1", "modifiedOn": "2022-04-20T10:50:39.251Z" }, "deliveryMethod": { "id": "5wd2a13-9fha-4f1a-b317-e0vvtcf9efe4", "refId": "Method345", "name": "FTP", "status": "ACTIVE", "createdBy": "User2", "createdOn": "2022-04-20T10:50:39.251Z", "modifiedBy": "User1", "modifiedOn": "2022-04-20T10:50:39.251Z" }, "deliveryFormat": { "id": "3h32a13-9cdf-4f1a-b317-e0ttecf9def4", "refId": "Format345", "name": "XSLX", "status": "ACTIVE", "createdBy": "User2", "createdOn": "2022-04-20T10:50:39.251Z", "modifiedBy": "User1", "modifiedOn": "2022-04-20T10:50:39.251Z" }, "createdBy": "User2", "createdOn": "2022-04-20T10:50:39.251Z", "modifiedBy": "User1", "modifiedOn": "2022-04-20T10:50:39.251Z" } ] }
Parameter
| Description
|
|---|---|
processingTime | The time taken (in milliseconds) to complete the API call.
|
offset | The starting index for the paginated results.
Default value is
0 .
|
limit | The maximum number of results.
Default value is
50 .
|
totalCount | Total count of records that match the filters applied.
|
objects | This parameter contains the delivery target details.
|
objects > id | The system generated unique identifier of the delivery target.
|
objects > refId | The reference identifier of the delivery target.
|
objects > name | Name of the delivery target.
|
objects > description | Description of the delivery target.
|
objects > isDefault | This parameter displays whether the delivery target is the default delivery option for a data collection. The parameter can have one of the following values:
|
objects > status | The status of the delivery target.
|
objects > physicalLocation | The location where the data is delivered.
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
Use Data Access Management to streamline the Data Marketplace order process topic in the
Set Up Data Marketplace help.
|
objects > targetSystemReference | The system where the data is delivered.
|
objects > deliveryTemplate > id | The system generated unique identifier of the delivery template that was used to create the delivery target.
|
objects > deliveryTemplate > refId | The reference identifier of the delivery template.
|
objects > deliveryTemplate > name | Name of the delivery template.
|
objects > deliveryTemplate > description | Description of the delivery template.
|
objects > deliveryTemplate > isDefault | This parameter indicates whether or not the delivery template is set as the default delivery option for your
Data Marketplace instance. The parameter can have one of the following values:
|
objects > deliveryTemplate > status | Status of the delivery template. This parameter can have one of the following values:
|
objects > deliveryTemplate > managedAccess | This parameter determines whether a unique data location is created for each order that is fulfilled using a target that is based on this template. This parameter can have one of the following values:
For more information, see the
Use Data Access Management to streamline the Data Marketplace order process topic in the
Set Up Data Marketplace help.
|
objects > deliveryTemplate > deliveryType | The type of delivery.
|
objects > deliveryTemplate > templateOwners | Details of the Delivery Owner that is responsible for the delivery template.
|
objects > deliveryTemplate > targetSystemReference | Target system or resource reference from where the data is obtained.
|
objects > deliveryTemplate > defaultPhysicalLocation | The default delivery location.
|
objects > deliveryTemplate > deliveryMethods | Details of the delivery method of the delivery template.
|
objects > deliveryTemplate > deliveryFormats | Details of the delivery format of the delivery template.
|
objects > deliveryTemplate > createdBy | The system generated unique identifier of the user account that created the delivery template.
|
objects > deliveryTemplate > createdOn | The date when the delivery template was created.
|
objects > deliveryTemplate > modifiedBy | The system generated unique identifier of the latest user account that modified the delivery template.
|
objects > deliveryTemplate > modifiedOn | Latest date when the delivery template was modified.
|
objects > deliveryMethod > id | The system generated unique identifier of the delivery method.
|
objects > deliveryMethod > refId | The reference identifier of the delivery method.
|
objects > deliveryMethod > name | Name of the delivery method.
|
objects > deliveryMethod > status | The status of the delivery method.
|
objects > deliveryMethod > createdBy | The system generated unique identifier of the user account that created the delivery method.
|
objects > deliveryMethod > createdOn | The date when the delivery method was created.
|
objects > deliveryMethod > modifiedBy | The system generated unique identifier of the latest user account that modified the delivery method.
|
objects > deliveryMethod > modifiedOn | Latest date when the delivery method was modified.
|
objects > deliveryFormat > id | The system generated unique identifier of the delivery format.
|
objects > deliveryFormat > refId | The reference identifier of the delivery format.
|
objects > deliveryFormat > name | Name of the delivery format.
|
objects > deliveryFormat > status | The status of the delivery format.
|
objects > deliveryFormat > createdBy | The system generated unique identifier of the user account that created the delivery format.
|
objects > deliveryFormat > createdOn | The date when the delivery format was created.
|
objects > deliveryFormat > modifiedBy | The system generated unique identifier of the latest user account that modified the delivery format.
|
objects > deliveryFormat > modifiedOn | Latest date when the delivery format was modified.
|
objects > createdBy | The system generated unique identifier of the user account that created the delivery target.
|
objects > createdOn | The date when the delivery target was created.
|
objects > modifiedBy | The system generated unique identifier of the latest user account that modified the delivery target.
|
objects > modifiedOn | Latest date when the delivery target was modified.
|
