Resource for handling ContentRepositories
List available ContentRepositories
name | type | description | default | constraints |
---|---|---|---|---|
page | query | Returned page, if paging is used. Paging starts with 1 |
1 | int |
pageSize | query | Page size for paging. If this is set to -1 no paging is used (all matching items are returned).
Setting this to 0 will return no items. |
-1 | int |
perms | query | Flag to add permission information for the returned items. | false | boolean |
q | query | Query string for filtering | ||
sort | query | Comma separated list of sorted attributes.
Each attribute name may be prefixed with + for sorting in ascending order or - for sorting in descending order |
name |
code | condition |
---|---|
200 | ContentRepository list is returned. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ContentRepositoryListResponse (JSON) | List of ContentRepositories |
GET /contentrepositories
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ {
"id" : 12345,
"name" : "...",
"crType" : "mccr",
"dbType" : "...",
"username" : "...",
"password" : "...",
"usePassword" : true,
"url" : "...",
"basepath" : "...",
"instantPublishing" : true,
"languageInformation" : true,
"permissionInformation" : true,
"permissionProperty" : "...",
"defaultPermission" : "...",
"diffDelete" : true,
"elasticsearch" : {
"page" : { },
"folder" : { },
"file" : { }
},
"projectPerNode" : true,
"version" : "...",
"checkDate" : 12345,
"checkStatus" : "ok",
"checkResult" : "...",
"statusDate" : 12345,
"dataStatus" : "running",
"dataCheckResult" : "...",
"globalId" : "..."
}, {
"id" : 12345,
"name" : "...",
"crType" : "cr",
"dbType" : "...",
"username" : "...",
"password" : "...",
"usePassword" : true,
"url" : "...",
"basepath" : "...",
"instantPublishing" : true,
"languageInformation" : true,
"permissionInformation" : true,
"permissionProperty" : "...",
"defaultPermission" : "...",
"diffDelete" : true,
"elasticsearch" : {
"page" : { },
"folder" : { },
"file" : { }
},
"projectPerNode" : true,
"version" : "...",
"checkDate" : 12345,
"checkStatus" : "error",
"checkResult" : "...",
"statusDate" : 12345,
"dataStatus" : "unchecked",
"dataCheckResult" : "...",
"globalId" : "..."
} ],
"hasMoreItems" : true,
"numItems" : 12345,
"perms" : {
"property1" : [ "createoverview", "deletefolder" ],
"property2" : [ "inheritance", "publishpages" ]
},
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Create a new ContentRepository
media type | data type | description |
---|---|---|
application/json | ContentRepositoryModel (JSON) | ContentRepository to create |
code | condition |
---|---|
201 | ContentRepository was created. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ContentRepositoryResponse (JSON) | created ContentRepository |
POST /contentrepositories
Content-Type: application/json
Accept: application/json
{
"id" : 12345,
"name" : "...",
"crType" : "mesh",
"dbType" : "...",
"username" : "...",
"password" : "...",
"usePassword" : true,
"url" : "...",
"basepath" : "...",
"instantPublishing" : true,
"languageInformation" : true,
"permissionInformation" : true,
"permissionProperty" : "...",
"defaultPermission" : "...",
"diffDelete" : true,
"elasticsearch" : {
"page" : { },
"folder" : { },
"file" : { }
},
"projectPerNode" : true,
"version" : "...",
"checkDate" : 12345,
"checkStatus" : "unchecked",
"checkResult" : "...",
"statusDate" : 12345,
"dataStatus" : "running",
"dataCheckResult" : "...",
"globalId" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"contentRepository" : {
"id" : 12345,
"name" : "...",
"crType" : "cr",
"dbType" : "...",
"username" : "...",
"password" : "...",
"usePassword" : true,
"url" : "...",
"basepath" : "...",
"instantPublishing" : true,
"languageInformation" : true,
"permissionInformation" : true,
"permissionProperty" : "...",
"defaultPermission" : "...",
"diffDelete" : true,
"elasticsearch" : {
"page" : { },
"folder" : { },
"file" : { }
},
"projectPerNode" : true,
"version" : "...",
"checkDate" : 12345,
"checkStatus" : "queued",
"checkResult" : "...",
"statusDate" : 12345,
"dataStatus" : "running",
"dataCheckResult" : "...",
"globalId" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Delete the ContentRepository with given id
name | type | description |
---|---|---|
id | path | internal or external ContentRepository ID |
code | condition |
---|---|
204 | ContentRepository {id} was deleted. |
404 | ContentRepository {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | response |
DELETE /contentrepositories/{id}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
...
Get the ContentRepository with given id
name | type | description |
---|---|---|
id | path | internal or external ContentRepository ID |
code | condition |
---|---|
200 | ContentRepository {id} exists. |
404 | ContentRepository {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ContentRepositoryResponse (JSON) | Response containing the ContentRepository |
GET /contentrepositories/{id}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"contentRepository" : {
"id" : 12345,
"name" : "...",
"crType" : "mccr",
"dbType" : "...",
"username" : "...",
"password" : "...",
"usePassword" : true,
"url" : "...",
"basepath" : "...",
"instantPublishing" : true,
"languageInformation" : true,
"permissionInformation" : true,
"permissionProperty" : "...",
"defaultPermission" : "...",
"diffDelete" : true,
"elasticsearch" : {
"page" : { },
"folder" : { },
"file" : { }
},
"projectPerNode" : true,
"version" : "...",
"checkDate" : 12345,
"checkStatus" : "queued",
"checkResult" : "...",
"statusDate" : 12345,
"dataStatus" : "queued",
"dataCheckResult" : "...",
"globalId" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Update ContentRepository with given id
name | type | description |
---|---|---|
id | path | internal or external ContentRepository ID |
media type | data type | description |
---|---|---|
application/json | ContentRepositoryModel (JSON) | updated ContentRepository |
code | condition |
---|---|
201 | ContentRepository {id} was updated. |
404 | ContentRepository {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ContentRepositoryResponse (JSON) | updated ContentRepository |
PUT /contentrepositories/{id}
Content-Type: application/json
Accept: application/json
{
"id" : 12345,
"name" : "...",
"crType" : "cr",
"dbType" : "...",
"username" : "...",
"password" : "...",
"usePassword" : true,
"url" : "...",
"basepath" : "...",
"instantPublishing" : true,
"languageInformation" : true,
"permissionInformation" : true,
"permissionProperty" : "...",
"defaultPermission" : "...",
"diffDelete" : true,
"elasticsearch" : {
"page" : { },
"folder" : { },
"file" : { }
},
"projectPerNode" : true,
"version" : "...",
"checkDate" : 12345,
"checkStatus" : "ok",
"checkResult" : "...",
"statusDate" : 12345,
"dataStatus" : "error",
"dataCheckResult" : "...",
"globalId" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"contentRepository" : {
"id" : 12345,
"name" : "...",
"crType" : "mesh",
"dbType" : "...",
"username" : "...",
"password" : "...",
"usePassword" : true,
"url" : "...",
"basepath" : "...",
"instantPublishing" : true,
"languageInformation" : true,
"permissionInformation" : true,
"permissionProperty" : "...",
"defaultPermission" : "...",
"diffDelete" : true,
"elasticsearch" : {
"page" : { },
"folder" : { },
"file" : { }
},
"projectPerNode" : true,
"version" : "...",
"checkDate" : 12345,
"checkStatus" : "ok",
"checkResult" : "...",
"statusDate" : 12345,
"dataStatus" : "queued",
"dataCheckResult" : "...",
"globalId" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the roles available in the Mesh instance for the Mesh ContentRepository
name | type | description |
---|---|---|
id | path | ID of the Mesh ContentRepository |
code | condition |
---|---|
200 | ContentRepository {id} is a Mesh CR with roles property set and currently set roles are returned. |
404 | ContentRepository {id} does not exist. |
409 | ContentRepository {id} is either not a Mesh CR or connection to Mesh CR failed. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | MeshRolesResponse (JSON) | response containing list of role names |
GET /contentrepositories/{id}/availableroles
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"roles" : [ "...", "..." ],
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Copy a ContentRepotiroy
name | type | description |
---|---|---|
id | path | internal or external ID of the ContentRepository to copy |
code | condition |
---|---|
201 | ContentRepository {id} was copied. |
404 | ContentRepository {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ContentRepositoryResponse (JSON) | response containing the copy |
PUT /contentrepositories/{id}/copy
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 201 Created
Content-Type: application/json
{
"contentRepository" : {
"id" : 12345,
"name" : "...",
"crType" : "cr",
"dbType" : "...",
"username" : "...",
"password" : "...",
"usePassword" : true,
"url" : "...",
"basepath" : "...",
"instantPublishing" : true,
"languageInformation" : true,
"permissionInformation" : true,
"permissionProperty" : "...",
"defaultPermission" : "...",
"diffDelete" : true,
"elasticsearch" : {
"page" : { },
"folder" : { },
"file" : { }
},
"projectPerNode" : true,
"version" : "...",
"checkDate" : 12345,
"checkStatus" : "running",
"checkResult" : "...",
"statusDate" : 12345,
"dataStatus" : "running",
"dataCheckResult" : "...",
"globalId" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the ContnetRepository Fragments assigned to the ContentRepository
name | type | description | default | constraints |
---|---|---|---|---|
id | path | internal or external ID | ||
page | query | Returned page, if paging is used. Paging starts with 1 |
1 | int |
pageSize | query | Page size for paging. If this is set to -1 no paging is used (all matching items are returned).
Setting this to 0 will return no items. |
-1 | int |
perms | query | Flag to add permission information for the returned items. | false | boolean |
q | query | Query string for filtering | ||
sort | query | Comma separated list of sorted attributes.
Each attribute name may be prefixed with + for sorting in ascending order or - for sorting in descending order |
name |
code | condition |
---|---|
200 | List of ContentRepository Fragments assigned to ContentRepository {id} is returned. |
404 | ContentRepository {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ContentRepositoryFragmentListResponse (JSON) | list of Cr Fragments |
GET /contentrepositories/{id}/cr_fragments
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ {
"id" : 12345,
"name" : "...",
"globalId" : "..."
}, {
"id" : 12345,
"name" : "...",
"globalId" : "..."
} ],
"hasMoreItems" : true,
"numItems" : 12345,
"perms" : {
"property1" : [ "deletetemplates", "publishpages" ],
"property2" : [ "deleteform", "updateconstructs" ]
},
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the entries in the ContentRepository
name | type | description | default | constraints |
---|---|---|---|---|
id | path | internal or external ID | ||
fragments | query | true to include entries from assigned fragments, false (which is the default) to only list entries of the ContentRepository itself | false | boolean |
page | query | Returned page, if paging is used. Paging starts with 1 |
1 | int |
pageSize | query | Page size for paging. If this is set to -1 no paging is used (all matching items are returned).
Setting this to 0 will return no items. |
-1 | int |
q | query | Query string for filtering | ||
sort | query | Comma separated list of sorted attributes.
Each attribute name may be prefixed with + for sorting in ascending order or - for sorting in descending order |
name |
code | condition |
---|---|
200 | List of entries in ContentRepository {id} is returned. |
404 | ContentRepository {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | TagmapEntryListResponse (JSON) | list of entries |
GET /contentrepositories/{id}/entries
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"perms" : {
"property1" : [ "updateform", "createitems" ],
"property2" : [ "channelsync", "channelsync" ]
},
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Create a new tagmap entry
name | type | description |
---|---|---|
id | path | internal or external ID of the ContentRepository |
media type | data type | description |
---|---|---|
application/json | TagmapEntryModel (JSON) | entry to create |
code | condition |
---|---|
201 | Entry was created. |
404 | ContentRepository {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | TagmapEntryResponse (JSON) | created entry |
POST /contentrepositories/{id}/entries
Content-Type: application/json
Accept: application/json
{
"id" : 12345,
"globalId" : "...",
"tagname" : "...",
"mapname" : "...",
"object" : 12345,
"attributeType" : 12345,
"targetType" : 12345,
"multivalue" : true,
"optimized" : true,
"reserved" : true,
"filesystem" : true,
"foreignlinkAttribute" : "...",
"foreignlinkAttributeRule" : "...",
"category" : "...",
"segmentfield" : true,
"displayfield" : true,
"urlfield" : true,
"elasticsearch" : { },
"micronodeFilter" : "...",
"fragmentName" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"entry" : {
"id" : 12345,
"globalId" : "...",
"tagname" : "...",
"mapname" : "...",
"object" : 12345,
"attributeType" : 12345,
"targetType" : 12345,
"multivalue" : true,
"optimized" : true,
"reserved" : true,
"filesystem" : true,
"foreignlinkAttribute" : "...",
"foreignlinkAttributeRule" : "...",
"category" : "...",
"segmentfield" : true,
"displayfield" : true,
"urlfield" : true,
"elasticsearch" : { },
"micronodeFilter" : "...",
"fragmentName" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the roles currently set in the datasource used in the roles object property for the Mesh ContentRepository
name | type | description |
---|---|---|
id | path | ID of the Mesh ContentRepository |
code | condition |
---|---|
200 | ContentRepository {id} is a Mesh CR with roles property set and currently set roles are returned. |
404 | ContentRepository {id} does not exist. |
409 | ContentRepository {id} is either not a Mesh CR or does not have the roles property set. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | MeshRolesResponse (JSON) | response containing list of role names |
GET /contentrepositories/{id}/roles
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"roles" : [ "...", "..." ],
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Set the roles to be used in the datasource of the roles object property for the Mesh ContentRepository
name | type | description |
---|---|---|
id | path | ID of the Mesh ContentRepository |
media type | data type | description |
---|---|---|
application/json | MeshRolesRequest (JSON) | request containing the roles to set |
code | condition |
---|---|
200 | ContentRepository {id} is a Mesh CR with roles property set and currently set roles are returned. |
400 | The roles could not be set, because not all exist in Mesh |
404 | ContentRepository {id} does not exist. |
409 | ContentRepository {id} is either not a Mesh CR or does not have the roles property set. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | MeshRolesResponse (JSON) | response containing the list of set role names |
POST /contentrepositories/{id}/roles
Content-Type: application/json
Accept: application/json
{
"roles" : [ "...", "..." ]
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"roles" : [ "...", "..." ],
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Remove the ContentRepository Fragment from the ContentRepository
name | type | description |
---|---|---|
crFragmentId | path | internal or external ContentRepository Fragment ID |
id | path | internal or external ContentRepository ID |
code | condition |
---|---|
204 | ContentRepository Fragment {crFragmentId} was removed from the ContentRepository. |
404 | ContentRepository {id} or ContentRepository Fragment {crFragmentId} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | response |
DELETE /contentrepositories/{id}/cr_fragments/{crFragmentId}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
...
Get a ContentRepository Fragment assigned to the ContentRepository
name | type | description |
---|---|---|
crFragmentId | path | internal or external ID of the ContentRepository Fragment |
id | path | internal or external ID of the ContentRepository |
code | condition |
---|---|
200 | ContentRepository Fragment {crFragmentId} is returned. |
404 | ContentRepository {id} or ContentRepository Fragment {crFragmentId} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ContentRepositoryFragmentResponse (JSON) | response containing the ContentRepository Fragment |
GET /contentrepositories/{id}/cr_fragments/{crFragmentId}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"contentRepositoryFragment" : {
"id" : 12345,
"name" : "...",
"globalId" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Assign a ContentRepository Fragment to the ContentRepository
name | type | description |
---|---|---|
crFragmentId | path | internal or external ContentRepository Fragment ID |
id | path | internal or external ContentRepository ID |
code | condition |
---|---|
201 | ContentRepository Fragment {crFragmentId} was assigned. |
404 | ContentRepository {id} or ContentRepository Fragment {crFragmentId} does not exist. |
409 | {crFragmentId} is already assigned to the ContentRepository {id}. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | Response |
PUT /contentrepositories/{id}/cr_fragments/{crFragmentId}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 201 Created
Content-Type: application/json
...
Check the data in the given contentrepository
name | type | description |
---|---|---|
id | path | internal or external ContentRepository ID |
code | condition |
---|---|
200 | ContentRepository {id} exists and was checked. |
404 | ContentRepository {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ContentRepositoryResponse (JSON) | response |
PUT /contentrepositories/{id}/data/check
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"contentRepository" : {
"id" : 12345,
"name" : "...",
"crType" : "mccr",
"dbType" : "...",
"username" : "...",
"password" : "...",
"usePassword" : true,
"url" : "...",
"basepath" : "...",
"instantPublishing" : true,
"languageInformation" : true,
"permissionInformation" : true,
"permissionProperty" : "...",
"defaultPermission" : "...",
"diffDelete" : true,
"elasticsearch" : {
"page" : { },
"folder" : { },
"file" : { }
},
"projectPerNode" : true,
"version" : "...",
"checkDate" : 12345,
"checkStatus" : "running",
"checkResult" : "...",
"statusDate" : 12345,
"dataStatus" : "running",
"dataCheckResult" : "...",
"globalId" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Check and repair the data in the given contentrepository
name | type | description |
---|---|---|
id | path | internal or external ContentRepository ID |
code | condition |
---|---|
200 | ContentRepository {id} exists and was checked and repair attempted. |
404 | ContentRepository {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ContentRepositoryResponse (JSON) | response |
PUT /contentrepositories/{id}/data/repair
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"contentRepository" : {
"id" : 12345,
"name" : "...",
"crType" : "cr",
"dbType" : "...",
"username" : "...",
"password" : "...",
"usePassword" : true,
"url" : "...",
"basepath" : "...",
"instantPublishing" : true,
"languageInformation" : true,
"permissionInformation" : true,
"permissionProperty" : "...",
"defaultPermission" : "...",
"diffDelete" : true,
"elasticsearch" : {
"page" : { },
"folder" : { },
"file" : { }
},
"projectPerNode" : true,
"version" : "...",
"checkDate" : 12345,
"checkStatus" : "unchecked",
"checkResult" : "...",
"statusDate" : 12345,
"dataStatus" : "ok",
"dataCheckResult" : "...",
"globalId" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Check consistency of tagmap entries and return inconsistencies
name | type | description |
---|---|---|
id | path | internal or external ID |
code | condition |
---|---|
200 | Consistency of ContentRepository {id} was checked. |
404 | ContentRepository {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | TagmapEntryConsistencyResponse (JSON) | consistency check result |
GET /contentrepositories/{id}/entries/check
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"perms" : {
"property1" : [ "createoverview", "importitems" ],
"property2" : [ "publish", "updateconstructs" ]
},
"stagingStatus" : {
"property1" : {
"packageName" : "...",
"included" : true
},
"property2" : {
"packageName" : "...",
"included" : true
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Delete the tagmap entry
name | type | description |
---|---|---|
entryId | path | internal or external entry ID |
id | path | internal or external ContentRepository ID |
code | condition |
---|---|
204 | Entry {entryId} was deleted. |
404 | ContentRepository {id} or Entry {entryId} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | response |
DELETE /contentrepositories/{id}/entries/{entryId}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
...
Get a tagmap entry
name | type | description |
---|---|---|
entryId | path | internal or external ID of the entry |
id | path | internal or external ID of the ContentRepository |
code | condition |
---|---|
200 | Entry {entryId} is returned. |
404 | ContentRepository {id} or Entry {entryId} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | TagmapEntryResponse (JSON) | response containing the entry |
GET /contentrepositories/{id}/entries/{entryId}
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"entry" : {
"id" : 12345,
"globalId" : "...",
"tagname" : "...",
"mapname" : "...",
"object" : 12345,
"attributeType" : 12345,
"targetType" : 12345,
"multivalue" : true,
"optimized" : true,
"reserved" : true,
"filesystem" : true,
"foreignlinkAttribute" : "...",
"foreignlinkAttributeRule" : "...",
"category" : "...",
"segmentfield" : true,
"displayfield" : true,
"urlfield" : true,
"elasticsearch" : { },
"micronodeFilter" : "...",
"fragmentName" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Update tagmap entry
name | type | description |
---|---|---|
entryId | path | internal or external entry ID |
id | path | internal or external ContentRepository ID |
media type | data type | description |
---|---|---|
application/json | TagmapEntryModel (JSON) | updated entry |
code | condition |
---|---|
201 | Entry {entryId} was updated. |
404 | ContentRepository {id} or Entry {entryId} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | TagmapEntryResponse (JSON) | updated entry |
PUT /contentrepositories/{id}/entries/{entryId}
Content-Type: application/json
Accept: application/json
{
"id" : 12345,
"globalId" : "...",
"tagname" : "...",
"mapname" : "...",
"object" : 12345,
"attributeType" : 12345,
"targetType" : 12345,
"multivalue" : true,
"optimized" : true,
"reserved" : true,
"filesystem" : true,
"foreignlinkAttribute" : "...",
"foreignlinkAttributeRule" : "...",
"category" : "...",
"segmentfield" : true,
"displayfield" : true,
"urlfield" : true,
"elasticsearch" : { },
"micronodeFilter" : "...",
"fragmentName" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"entry" : {
"id" : 12345,
"globalId" : "...",
"tagname" : "...",
"mapname" : "...",
"object" : 12345,
"attributeType" : 12345,
"targetType" : 12345,
"multivalue" : true,
"optimized" : true,
"reserved" : true,
"filesystem" : true,
"foreignlinkAttribute" : "...",
"foreignlinkAttributeRule" : "...",
"category" : "...",
"segmentfield" : true,
"displayfield" : true,
"urlfield" : true,
"elasticsearch" : { },
"micronodeFilter" : "...",
"fragmentName" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Check the connectivity and structure of the given contentrepository
name | type | description | default | constraints |
---|---|---|---|---|
id | path | internal or external ContentRepository ID | ||
wait | query | wait timeout in ms. When set to 0, response will be sent, when the action completes | 0 | long |
code | condition |
---|---|
200 | ContentRepository {id} exists and was checked. |
404 | ContentRepository {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ContentRepositoryResponse (JSON) | response |
PUT /contentrepositories/{id}/structure/check
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"contentRepository" : {
"id" : 12345,
"name" : "...",
"crType" : "mccr",
"dbType" : "...",
"username" : "...",
"password" : "...",
"usePassword" : true,
"url" : "...",
"basepath" : "...",
"instantPublishing" : true,
"languageInformation" : true,
"permissionInformation" : true,
"permissionProperty" : "...",
"defaultPermission" : "...",
"diffDelete" : true,
"elasticsearch" : {
"page" : { },
"folder" : { },
"file" : { }
},
"projectPerNode" : true,
"version" : "...",
"checkDate" : 12345,
"checkStatus" : "error",
"checkResult" : "...",
"statusDate" : 12345,
"dataStatus" : "unchecked",
"dataCheckResult" : "...",
"globalId" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Check and repair the connectivity and structure of the given contentrepository
name | type | description | default | constraints |
---|---|---|---|---|
id | path | internal or external ContentRepository ID | ||
wait | query | wait timeout in ms. When set to 0, response will be sent, when the action completes | 0 | long |
code | condition |
---|---|
200 | ContentRepository {id} exists and was checked and repair attempted. |
404 | ContentRepository {id} does not exist. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ContentRepositoryResponse (JSON) | response |
PUT /contentrepositories/{id}/structure/repair
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"contentRepository" : {
"id" : 12345,
"name" : "...",
"crType" : "mesh",
"dbType" : "...",
"username" : "...",
"password" : "...",
"usePassword" : true,
"url" : "...",
"basepath" : "...",
"instantPublishing" : true,
"languageInformation" : true,
"permissionInformation" : true,
"permissionProperty" : "...",
"defaultPermission" : "...",
"diffDelete" : true,
"elasticsearch" : {
"page" : { },
"folder" : { },
"file" : { }
},
"projectPerNode" : true,
"version" : "...",
"checkDate" : 12345,
"checkStatus" : "error",
"checkResult" : "...",
"statusDate" : 12345,
"dataStatus" : "error",
"dataCheckResult" : "...",
"globalId" : "..."
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}