Fetch links to/from a resource
GET {{baseUrl}}/api/v1/links/:domain?count=1000&effectiveDate=1966-04-20T10:38:01.144Z&filter=occaecat dolor aute dolore&linkDepth=1000&linkObjectId=5e63ea26-a881-d203-a82a-439b83f063af&linkSubjectId=5e63ea26-a881-d203-a82a-439b83f063af&linkSubjectVersion=28520183&offset=0&rfilter=occaecat dolor aute dolore&sort=occaecat dolor aute dolore&tfilter=occaecat dolor aute dolore&useEffectiveDate=false&vfilter=occaecat dolor aute dolore
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
count | number | For pagination, the number of entities per page | |
effectiveDate | string | ||
filter | string | A simple filter that can be used in place of the complex filters. If the query asks for the latest version (which is the default), this filter's domains, types, states, and override ids are applied when determining the latest version. All other attributes of this filter are applied when building the link tree. | |
| 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. | ||
linkDepth | number | Optionally specify the maximum depth for a recursive traversal of a link tree. | |
linkObjectId | string | ||
linkSubjectId | string | ||
linkSubjectVersion | number | ||
offset | number | For pagination, fetch entities after this many | |
rfilter | string | The query will use this value to filter resources after it has determined latest versions and traversed the link tree. | |
| This stepwise filter can be combined with the other stepwise filters. It cannot be combined with the simple filter parameter. | |||
| See filter for details of this filter's possible values. | |||
sort | string | Comma separated list of {asc | |
tfilter | string | The query will use this value to filter resources as the query traverses the link tree. | |
| This stepwise filter can be combined with the other stepwise filters. It cannot be combined with the simple filter parameter. | |||
| See filter for details of this filter's possible values. | |||
useEffectiveDate | boolean | ||
vfilter | string | The query will use this value to filter resources as the query determines latest versions. | |
| This stepwise filter can be combined with the other stepwise filters. It cannot be combined with the simple filter parameter. | |||
| See filter for details of this filter's possible values. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"linkObjectId":"a3e3d998-e592-7ea8-4767-9b42fa03eb7d","linkSubjectId":"urn:uuid:f222a960-1838-fc54-05bd-eeb369723fb3","subjectVersion":93278236},{"linkObjectId":"37b9dc95-12a2-e56b-8b8d-f80a71497a5f","linkSubjectId":"urn:uuid:791898b6-7d4b-76f9-b55b-973d0cbef4d4","subjectVersion":-89655327}],"page":{"currentPageNumber":10454811,"pageOffset":6414596,"pageSize":-6407426,"totalElements":-38052048,"totalPages":61824901},"status":"nulla sed Duis"}