Get schemas along with its custom fields

get

{protocol}://{base-url}/integration/v2/schema/

This API allows fetching of multiple schemas along with its custom fields.

Query Params

integer

filter by id of the object

name

string

filter by object name

ds_id

integer

Unique identifier of the data source

order_by

string

enum

Ordering of objects by id and name

Allowed:

custom_fields

array of objects

filter objects by custom fields. Currently we can only filter by a single custom field. The example below shows only {}, please add array braces [] around the {} object for it work properly. eg: To list objects which have user id 1 as a steward is [{"field_id":8,"value":[{"otype": "user", "oid":1}]}]. Note: Use the appropritate data structure for the value.

custom_fields

limit

integer

Defaults to 100

Specifies the number of objects to be fetched in one paginated request. Response may have a X-Next-Page URL parameter in the header to fetch next set of objects or page

skip

integer

Defaults to 0

Specifies the number of objects to be skipped in one request. Used together with Limit parameter to fetch paginated requests. This is automatically set in X-Next-Page response header if present

values

string

Specifies a comma-separated list of fields to be included in the response. When provided, the API will return only the specified set of fields for each object in the response. If not supplied, the API will return all fields by default.

fields

string

id__gt

integer

filter by id greater than a value

id__gte

integer

filter by id greater than or equal to a value

id__lt

integer

filter by id lesser than a value

id__lte

integer

filter by id lesser than or equal to a value

name__contains

string

filter by object name containing the given string

name__startswith

string

filter by object name starting with the given string

name__endswith

string

filter by object name ending with the given string

ds_id__gt

integer

filter by data source id greater than a value

ds_id__gte

integer

filter by data source id greater than or equal to a value

ds_id__lt

integer

filter by data source id lesser than a value

ds_id__lte

integer

filter by data source id lesser than or equal to a value

Responses

Language

Credentials

Header

URL

Loading…

Response

Choose an example:

application/json

200List of schemas matching the filters.

400Malformed Request

401Unauthorized bad/missing token

403Forbidden User cannot edit this resource

404The specified resource was not found

413Request Too Large

414Request URL Too Long

429Too many requests

500Internal Server Error