Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - CustomTrackedField

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

CustomTrackedField

Use the Custom Tracked Field object to describe the custom tracked fields configured for a specific account.

Note: The fields in the Custom Tracked Field object correspond to the fields on the Document Tracking tab of the Setup page.

Required Privileges

Write access

  • N/A

Read access

  • API — Use the Boomi Platform API to access account data.

Queries for a CustomTrackedField object(s)

For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging.

Note: This operation doesn't accept filters because the list is constrained to 20 fields.

Authorizations:
basicAuth
Request Body schema:
optional
required
object
required
CustomTrackedFieldSimpleExpression (object) or CustomTrackedFieldGroupingExpression (object) (CustomTrackedFieldExpression)
One of
operator
required
string
Enum: "EQUALS" "LIKE" "NOT_EQUALS" "IS_NULL" "IS_NOT_NULL" "BETWEEN" "GREATER_THAN" "GREATER_THAN_OR_EQUAL" "LESS_THAN" "LESS_THAN_OR_EQUAL" "CONTAINS" "NOT_CONTAINS"
property
required
string
argument
Array of strings

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (CustomTrackedField)

Request samples

Content type
{
  • "QueryFilter": {
    • "expression": {
      }
    }
}

Response samples

Content type
{
  • "numberOfResults": 5,
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      }
    ]
}

Retrieves additional results for a CustomTrackedField query

To learn about using queryMore, refer to the topic Query paging.

Authorizations:
basicAuth
Request Body schema: text/plain
required
string

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (CustomTrackedField)

Response samples

Content type
{
  • "numberOfResults": 5,
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      }
    ]
}