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

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

Request

Request

The following table describes the parameters that you enter in the request query:
Parameter
Description
Additional Information
ids
Optional. The system generated unique identifier of a cost center.
To enter more than one value, use the following format:
ids=<value1>&ids=<value2>
search
Optional. The search term that you want to use to find a cost center.
Ensure that the search term that you enter don't contain an asterisk (*).
fields
Optional. Enter the fields on which the search term applies. The terms that you entered in the
search
field parameter are used to search the fields that you specify here.
Enter the following values:
  • NAME
  • DESCRIPTION
createdDateFrom
Optional. To find cost centers that were created between a date range, enter the initial date when the cost center 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 cost centers that were created between a date range, enter the latest date when the cost center 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 cost centers that were modified between a date range, enter the initial date when the cost center 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 cost centers that were modified between a date range, enter the latest date when the cost center 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.
sortByField
Optional. Sort the search results by various parameters.
To sort the search results, you can enter one of the following values:
  • NAME
  • ID
  • 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!