Inriverconnector v1 | OneTeg Documentation

Version 1

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

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`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Path`	N/A
`Entitytypeids`	optional, filter types using comma separated list
`Response Type`	N/A

GET Channel structure list

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Channelid`	N/A
`Response Type`	N/A

GET Channel structure tree

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Channelid`	N/A
`Response Type`	N/A

GET Get a list of entities in a channel

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Channelid`	N/A
`Entitytypeid`	optional, filter by entity type id
`Response Type`	N/A

GET Get channel id's for entity id

/api/v1.0.0/channels

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Forentityid`	optional
`Includechannels`	optional, defaults to true
`Includepublications`	optional, defaults to false
`Response Type`	N/A

GET Get entity links

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Channelid`	N/A
`Entityid`	N/A
`Linkdirection`	"inbound" or "outbound"
`Linktypeid`	optional, filter by link type
`Response Type`	N/A

GET Get entity types for channel

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Channelid`	N/A
`Response Type`	N/A

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`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Channelid`	N/A
`Entityid`	N/A
`Response Type`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Url`	N/A
`Overrideurlfilename`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Filename`	N/A
`Data`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Url`	N/A
`Overrideurlfilename`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Entitytypeid`	N/A
`Fieldsetid`	N/A
`Segmentid`	N/A

DELETE Delete an entity

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Response Type`	N/A

DELETE Delete entity comment

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Commentid`	N/A
`Response Type`	N/A

GET Entity comments

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Response Type`	N/A

GET Field value revisions

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Fieldtypeid`	N/A
`Response Type`	N/A

GET Get All Segments

/api/v1.0.0/entities/segments

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Get list of starred entities

/api/v1.0.0/entities/starred

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

POST Post entity comment

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

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Id`	N/A
`Text`	N/A
`Author`	N/A
`Createddate`	N/A
`Formattedcreateddate`	N/A
`Entityid`	N/A

GET Returns a bundle of the entity and all linked entities

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Fieldtypeids`	optional, filter field types using comma separated list
`Linkdirection`	optional, "inbound" or "outbound"
`Linktypeid`	optional, filter by link type
`Response Type`	N/A

GET Returns a completeness details

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Response Type`	N/A

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

/api/v1.0.0/entities:mapuniquevalues

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Fieldtypeid`	N/A
`Uniquevalues`	N/A

GET Returns a list of field values

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Fieldtypeids`	optional, filter types using comma separated list
`Response Type`	N/A

GET Returns a list of links

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Linkdirection`	optional, "inbound" or "outbound"
`Linktypeid`	optional, filter by link type
`Response Type`	N/A

GET Returns a list of specification field values

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Specificationfieldtypeids`	optional, filter types using comma separated list
`Mandatoryonly`	optional
`Response Type`	N/A

GET Returns a read only entity summary

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Response Type`	N/A

GET Returns a read only list of entity media

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Response Type`	N/A

GET Returns a read only list of entity media details

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Response Type`	N/A

GET Returns a read only list of field values

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Fieldtypeids`	optional, filter types using comma separated list
`Response Type`	N/A

GET Returns a read only list of specification field values

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Specificationfieldtypeids`	optional, filter types using comma separated list
`Response Type`	N/A

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`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entitytypeid`	N/A
`Fieldsetid`	optional
`Allfields`	optional, include all fields (not included in a field set)
`Response Type`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Entityids`	N/A
`Objects`	N/A
`Fieldtypeids`	N/A

PUT Set entity segment

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

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Segmentid`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Fieldsetid`	N/A
`Wipeotherfields`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Specificationid`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Fieldtypeid`	N/A
`Value`	N/A

PUT Update list of starred entities

/api/v1.0.0/entities/starred

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entityid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Specificationfieldtypeid`	N/A
`Value`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (7)

Option Name	Description
`Id`	N/A
`Isactive`	N/A
`Linktypeid`	N/A
`Sourceentityid`	N/A
`Targetentityid`	N/A
`Linkentityid`	N/A
`Index`	N/A

DELETE Delete link

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Linkid`	N/A
`Response Type`	N/A

GET Returns a link

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Linkid`	N/A
`Response Type`	N/A

PUT Update sort order of links

/api/v1.0.0/links/sortorder

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (7)

Option Name	Description
`Id`	N/A
`Isactive`	N/A
`Linktypeid`	N/A
`Sourceentityid`	N/A
`Targetentityid`	N/A
`Linkentityid`	N/A
`Index`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Filename`	N/A
`Data`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Url`	N/A
`Overrideurlfilename`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Url`	N/A
`Overrideurlfilename`	N/A

Model (11)

POST Create new CVL value

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

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Cvlid`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Key`	N/A
`Value`	N/A
`Index`	N/A
`Parentkey`	N/A

DELETE Delete CVL value

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Cvlid`	N/A
`Key`	The key of the CVL value to delete
`Response Type`	N/A

GET Get CVL value

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Cvlid`	N/A
`Key`	CVL value key
`Response Type`	N/A

GET Returns all CVL's

/api/v1.0.0/model/cvls

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Returns all specification templates

/api/v1.0.0/model/specificationtemplates

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Returns all values for a CVL

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Cvlid`	N/A
`Response Type`	N/A

GET Returns available entity types

/api/v1.0.0/model/entitytypes

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Entitytypeids`	optional, filter types using comma separated list
`Response Type`	N/A

GET Returns available field sets

/api/v1.0.0/model/fieldsets

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Returns available languages

/api/v1.0.0/model/languages

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Returns field types for specification template

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Templateid`	N/A
`Response Type`	N/A

PUT Update CVL value

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

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Cvlid`	N/A
`Key`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Key`	N/A
`Value`	N/A
`Index`	N/A
`Parentkey`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Syndicate (2)

GET Get All Syndications

/api/v1.0.0/syndications

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

POST Run Syndicate

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Syndicationid`	N/A
`Response Type`	N/A

System (17)

POST Add new asset configuration.

/api/v1.0.0/system/assetconfigurationdetails

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Segmentid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Username`	N/A
`Rolename`	N/A

DELETE Delete asset configuration.

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The {System.Guid} of the existing asset configuration.
`Response Type`	N/A

DELETE Delete user

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

Requires APIManageUsers permission.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Username`	N/A
`Response Type`	N/A

GET Get list of segments

/api/v1.0.0/system/segments

Requires administrator role.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Forusername`	optional, get segments for a specific user
`Response Type`	N/A

GET Get list of server settings

/api/v1.0.0/system/serversettings

Requires administrator role.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Settingnames`	optional, comma separated list of setting names
`Response Type`	N/A

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`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Forusername`	optional, get permissions for a specific user
`Response Type`	N/A

GET Get list of users

/api/v1.0.0/system/users

Requires APIManageUsers permission.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Get user

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

Requires APIManageUsers permission.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Username`	N/A
`Response Type`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Segmentid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Username`	N/A
`Rolenames`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Username`	N/A
`Email`	N/A
`Firstname`	N/A
`Lastname`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Segmentid`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Username`	N/A
`Rolename`	N/A

GET Return full details of available image configurations

/api/v1.0.0/system/imageconfigurationdetails

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Returns available asset configuration details by unique identifier.

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	The {System.Guid} of the existing asset configuration.
`Response Type`	N/A

GET Returns available asset configuration details.

/api/v1.0.0/system/assetconfigurationdetails

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET Returns available image configurations

/api/v1.0.0/system/imageconfigurations

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Username`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Username`	N/A
`Email`	N/A
`Firstname`	N/A
`Lastname`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Name`	N/A
`Isshared`	N/A
`Entityids`	N/A
`Index`	N/A
`Parentid`	N/A
`Username`	N/A

DELETE Delete workarea folder

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Workareafolderid`	N/A
`Response Type`	N/A

GET Get entity id's in a static workarea

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Workareafolderid`	N/A
`Response Type`	N/A

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`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Includecreatedbyme`	optional
`Includeshared`	optional
`Forusername`	optional
`Response Type`	N/A

GET Get workarea folders

/api/v1.0.0/workareafolders

The parameter includeCreatedByMe will be ignored if forUsername is set.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Includecreatedbyme`	optional
`Includeshared`	optional
`Forusername`	optional
`Response Type`	N/A

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`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Workareafolderid`	N/A
`Response Type`	N/A

PUT Set entity id's in a static workarea

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

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Workareafolderid`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Workareafolderid`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Id`	N/A
`Name`	N/A
`Isquery`	N/A
`Index`	N/A

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`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Workareafolderid`	N/A
`Response Type`	N/A