Fetch resources
GET {{baseUrl}}/api/v1/resources/:domain?advancedFilter=occaecat dolor aute dolore&count=1000&expand=occaecat dolor aute dolore&fetchCategories=false&fetchDomains=false&fetchPermissions=false&fetchVariants=false&filter=occaecat dolor aute dolore&offset=0&sort=occaecat dolor aute dolore
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
advancedFilter | string | ||
count | number | For pagination, the number of entities per page | |
expand | string | expand | |
fetchCategories | boolean | fetchCategories | |
fetchDomains | boolean | fetchDomains | |
fetchPermissions | boolean | fetchPermissions | |
fetchVariants | boolean | fetchVariants | |
filter | string | The filter value is a semicolon delimited list of key value pairs. For example: | |
| name:Example;states:DRAFT,APPROVED;searchString:*ample | |||
| List values separate possible values with commas. Keys include: | |||
| filter name | Filter value description | ||
| ----------------------- | ------------------------------------------------------------------------------------------------- | ||
| description | Match resources with this description. | ||
| excludedTypes | Match resources whose types do not appear in this comma-separated list. | ||
| variableIsArray | Matches resources against this value. | ||
| variableType | Match resources whose variableType is one of these specified. | ||
| ids | Match resources with ids in this comma-separated list. | ||
| excludedIds | Match resources with ids that are NOT in this comma-separated list. | ||
| parentId | Exclude this resource and others directly linked to it. Only usable in the resources API. | ||
| parentVersion | For use with parentId. Must use both. | ||
| name | Match resources with this name. | ||
| overrideIds | When matching by states, do not apply the states filter to resources with ids in this list. | ||
| overrideStates | When matching by states, apply this states filter to resources with ids in the overrideIds list. | ||
| resourcePackId | Match resources with this resource pack id. | ||
| searchString | Match resources with names or descriptions matching this string. Use a * as a wildcard. | ||
| caseSensitive | Specify if searches (name, description, searchString) are case sensitive or not. | ||
| wholeWord | Specify if searches (name, description, searchString) match whole word or not. | ||
| createdBy | Match resources created by this user. | ||
| lastModifiedBy | Match resources last modified by this user. | ||
| createdDateStart | Match resources created on or after this date. (yyyy-MM-dd format). | ||
| createdDateEnd | Match resources created before this date. (yyyy-MM-dd format). | ||
| lastModifiedDateStart | Match resources last modified on or after this date. (yyyy-MM-dd format). | ||
| lastModifiedDateEnd | Match resources last modified before this date. (yyyy-MM-dd format). | ||
| states | Match resources with states in this list. States include: DRAFT,REVIEW,APPROVED,REJECTED | ||
| latestVersion | Set to false to fetch all versions of resources matching the rest of this filter. Only usable in the resources API. | ||
| types | Match resources with types in this list. Types include: resourcepack, exstrapplication, exstrdocument, exstrpage, exstrcomponentobj, exstremail, exstrengine, exstrvariablebase, exstrpackage, exstrgraphicalmessage, exstrtextmessage, exstrparagraph, exstrparagraphsection, image, samplefile, exstrdatasource, exstrhtml5, versionedtemplate, documentdefinition, enginerundef, font, fontdefinition, exstrbarcode, exstrpapertype, exstrmessagetype, exstrmetadata, exstrcommunicationset, exstroutputqueue, exstroutput, exstrmigrationset, exstrmessaging | ||
| systemResource | Match resources that are (or are not) system resources. | ||
| hasApprovedVersion | Match resources where a previously approved version of the resources exist. | ||
| hidden | Match resources that are (or are not) hidden. | ||
| includeVariants | Set to true to include variants in the response. By default they are excluded unless standardVariantId is specified. | ||
| standardVariantId | Match resources that are variants of this specified one. Can not be used when includeVariants is explicitly false. | ||
| categories | Match resources that are contain at least one of the categories from this list. | ||
offset | number | For pagination, fetch entities after this many | |
sort | string | Comma separated list of {asc |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"categories":[{"createdBy":"do ut est","createdDate":"1958-10-20T00:57:09.986Z","id":"5357212f-8044-5823-949c-db97e0e8e795","lastModifiedBy":"occaecat","lastModifiedDate":"1943-11-02T00:27:11.412Z","name":"commodo labore sint elit"},{"createdBy":"quis dolore Excepteur","createdDate":"1960-09-11T20:40:58.135Z","id":"urn:uuid:ebb986ec-aa60-0853-0f07-5b9353bc693e","lastModifiedBy":"culpa laboris","lastModifiedDate":"1970-03-10T23:56:16.348Z","name":"magna in"}],"containsActiveRevisions":false,"content":{},"contentMimeType":"adipisicing proident tempor","contentType":"aliquip sed enim","createdBy":"volu","createdDate":"1991-08-15T15:59:38.348Z","description":"ullamco consequat consectetur","domains":[{"description":"sunt ea","id":"non mollit consequ","production":false},{"description":"nostrud ad","id":"minim sed","production":false}],"effectiveEnd":"2019-05-06T20:11:42.799Z","effectiveStart":"1995-11-07T16:12:56.427Z","hidden":false,"id":"urn:uuid:1e05fe52-1a0d-50c2-e20e-13be3598b6ec","isTrackingRevisions":false,"lastModifiedBy":"consequat amet consectetur","lastModifiedDate":"1961-08-29T02:43:30.587Z","latestVersion":false,"locked":false,"lockedBy":"sint in proident","metadata":{"dataSourceEligible":"deserunt qui","defaultSampleFileId":"24c4427f-79b6-bc34-210c-cab616eb653b","dialogueEncoding":"in quis","dialogueSerialization":"Ut mollit","dialogueVersion":"ipsum esse veniam","displayName":"","hasContentAuthorFrames":false,"originalSource":"elit tempor quis adipisicing","resourceTemplate":"Duis officia amet in","selectionVariable":"dolor velit Ut amet consectetur","subtype":"","userFriendlyName":"ut do commod","usesDesignPack":"minim","variableIsArray":"ad do anim nulla","variableType":"pariatur proident et occaecat"},"name":"ipsum mollit dolore nisi voluptate","permissions":["velit commodo fugiat","culpa dolor consequat occaecat minim"],"resourcePackId":"urn:uuid:01e19e98-4a17-dff8-cc14-0392441d51f6","standardVariantId":"0efbf3bc-7b48-107c-9b6c-45ad77dbf3f1","state":"APPROVED","stateComment":"officia","systemResource":false,"type":"exstrapplication","variants":[{"value":"\u003cCircular reference to #/components/schemas/ResourceVersion detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/ResourceVersion detected\u003e"}],"version":-10867652},{"categories":[{"createdBy":"cillum Excepteur tempor","createdDate":"2022-09-14T04:49:14.254Z","id":"93a7a768-cec5-ad54-7110-32abf13a4364","lastModifiedBy":"pariatur minim","lastModifiedDate":"1958-03-11T12:27:09.144Z","name":"ut est magna officia amet"},{"createdBy":"dolor proident pariatur","createdDate":"1982-02-14T07:14:24.812Z","id":"urn:uuid:8b19dbae-94e2-a2ab-51a9-8aafc8c36012","lastModifiedBy":"Excepteur ipsum est","lastModifiedDate":"1983-11-06T04:42:53.876Z","name":"cillum Excepteur"}],"containsActiveRevisions":true,"content":{},"contentMimeType":"dolor proident","contentType":"consequat Ut in","createdBy":"in in inc","createdDate":"2014-08-18T06:23:45.224Z","description":"id amet esse","domains":[{"description":"ut aliquip reprehenderit enim","id":"incididunt nostrud","production":true},{"description":"veniam cillum","id":"officia sint ullamco","production":false}],"effectiveEnd":"1965-12-09T21:31:51.917Z","effectiveStart":"1977-02-20T13:31:36.775Z","hidden":true,"id":"urn:uuid:f9763fbb-204f-94b2-2f9e-51ec53780d5b","isTrackingRevisions":true,"lastModifiedBy":"nisi elit id nostrud pariatur","lastModifiedDate":"2004-04-14T04:49:24.324Z","latestVersion":false,"locked":true,"lockedBy":"Ut ut","metadata":{"dataSourceEligible":"sit ut","defaultSampleFileId":"8d3795e2-702a-0413-c2f3-122e4cb9a351","dialogueEncoding":"incididunt commodo dolore consectetur","dialogueSerialization":"mollit minim cillum pr","dialogueVersion":"ut ","displayName":"aliquip et","hasContentAuthorFrames":true,"originalSource":"sunt in dolore","resourceTemplate":"ea velit eiusmod et","selectionVariable":"esse reprehenderit eu","subtype":"pariatur veniam in","userFriendlyName":"adipisicing magna reprehenderit ullamco","usesDesignPack":"Lorem qui adipisicing","variableIsArray":"sit est nulla Excepteur","variableType":"labore dolore elit"},"name":"Excepteur consectetur","permissions":["reprehenderit in est","minim irure nisi proident"],"resourcePackId":"a346e592-8f49-c07d-a14e-19226f6df274","standardVariantId":"urn:uuid:359a63a0-9453-a56c-bf07-29a8be6e96e7","state":"APPROVED","stateComment":"consequat ","systemResource":false,"type":"exstrparagraph","variants":[{"value":"\u003cCircular reference to #/components/schemas/ResourceVersion detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/ResourceVersion detected\u003e"}],"version":42058112}],"page":{"currentPageNumber":-4988065,"pageOffset":-5857999,"pageSize":28773670,"totalElements":25680998,"totalPages":-87055475},"status":"sint consequat ipsum adipisicing Lorem"}