Browse indexed lexicons whose NSID begins with a segment-aligned prefix. Segment-aligned means 'community.lexicon' matches 'community.lexicon.foo' but not 'community.lexiconfoo'. Results are sorted by NSID ascending.
Parameters
cursor
string
Optional
Opaque pagination cursor from a prior response.
lexiconType
string
Optional
Filter by lexicon definition type. Omit to include all types.
limit
integer
Optional
No description available.
prefix
string
nsid
Required
NSID prefix, one or more dot-separated segments. Matches are segment-aligned.
Output
application/jsoncursor
string
Optional
No description available.
lexicons
array
Required
No description available.
Errors
InvalidPrefix
Prefix is not a valid NSID segment sequence. InvalidCursor
Cursor is malformed or does not decode. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"type": "query",
"errors": [
{
"name": "InvalidPrefix",
"description": "Prefix is not a valid NSID segment sequence."
},
{
"name": "InvalidCursor",
"description": "Cursor is malformed or does not decode."
}
],
"output": {
"schema": {
"type": "object",
"required": [
"lexicons"
],
"properties": {
"cursor": {
"type": "string",
"maxLength": 1024
},
"lexicons": {
"type": "array",
"items": {
"type": "string",
"format": "nsid"
}
}
}
},
"encoding": "application/json"
},
"parameters": {
"type": "params",
"required": [
"prefix"
],
"properties": {
"limit": {
"type": "integer",
"default": 50,
"maximum": 100,
"minimum": 1
},
"cursor": {
"type": "string",
"maxLength": 1024,
"description": "Opaque pagination cursor from a prior response."
},
"prefix": {
"type": "string",
"format": "nsid",
"description": "NSID prefix, one or more dot-separated segments. Matches are segment-aligned."
},
"lexiconType": {
"type": "string",
"maxLength": 32,
"description": "Filter by lexicon definition type. Omit to include all types.",
"knownValues": [
"record",
"query",
"procedure",
"subscription",
"permission-set"
]
}
}
},
"description": "Browse indexed lexicons whose NSID begins with a segment-aligned prefix. Segment-aligned means 'community.lexicon' matches 'community.lexicon.foo' but not 'community.lexiconfoo'. Results are sorted by NSID ascending."
}