Agilityconnector v1.0 | OneTeg Documentation

Version 1.0

Connector Overview: This page documents all 10 actions for the Agilityconnector v1.0.

ContentModels

GET Returns content models for the Agility instance.

/{guid}/{apitype}/contentmodels

Return the content models available in the Agility instance, which define the structure of content types.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Guid`	The unique identifier (GUID) of the Agility instance.
`Apitype`	The API type, such as 'preview' or 'fetch', that determines the environment to query.
`Response Type`	The response format expected from the API (e.g. application/json).

Gallery

GET Gets the gallery by ID.

/{guid}/{apitype}/gallery/{id}

Retrieve details of a specific gallery by its unique identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Guid`	The instance GUID, available from the API Keys section.
`Apitype`	The Type of API - fetch or preview.
`Id`	The galleryID of the requested gallery.
`Response Type`	The response format expected from the API (e.g. application/json).

Item

GET Gets the details of a content item by ther Content ID.

/{guid}/{apitype}/{locale}/item/{id}

Get the full details of a content item using its content ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Guid`	The instance GUID, available from the API Keys section.
`Apitype`	The Type of API - fetch or preview.
`Locale`	The locale code you want to retrieve content for.
`Id`	The contentID of the requested item in this locale.
`Contentlinkdepth`	The maximum level to expand linked content from this item
`Expandallcontentlinks`	Whether or not to expand entire linked content references, includings lists and items that are rendered in the CMS as Grid or Link.
`Response Type`	The response format expected from the API (e.g. application/json).

List

GET Retrieves a list of content items by reference name.

/{guid}/{apitype}/{locale}/list/{referenceName}

Retrieve a list of content items filtered by a reference name.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Guid`	The instance GUID, available from the API Keys section.
`Apitype`	The Type of API - fetch or preview.
`Locale`	The locale code you want to retrieve content for.
`Referencename`	The unique reference name of the content list you wish to retrieve in the current locale. Reference names must be ALL lowercase.
`Fields`	[Optional] A comma separated list of the fields to return.
`Take`	[Optional] The maximum number of items to retrieve in this request. Default is 10. Maximum allowed is 250.
`Skip`	[Optional] The number of items to skip from the list. Default is 0. Used for implementing pagination.
`Filter`	[Optional] The filter you wish to apply to the list query. Supports [eq (Equal To), ne (Not Equal), lt (Less Than), lte (Less Than or Equal), gt (Greater Than), gte (Greater Than or Equal)]. Example value: fields.title[eq]"some title" or fields.details[like]"some text"
`Sort`	[Optional] The field to sort the results by. Example fields.title or properties.created, seo.metaDescription
`Direction`	[Optional] The direction to sort the results by. Default is asc. Valid values are asc, desc.
`Contentlinkdepth`	[Optional] The depth of list items. Maximum allowed is 5.
`Expandallcontentlinks`	[Optional] Whether or not to expand entire linked content references, includings lists and items that are rendered in the CMS as Grid or Link.
`Response Type`	The response format expected from the API (e.g. application/json).

Page

GET Gets the details of a page by its Page ID.

/{guid}/{apitype}/{locale}/page/{id}

Get the details of a specific page by its page ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Guid`	The instance GUID, available from the API Keys section.
`Apitype`	The Type of API - fetch or preview.
`Locale`	The locale code you want to retrieve content for.
`Id`	The unique page ID of the page you wish to retrieve in the current locale.
`Contentlinkdepth`	The maximum level to expand linked content from this item
`Expandallcontentlinks`	Whether or not to expand entire linked content references, includings lists and items that are rendered in the CMS as Grid or Link and linked to modules or linked items on this page.
`Response Type`	The response format expected from the API (e.g. application/json).

Sitemap (2)

GET Gets the sitemap as an array in a nested format, ideal for generating menus.

/{guid}/{apitype}/{locale}/sitemap/nested/{channelName}

Retrieve the sitemap in a nested hierarchical format, suitable for building menus.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Guid`	The instance GUID, available from the API Keys section.
`Apitype`	The Type of API - fetch or preview.
`Locale`	The locale code you want to retreive content for
`Channelname`	The reference name of the digital channel of the sitemap to return. If you only have one channel, your channel reference name is likely 'website'.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Gets the sitemap, returned in a flat list, where the dictionary key is the page path. This method is ideal for page routing.

/{guid}/{apitype}/{locale}/sitemap/flat/{channelName}

Retrieve the sitemap as a flat list keyed by page path, useful for page routing.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Guid`	The instance GUID, available from the API Keys section.
`Apitype`	The Type of API - fetch or preview.
`Locale`	The locale code you want to retreive content for
`Channelname`	The reference name of the digital channel of the sitemap to return. If you only have one channel, your channel reference name is likely 'website'.
`Response Type`	The response format expected from the API (e.g. application/json).

Sync (2)

GET Retrieves all content items in a paged format. Each call returns a sync token that should be persisted and passed into subsequent requests to maintain sync state.

/{guid}/{apitype}/{locale}/sync/items

Retrieve all content items in a paginated format, returning a sync token to persist for subsequent incremental sync requests.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Guid`	The instance GUID, available from the API Keys section.
`Apitype`	The Type of API - fetch or preview.
`Locale`	The locale code you want to sync content items for.
`Synctoken`	The token from the most recently synced value.
`Pagesize`	The number of items to return per set.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Retrieves all pages items in a paged format. Each call returns a sync token that should be persisted and passed into subsequent requests to maintain sync state.

/{guid}/{apitype}/{locale}/sync/pages

Retrieve all pages in a paginated format, returning a sync token to persist for subsequent incremental sync requests.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Guid`	The instance GUID, available from the API Keys section.
`Apitype`	The Type of API - fetch or preview.
`Locale`	The locale code you want to sync pages for.
`Synctoken`	The token from the most recently synced value.
`Pagesize`	The number of items to return per set.
`Response Type`	The response format expected from the API (e.g. application/json).

UrlRedirection

GET Gets the list of all URL Redirections since a particular date/time. Persist the lastAccessDate that is returned and use that value to maintain state on subsequent requests.

/{guid}/{apitype}/urlredirection

Get all URL redirections that have been modified since a given date and time, persisting the returned lastAccessDate for incremental updates.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Guid`	The instance GUID, available from the API Keys section.
`Apitype`	The Type of API - fetch or preview.
`Lastaccessdate`	The last access date/time that the URL Redirections list was previously accessed, eg: 2020-09-24T10:00:00.00-04:00.
`Response Type`	The response format expected from the API (e.g. application/json).