Inriverconnector v1.0 | OneTeg Documentation

Version 1.0

Connector Overview: This page documents all 85 actions for the Inriverconnector v1.0.

Channel (8)

GET Channel path content

/api/v1.0.0/channels/content/{path}

Use the entity list to directly query data. Use the paths in the content array to traverse the channel structure.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Path`	The hierarchical path to the channel content, provided as a string.
`Entitytypeids`	optional, filter types using comma separated list
`Response Type`	The response format expected from the API (e.g. application/json).

GET Channel structure list

/api/v1.0.0/channels/{channelId}/nodes

Retrieve a flat list of nodes within a channel's structure. Use this to get all nodes under a given channel.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Channelid`	The numeric identifier of the channel whose nodes are to be listed.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Channel structure tree

/api/v1.0.0/channels/{channelId}/nodetree

Retrieve the hierarchical tree structure of nodes within a channel. Use this to see the nested organization of a channel.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Channelid`	The numeric identifier of the channel whose node tree is to be retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get a list of entities in a channel

/api/v1.0.0/channels/{channelId}/entitylist

Retrieve a list of entities that are assigned to a specific channel. Use this to see which entities belong to a channel.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Channelid`	The numeric identifier of the channel for which to list entities.
`Entitytypeid`	optional, filter by entity type id
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get channel id's for entity id

/api/v1.0.0/channels

Retrieve the channel identifiers associated with a specific entity. Use this to find which channels an entity belongs to.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Forentityid`	optional
`Includechannels`	optional, defaults to true
`Includepublications`	optional, defaults to false
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get entity links

/api/v1.0.0/channels/{channelId}/entities/{entityId}/links

Retrieve the links associated with a specific entity within a channel. Use this to get link information for an entity in a channel context.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Channelid`	The numeric identifier of the channel containing the entity.
`Entityid`	The numeric identifier of the entity whose links are to be retrieved.
`Linkdirection`	"inbound" or "outbound"
`Linktypeid`	optional, filter by link type
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get entity types for channel

/api/v1.0.0/channels/{channelId}/entitytypes

Retrieve the entity types that are available in a specific channel. Use this to see which types of entities can be placed in the channel.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Channelid`	The numeric identifier of the channel for which to retrieve entity types.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get structure entities for entity

/api/v1.0.0/channels/{channelId}/entities/{entityId}/structureentities

Returns all occurances of an entity in a channel

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Channelid`	The numeric identifier of the channel.
`Entityid`	The numeric identifier of the entity for which to retrieve structure entities.
`Response Type`	The response format expected from the API (e.g. application/json).

Entity (30)

POST Add Media From Url

/api/v1.0.0/entities/{entityId}/media:uploadfromurl

Enter entityId for the entity you want to link the created resource entity to.

Example: You want to create a resource and then link it to a Product. You add the entityId for the product entity that you would like to link the resource entity to.

Note: If overrideUrlFileName is omitted, the filename will equal the one supplied in the url. Set overrideUrlFileName to specifiy a file name.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity to which the media will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Url`	The URL from which the media file should be downloaded.
`Overrideurlfilename`	An optional string to override the filename derived from the URL.

POST Add Media Upload Base64

/api/v1.0.0/entities/{entityId}/media:uploadbase64

Upload base64 encoded file data.

Enter entityId for the entity you want to link the created resource entity to.

Example: You want to create a resource and then link it to a Product. You add the entityId for the product entity that you would like to link the resource entity to.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity to which the media will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Filename`	The desired filename for the uploaded media.
`Data`	The base64-encoded data of the media file.

POST Add external media url

/api/v1.0.0/entities/{entityId}/media:addexternalurl

Enter entityId for the entity you want to link the created resource entity to.

Example:

You want to create a resource and then link it to a Product. You add the entityId for the product entity that you would like to link the resource entity to.

Original external file URL that is added with this REST endpoint

https://yourexternalresourceservice.com/imagename.jpg

Your external image service then need to support the standard inRiver image configuration formats(Original, Preview, Thumbnail and SmallThumbnail) as a suffix on the URL that you uploaded or have a proxy that redirect to the right image format, else the inRiver web portal will not work correct.

https://yourexternalresourceservice.com/imagename.jpg/Original

https://yourexternalresourceservice.com/imagename.jpg/Preview

https://yourexternalresourceservice.com/imagename.jpg/Thumbnail

https://yourexternalresourceservice.com/imagename.jpg/SmallThumbnail

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity to which the external media URL will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Url`	The external URL of the media.
`Overrideurlfilename`	An optional string to override the filename derived from the URL.

POST Create a new entity

/api/v1.0.0/entities:createnew

If segmentId is omitted in a multi segment environment, the entity will be created in a segment the user has access to. It's recommended to omit segmentId at all times if the enviroment doesn't have multiple segments.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Entitytypeid`	The string identifier of the entity type for the new entity.
`Fieldsetid`	The string identifier of the field set to assign to the new entity.
`Segmentid`	The numeric identifier of the segment to assign to the new entity.

DELETE Delete an entity

/api/v1.0.0/entities/{entityId}

Permanently delete an entity by its identifier. Use this to remove an entity from the system.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete entity comment

/api/v1.0.0/entities/{entityId}/comments/{commentId}

Delete a specific comment from an entity. Use this to remove a comment that is no longer needed.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity that owns the comment.
`Commentid`	The numeric identifier of the comment to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Entity comments

/api/v1.0.0/entities/{entityId}/comments

Retrieve all comments associated with an entity. Use this to view the discussion or notes on an entity.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity whose comments are to be retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Field value revisions

/api/v1.0.0/entities/{entityId}/fieldvalues/{fieldTypeId}/revisions

Retrieve the revision history of a specific field value for an entity. Use this to see changes over time for a field.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity.
`Fieldtypeid`	The string identifier of the field type whose revisions are to be retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get All Segments

/api/v1.0.0/entities/segments

Retrieve all segments available in the system. Use this to list the segments that can be assigned to entities.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get list of starred entities

/api/v1.0.0/entities/starred

Retrieve a list of entities that have been starred or marked as favorites. Use this to get the current user's starred entities.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Post entity comment

/api/v1.0.0/entities/{entityId}/comments

Add a comment to an entity. Use this to post a note or discussion entry for an entity.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity to which the comment will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Id`	The numeric identifier for the comment (if updating an existing comment).
`Text`	The text content of the comment.
`Author`	The name of the author posting the comment.
`Createddate`	The date the comment was created, in a standard date format.
`Formattedcreateddate`	A preformatted string representation of the created date.
`Entityid`	The numeric identifier of the entity (duplicate of the path parameter).

GET Returns a bundle of the entity and all linked entities

/api/v1.0.0/entities/{entityId}/linksandfields

Returns a bundle containing the entity and all entities linked to it, along with their fields. Use this to fetch an entity and its relationships in a single request.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity to which the comment will be added.
`Fieldtypeids`	optional, filter field types using comma separated list
`Linkdirection`	optional, "inbound" or "outbound"
`Linktypeid`	optional, filter by link type
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns a completeness details

/api/v1.0.0/entities/{entityId}/completenessdetails

Returns completeness details for the specified entity, showing how many required fields are filled. Use this to assess data quality for an entity.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity to which the comment will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Returns a dictionary of unique values and entity id's

/api/v1.0.0/entities:mapuniquevalues

Returns a dictionary mapping unique field values to the entity IDs that contain them. Use this to find entities by specific field values.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Fieldtypeid`	The ID of the field type to search for unique values.
`Uniquevalues`	The unique values to look up; provide them as a string.

GET Returns a list of field values

/api/v1.0.0/entities/{entityId}/fieldvalues

Returns a list of all field values for the specified entity. Use this to retrieve the current values of all fields on an entity.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity to which the comment will be added.
`Fieldtypeids`	optional, filter types using comma separated list
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns a list of links

/api/v1.0.0/entities/{entityId}/links

Returns a list of all links associated with the specified entity. Use this to see which other entities are linked to the given entity.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity to which the comment will be added.
`Linkdirection`	optional, "inbound" or "outbound"
`Linktypeid`	optional, filter by link type
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns a list of specification field values

/api/v1.0.0/entities/{entityId}/specificationvalues

Returns a list of specification field values for the specified entity. Use this to retrieve specification-specific field data.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity to which the comment will be added.
`Specificationfieldtypeids`	optional, filter types using comma separated list
`Mandatoryonly`	optional
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns a read only entity summary

/api/v1.0.0/entities/{entityId}/summary

Returns a read-only summary of the specified entity. Use this to get a lightweight overview without full field details.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity to which the comment will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns a read only list of entity media

/api/v1.0.0/entities/{entityId}/media

Returns a read-only list of media items associated with the specified entity. Use this to view media files attached to the entity.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity to which the comment will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns a read only list of entity media details

/api/v1.0.0/entities/{entityId}/mediadetails

Returns a read-only list of media details (including metadata) for the specified entity. Use this to get detailed information about each media item.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity to which the comment will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns a read only list of field values

/api/v1.0.0/entities/{entityId}/summary/fields

Returns a read-only list of field values for the entity's summary. Use this to retrieve a subset of field data intended for summary views.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity to which the comment will be added.
`Fieldtypeids`	optional, filter types using comma separated list
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns a read only list of specification field values

/api/v1.0.0/entities/{entityId}/summary/specification

Returns a read-only list of specification field values for the entity's summary. Use this to get specification field data in a summarized form.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity to which the comment will be added.
`Specificationfieldtypeids`	optional, filter types using comma separated list
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns an entity creation model

/api/v1.0.0/entities:getempty

The fieldValues array will contain all fields required to create an entity (usually all mandatory and unique fields).

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entitytypeid`	The ID of the entity type for which to retrieve the creation model.
`Fieldsetid`	optional
`Allfields`	optional, include all fields (not included in a field set)
`Response Type`	The response format expected from the API (e.g. application/json).

POST Returns various types of entity data

/api/v1.0.1/entities:fetchdata

Fetch data for a list of entity id's and specify what data to include (objects).

Specify what objects to include in a comma separated list. You may fetch different object sets for entities, inbound links, outbound links. Supply a "linkEntityObjects" string in the inbound or outbound object to include link entity data in the response.

Link types may be specified for both inbound and outbound using linkTypeIds (a comma separated list of link type id's). If linkTypeIds is omitted no filtering will be applied.

Field data may be filtered by suppling a comma separated list as fieldTypeIds. The filter will be applied on all entities and linked entities regardless of entity type.

Available objects
-----
EntitySummary

FieldsSummary

FieldValues

SpecificationSummary

SpecificationValues

Media

MediaDetails

Examples:

"objects": "EntitySummary,Media"

"linkEntityObjects": "FieldValues" (applicable to inbound and outbound links only)

Always request as few objects as possible as this will reduce the response time.

Limit: 1000 entity ids per request.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Entityids`	The IDs of the entities to fetch data for, provided as an array of integers.
`Objects`	The types of data objects to retrieve (e.g., 'fields', 'links'), specified as a string.
`Fieldtypeids`	The field type IDs to include in the response, provided as a string.

PUT Set entity segment

/api/v1.0.0/entities/{entityId}/segment

Sets the segment for the specified entity. Use this to assign or change the entity's segment.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity to which the comment will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Segmentid`	The numeric identifier of the segment to assign to the new entity.

PUT Set field set

/api/v1.0.0/entities/{entityId}/fieldset

Set fieldSetId to null to remove the field set

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity to which the comment will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Fieldsetid`	The string identifier of the field set to assign to the new entity.
`Wipeotherfields`	If true, removes all fields not included in the new field set.

PUT Set specification template

/api/v1.0.0/entities/{entityId}/specificationtemplate

Set SpecificationId to null for removing specification template

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity to which the comment will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Specificationid`	The ID of the specification template to assign.

PUT Update field values

/api/v1.0.0/entities/{entityId}/fieldvalues

The list may be an subset of available field values

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity to which the comment will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Fieldtypeid`	The ID of the field type whose value to update.
`Value`	The new value to set for the specified field type.

PUT Update list of starred entities

/api/v1.0.0/entities/starred

Updates the list of starred (favorited) entities for the current user. Use this to mark or unmark entities as starred.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	An array of entity IDs to set as starred; pass an empty array to clear all starred entities.

PUT Update specification field values

/api/v1.0.0/entities/{entityId}/specificationvalues

The list may be an subset of available specification field values

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entityid`	The numeric identifier of the entity to which the comment will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Specificationfieldtypeid`	The ID of the specification field type whose value to update.
`Value`	The new value to set for the specified specification field type.

Link (4)

POST Create a new link

/api/v1.0.0/links

Set index to 0 to add the link to first position. Set index to null to add the link to last position. Specifying the index will reorganize all link indices.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (7)

Option Name	Description
`Id`	The numeric identifier for the comment (if updating an existing comment).
`Isactive`	Indicates whether the link is active.
`Linktypeid`	The identifier of the link type to apply.
`Sourceentityid`	The identifier of the source entity for the link.
`Targetentityid`	The identifier of the target entity for the link.
`Linkentityid`	The identifier of an optional link entity associated with this link.
`Index`	The sort order index for the link within its group.

DELETE Delete link

/api/v1.0.0/links/{linkId}

Permanently delete a link by its unique identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Linkid`	The unique identifier of the link to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns a link

/api/v1.0.0/links/{linkId}

Retrieve details of a specific link using its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Linkid`	The unique identifier of the link to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update sort order of links

/api/v1.0.0/links/sortorder

Update the sort order and properties of multiple links at once. Provide an array of link objects with their new index and other fields.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (7)

Option Name	Description
`Id`	The unique identifier of the link to update.
`Isactive`	Indicates whether the link is active.
`Linktypeid`	The identifier of the link type to apply.
`Sourceentityid`	The identifier of the source entity for the link.
`Targetentityid`	The identifier of the target entity for the link.
`Linkentityid`	The identifier of an optional link entity associated with this link.
`Index`	The new sort order index for the link.

Media (3)

POST Add Media

/api/v1.0.0/media:uploadbase64

Upload base64 encoded file data. A resource entity will be created.

If the resourceLink object is omitted a resource entity will be created without a link. If resourceLink.linkTypeId is omitted inRiver will automatically find the most suitable link type.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Filename`	The desired filename for the uploaded media.
`Data`	The base64-encoded data of the media file.

POST Add Media

/api/v1.0.0/media:uploadfromurl

Note: If overrideUrlFileName is omitted, the filename will equal the one supplied in the url. Set overrideUrlFileName to specifiy a file name.

If the resourceLink object is omitted a resource entity will be created without a link. If resourceLink.linkTypeId is omitted inRiver will automatically find the most suitable link type.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Url`	The external URL of the media.
`Overrideurlfilename`	An optional string to override the filename derived from the URL.

POST Add external media url

/api/v1.0.0/media:addexternalurl

If the resourceLink object is omitted a resource entity will be created without a link. If resourceLink.linkTypeId is omitted inRiver will automatically find the most suitable link type.

Example:

Original external file URL that is added with this REST endpoint

https://yourexternalresourceservice.com/imagename.jpg

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Url`	The external URL of the media.
`Overrideurlfilename`	An optional string to override the filename derived from the URL.

Model (11)

POST Create new CVL value

/api/v1.0.0/model/cvls/{cvlId}/values

Add a new value to an existing CVL (Controlled Vocabulary List). Specify the CVL ID, the key and value for the new entry.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Cvlid`	The identifier of the CVL to which the value will be added.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Key`	The key for the new CVL value.
`Value`	The display value for the new CVL entry.
`Index`	The sort order index for the value within the CVL.
`Parentkey`	The key of the parent value if this value is hierarchical.

DELETE Delete CVL value

/api/v1.0.0/model/cvls/{cvlId}/values/{key}

Remove a specific CVL value identified by its key from the given CVL.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Cvlid`	The identifier of the CVL containing the value to delete.
`Key`	The key of the CVL value to delete
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get CVL value

/api/v1.0.0/model/cvls/{cvlId}/values/{key}

Retrieve a single CVL value by its key from the specified CVL.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Cvlid`	The identifier of the CVL containing the value.
`Key`	CVL value key
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns all CVL's

/api/v1.0.0/model/cvls

Retrieve a list of all controlled vocabulary lists (CVLs) available in the model.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns all specification templates

/api/v1.0.0/model/specificationtemplates

Retrieve a list of all specification templates defined in the model.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns all values for a CVL

/api/v1.0.0/model/cvls/{cvlId}/values

Retrieve all values associated with a specific CVL by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Cvlid`	The identifier of the CVL whose values are to be retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns available entity types

/api/v1.0.0/model/entitytypes

Retrieve a list of all entity types available in the model.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Entitytypeids`	optional, filter types using comma separated list
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns available field sets

/api/v1.0.0/model/fieldsets

Retrieve a list of all field sets available in the model.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns available languages

/api/v1.0.0/model/languages

Retrieve a list of all languages configured in the model.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns field types for specification template

/api/v1.0.0/model/specificationtemplates/{templateId}/fieldtypes

Retrieve all field types defined for a specific specification template by its ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Templateid`	The identifier of the specification template whose field types are to be retrieved.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update CVL value

/api/v1.0.0/model/cvls/{cvlId}/values/{key}

Updates the value of a specific CVL (Controlled Vocabulary List) entry identified by its key. Use this to modify an existing CVL value.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Cvlid`	The identifier of the CVL whose values are to be retrieved.
`Key`	The unique key of the CVL value to update.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Key`	The key for the new CVL value.
`Value`	The display value for the new CVL entry.
`Index`	The sort order index for the value within the CVL.
`Parentkey`	The key of the parent value if this value is hierarchical.

Query

POST Search for entity id's

/api/v1.0.0/query

Available system criterion types and their supported operators

-----
FieldSetId: (string) Equal, NotEqual, IsEmpty, IsNotEmpty
SegmentIds: (Integer array) ContainsAny, NotContainsAny
CreatedBy: (email, string) Equal, NotEqual
ModifiedBy: (email, string) Equal, NotEqual
Created: (DateTime) Equal, NotEqual, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual
LastModified: (DateTime) Equal, NotEqual, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual
EntityTypeId: (string) Equal, NotEqual
Completeness: (Integer) Equal, NotEqual, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual
ChannelId: (Integer) Equal
PublicationId: (Integer) Equal

Operators for each field datatype in dataCriteria

-----
String: Equal, NotEqual, BeginsWith, IsEmpty, IsNotEmpty, Contains
LocaleString: Equal, NotEqual, BeginsWith, IsEmpty, IsNotEmpty, Contains
Boolean: IsTrue, IsFalse, IsEmpty IsNotEmpty,
CVL(singlevalue): Equal, NotEqual, IsEmpty IsNotEmpty,
CVL(multivalue): ContainsAll, ContainsAny, NotContainsAll, NotContainsAny, IsEmpty IsNotEmpty,
Date time: Equal, NotEqual, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, IsEmpty IsNotEmpty,
Integer and Double: Equal, NotEqual, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, IsEmpty IsNotEmpty,
Xml: Equal, NotEqual, BeginsWith, IsEmpty, IsNotEmpty, Contains
File: Equal, NotEqual, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, IsEmpty IsNotEmpty,

Language
-----
LocaleString is the only data type that supports language.

Link Criterion

-----
Direction determines if the source or target entity of the link will be included in the result.

If direction is "outbound", the link source entity is included in the result
If direction is "inbound", the link target entity is included in the result

If linkCriterion.dataCriteria is omitted the search will simply check if a link exists.

The boolean linkExists defaults to true and may be omitted. Setting linkExists to false searches for entities without links and can't be combined with data criteria (in the link criterion).

Note: Keep your queries as simple as possible. More complex queries take longer time to perform.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Syndicate (2)

GET Get All Syndications

/api/v1.0.0/syndications

Retrieves a list of all syndication configurations available in the system.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Run Syndicate

/api/v1.0.0/syndications/{syndicationId}:run

Triggers execution of a specific syndication process by its identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Syndicationid`	The numeric identifier of the syndication to run.
`Response Type`	The response format expected from the API (e.g. application/json).

System (17)

POST Add new asset configuration.

/api/v1.0.0/system/assetconfigurationdetails

Creates a new asset configuration detail entry in the system.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Name`	Gets or sets asset configuration name.
`Setting`	Gets or sets asset configuration setting.

POST Assign a role to a user and segment

/api/v1.0.0/system/segments/{segmentId}:adduserrole

The roleName value expects a single role name, such as "Editor" or "Reader". Requires administrator role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Segmentid`	The numeric identifier of the segment.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Username`	The username of the user to assign the role to.
`Rolename`	The name of the role to assign.

DELETE Delete asset configuration.

/api/v1.0.0/system/assetconfigurationdetails/{id}

Permanently removes a specific asset configuration detail from the system.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The {System.Guid} of the existing asset configuration.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete user

/api/v1.0.0/system/users/{username}

Requires APIManageUsers permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Username`	The username of the user to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get list of segments

/api/v1.0.0/system/segments

Requires administrator role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Forusername`	optional, get segments for a specific user
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get list of server settings

/api/v1.0.0/system/serversettings

Requires administrator role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Settingnames`	optional, comma separated list of setting names
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get list of user roles and permissions

/api/v1.0.0/system/roles

If the environment has multiple segments the user's roles for assigned segments will be combined. The /segments endpoint should be used for multi segment environments. Requires administrator role.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Forusername`	optional, get permissions for a specific user
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get list of users

/api/v1.0.0/system/users

Requires APIManageUsers permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get user

/api/v1.0.0/system/users/{username}

Requires APIManageUsers permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Username`	The username of the user to retrieve.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Modify user access for segment

/api/v1.0.0/system/segments/{segmentId}:setuserroles

The roleNames array is expecting a list of role names, such as ["Editor", "Reader"]. The roleNames array may be set to empty or null in order to completely remove user access from the given segment. Requires administrator role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Segmentid`	The numeric identifier of the segment.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Username`	The username of the user whose roles are being set.
`Rolenames`	An array of role names to assign to the user.

POST Provision user

/api/v1.0.0/system/users:provision

Provision a user account without login credentials. This endpoint may be used to synchronize SAML user accounts with an external system. The segmentRoles field may be omitted to provision a user without roles. Requires APIManageUsers permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Username`	The desired username for the new user.
`Email`	The email address for the new user.
`Firstname`	The first name of the new user.
`Lastname`	The last name of the new user.

POST Remove a role from a user and segment

/api/v1.0.0/system/segments/{segmentId}:removeuserrole

The roleName value expects a single role name, such as "Editor" or "Reader". Requires administrator role.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Segmentid`	The numeric identifier of the segment.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Username`	The username of the user from whom to remove the role.
`Rolename`	The name of the role to remove.

GET Return full details of available image configurations

/api/v1.0.0/system/imageconfigurationdetails

Retrieves detailed information about all image configurations available in the system.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns available asset configuration details by unique identifier.

/api/v1.0.0/system/assetconfigurationdetails/{id}

Retrieves detailed information for a specific asset configuration entry using its unique identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	The {System.Guid} of the existing asset configuration.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns available asset configuration details.

/api/v1.0.0/system/assetconfigurationdetails

Retrieves a list of all asset configuration details available in the system.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns available image configurations

/api/v1.0.0/system/imageconfigurations

Retrieves a list of all image configurations available in the system.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update user

/api/v1.0.0/system/users/{username}

Update first name, last name and/or roles. The fields firstName, lastName or segmentRoles may be omitted to keep the current value. Requires APIManageUsers permission.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Username`	The username of the user to update.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Username`	The new username to assign to the user.
`Email`	The new email address for the user.
`Firstname`	The new first name for the user.
`Lastname`	The new last name for the user.

Workarea (9)

POST Create a new workarea

/api/v1.0.0/workareafolder:createnew

Supply either entityIds or query. This determines if the workarea is static or based on a query.

Check the description for the /query endpoint on how to constuct a query.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Name`	The display name for the new workarea.
`Isshared`	Whether the workarea should be shared with other users.
`Entityids`	The IDs of the entities to fetch data for, provided as an array of integers.
`Index`	The sort order index for the value within the CVL.
`Parentid`	The identifier of the parent folder under which to create the workarea.
`Username`	The username of the owner for the workarea.

DELETE Delete workarea folder

/api/v1.0.0/workareafolder/{workareaFolderId}

Permanently deletes a specific workarea folder.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Workareafolderid`	The unique identifier of the workarea folder to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get entity id's in a static workarea

/api/v1.0.0/workareafolder/{workareaFolderId}/entityIds

Retrieve the list of entity IDs currently assigned to a static workarea folder. Use this to inspect which entities are grouped in a specific workarea.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Workareafolderid`	The unique identifier of the workarea folder to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get workarea folder tree

/api/v1.0.0/workareafoldertree

The parameter includeCreatedByMe will be ignored if forUsername is set.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Includecreatedbyme`	optional
`Includeshared`	optional
`Forusername`	optional
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get workarea folders

/api/v1.0.0/workareafolders

The parameter includeCreatedByMe will be ignored if forUsername is set.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Includecreatedbyme`	optional
`Includeshared`	optional
`Forusername`	optional
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns a list of entities in a workarea folder

/api/v1.0.0/workareafolder/{workareaFolderId}/entitylist

Returns an entity list for any type of workarea

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Workareafolderid`	The unique identifier of the workarea folder to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Set entity id's in a static workarea

/api/v1.0.0/workareafolder/{workareaFolderId}/entityIds

Replace the entire set of entity IDs in a static workarea folder with a new list. Use this to update the membership of a workarea.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Workareafolderid`	The unique identifier of the workarea folder to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	An array of entity IDs to set as starred; pass an empty array to clear all starred entities.

PUT Update workarea folder

/api/v1.0.0/workareafolder/{workareaFolderId}

It's only possible to alter name and index properties

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Workareafolderid`	The unique identifier of the workarea folder to delete.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Id`	The unique identifier of the workarea folder to update. Provide the folder ID as a string.
`Name`	The display name for the new workarea.
`Isquery`	Whether the folder should be a dynamic query-based workarea or a static folder. Set to true for a query workarea or false for a static one.
`Index`	The sort order index for the value within the CVL.

PUT Update workarea query

/api/v1.0.0/workareafolder/{workareaFolderId}/query

Check the description for the /query endpoint on how to constuct a query.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Workareafolderid`	The unique identifier of the workarea folder to delete.
`Response Type`	The response format expected from the API (e.g. application/json).