Hi, I'm Ask INFA!
What would you like to know?
ASK INFAPreview
Please to access Ask INFA.
Not Found
English

Page Not Found

The page or file you are looking for has been moved or no longer exists.

The following links might help you find the content you need:


You can also search the Documentation Portal or visit the home page.

English
  • Data Marketplace
  • All Products

Table of Contents

Search

  1. Introduction
  2. Define settings for data collections
  3. Manage Data Marketplace content
  4. Manage data collections
  5. Manage requests, orders and consumer accesses
  6. Miscellaneous APIs
  7. Frequently Asked Questions

API Reference

API Reference

Back Next

Request

Request

The following table describes the parameters that you enter in the request query:
Parameter
Description
Additional Information
search
Optional. The search term that you want to use to find a delivery method.
Ensure that the search term that you enter don't contain an asterisk (*).
ids
Optional. The system generated unique identifier of the delivery method.
To enter more than one value, use the following format:
ids=<value1>&ids=<value2>
status
Optional. Status of the delivery method.
Enter one of the following values:
  • To make the delivery method available to Delivery Owners, enter
    ACTIVE
    .
  • To make the delivery method unavailable to Delivery Owners, enter
    INACTIVE
    .
createdDateFrom
Optional. To find the delivery method created between a date range, enter the starting date.
To specify a date, use the
YYYY-MM-DD
 format. The value that you specify is converted automatically to the Coordinated Universal Time (UTC) time standard.
If you have specified a value for the
createdDateFrom
 parameter, ensure that you enter a value for the
createdDateTo
 parameter.
createdDateTo
Optional. To find the delivery method created between a date range, enter the ending date.
To specify a date, use the
YYYY-MM-DD
 format. The value that you specify is converted automatically to the Coordinated Universal Time (UTC) time standard.
If you have specified a value for the
createdDateTo
 parameter, ensure that you enter a value for the
createdDateFrom
 parameter.
modifiedDateFrom
Optional. To find the delivery method modified between a date range, enter the starting date.
To specify a date, use the
YYYY-MM-DD
 format. The value that you specify is converted automatically to the Coordinated Universal Time (UTC) time standard.
If you have specified a value for the
modifiedDateFrom
 parameter, ensure that you enter a value for the
modifiedDateTo
 parameter.
modifiedDateTo
Optional. To find the delivery method modified between a date range, enter the ending date.
To specify a date, use the
YYYY-MM-DD
 format. The value that you specify is converted automatically to the Coordinated Universal Time (UTC) time standard.
If you have specified a value for the
modifiedDateTo
 parameter, ensure that you enter a value for the
modifiedDateFrom
 parameter.
sortByField
Optional. Sort the search results by various parameters.
To sort the search results, you can enter one of the following values:
  • ID
  • NAME
  • STATUS
  • CREATED_BY
  • CREATED_ON
  • MODIFIED_BY
  • MODIFIED_ON
Default value is
MODIFIED_ON
.
sort
Optional. Set the sorting order of the search results.
Enter one of the following values:
  • 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. The starting index for the paginated results.
Default value is
0
.
limit
Optional. The maximum number of results.
Default value is
50
.
The API has no payload.
0 COMMENTS
We’d like to hear from you!