v1

latestOpenAPI 3.0.12026-07-2466310316.3 KB

Structure Links

List Structure Links

get/api/v1/structure_links

Query parameters

extra_fields[structure_links]StructureLinksExtraFields[]

Structure Link extra fields list

Include fields that are not always needed, or perhaps computationally expensive

includestring[]

Structure Link relationships available for inclusion

Include related resources

fields[structure_links]StructureLinksReadableAttribute[]

Structure Link readable attributes list

Include only specified fields of Structure Link in response

fields[locations]LocationsReadableAttribute[]

Location readable attributes list

Include only specified fields of Location in response

fields[departments]DepartmentsReadableAttribute[]

Department readable attributes list

Include only specified fields of Department in response

fields[divisions]DivisionsReadableAttribute[]

Division readable attributes list

Include only specified fields of Division in response

fields[structure_custom_group_ones]StructureCustomGroupOnesReadableAttribute[]

Structure Custom Group One readable attributes list

Include only specified fields of Structure Custom Group One in response

filter[division_id]string

Division id filter

Filter records by Division id

filter[location_id]string

Location id filter

Filter records by Location id

filter[department_id]string

Department id filter

Filter records by Department id

filter[structure_custom_group_one_id]string

Structure custom group one id filter

Filter records by Structure custom group one id

sortstring[]

Structure Link sortable attributes

Sort records according to one or more criteria

You should not include both ascending id and descending -id fields the same time

page[number]integer

Example:1

The page number of records to return

page[size]integer

The number of records to return

stats[total]'count'

Example:count

Include the total number of matched records within the meta key of the response object.

Response

OK: Structure Links collection