| Parameter |
Purpose |
OpenAPI Example |
GraphQL Example |
Example Response |
| fields |
Reduces the amount of information included in each returned item – only the indicated fields are included. |
curl --user [email protected]:test 'example.com/o/headless-admin-user/v1.0/organizations?fields=id,name,organizationContactInformation.emailAddresses'
|
[N/A: Fields are always specified in GraphQL]
query {
organizations {
actions
items {
id
name
organizationContactInformation {
emailAddresses {
emailAddress
id
primary
type
}
}
}
lastPage
page
pageSize
totalCount
}
}
|
{
"actions" : {
...
},
"items" : [ {
"id" : "35562",
"name" : "The Earth",
"organizationContactInformation" : {
"emailAddresses" : [ ]
}
} ],
"lastPage" : 1,
"page" : 1,
"pageSize" : 20,
"totalCount" : 1
}
|
| filter |
Reduces the number of items returned, by faceted search. |
curl --user [email protected]:test 'example.com/o/headless-admin-user/v1.0/organizations?fields=id,name&flatten=true&filter=contains(name,%27America%27)'
|
query {
organizations (flatten: true, filter: "contains(name, 'America')") {
actions
items {
id
name
}
lastPage
page
pageSize
totalCount
}
}
|
{
"actions" : {
...
},
"items" : [ {
"id" : "35575",
"name" : "The United States of America"
}, {
"id" : "35567",
"name" : "North America"
} ],
"lastPage" : 1,
"page" : 1,
"pageSize" : 20,
"totalCount" : 2
}
|
| flatten |
Allows retrieving items outside of their hierarchical structure. |
curl --user [email protected]:test 'example.com/o/headless-admin-user/v1.0/organizations?fields=id,name&flatten=true'
|
query {
organizations (flatten: true) {
actions
items {
id
name
}
lastPage
page
pageSize
totalCount
}
}
|
{
"actions" : {
...
},
"items" : [ {
"id" : "35575",
"name" : "The United States of America"
}, {
"id" : "35579",
"name" : "Canada"
}, {
"id" : "35583",
"name" : "Germany"
}, {
"id" : "35567",
"name" : "North America"
}, {
"id" : "35571",
"name" : "Europe"
}, {
"id" : "35562",
"name" : "The Earth"
}, {
"id" : "35587",
"name" : "France"
} ],
"lastPage" : 1,
"page" : 1,
"pageSize" : 20,
"totalCount" : 7
}
|
| page |
Selects which subset of items should be returned, by page number (i.e. selects items pageSize * page + 1 to pageSize * page + page). |
curl --user [email protected]:test 'example.com/o/headless-admin-user/v1.0/organizations?fields=id,name&flatten=true&page=2&pageSize=5'
|
query {
organizations (flatten: true, page: 2, pageSize: 5) {
actions
items {
id
name
}
lastPage
page
pageSize
totalCount
}
}
|
{
"actions" : {
...
},
"items" : [ {
"id" : "35562",
"name" : "The Earth"
}, {
"id" : "35587",
"name" : "France"
} ],
"lastPage" : 2,
"page" : 2,
"pageSize" : 5,
"totalCount" : 7
}
|
| pageSize |
Selects how many items should be returned in a single response. |
curl --user [email protected]:test 'example.com/o/headless-admin-user/v1.0/organizations?fields=id,name&flatten=true&pageSize=5'
|
query {
organizations (flatten: true, pageSize: 5) {
actions
items {
id
name
}
lastPage
page
pageSize
totalCount
}
}
|
{
"actions" : {
...
},
"items" : [ {
"id" : "35575",
"name" : "The United States of America"
}, {
"id" : "35579",
"name" : "Canada"
}, {
"id" : "35583",
"name" : "Germany"
}, {
"id" : "35567",
"name" : "North America"
}, {
"id" : "35571",
"name" : "Europe"
} ],
"lastPage" : 2,
"page" : 1,
"pageSize" : 5,
"totalCount" : 7
}
|
| search |
Reduces the number of items returned, by simple keyword search. |
curl --user [email protected]:test 'example.com/o/headless-admin-user/v1.0/organizations?fields=id,name&flatten=true&search=America'
|
query {
organizations (flatten: true, search: "America") {
actions
items {
id
name
}
lastPage
page
pageSize
totalCount
}
}
|
{
"actions" : {
...
},
"items" : [ {
"id" : "35575",
"name" : "The United States of America"
}, {
"id" : "35567",
"name" : "North America"
} ],
"lastPage" : 1,
"page" : 1,
"pageSize" : 20,
"totalCount" : 2
}
|
| sort |
Modifies the order in which items are returned (and, if > pageSize items exist, which items are returned in a given page). |
curl --user [email protected]:test 'example.com/o/headless-admin-user/v1.0/organizations?fields=id,name&flatten=true&sort=name:asc'
|
query {
organizations (flatten: true, sort: "name:asc") {
actions
items {
id
name
}
lastPage
page
pageSize
totalCount
}
}
|
{
"actions" : {
...
},
"items" : [ {
"id" : "35579",
"name" : "Canada"
}, {
"id" : "35571",
"name" : "Europe"
}, {
"id" : "35587",
"name" : "France"
}, {
"id" : "35583",
"name" : "Germany"
}, {
"id" : "35567",
"name" : "North America"
}, {
"id" : "35562",
"name" : "The Earth"
}, {
"id" : "35575",
"name" : "The United States of America"
} ],
"lastPage" : 1,
"page" : 1,
"pageSize" : 20,
"totalCount" : 7
}
|
Technical Documentation
Minor
LRDOCS-8382 Reference doc for available Headless parameters