ContentRepositoryResource Resource

Resource for handling ContentRepositories

GET /contentrepositories

List available ContentRepositories.
The result can be filtered by

  • id
  • globalId
  • name
  • crType
  • dbType
  • username
  • url
  • basepath
and sorted by
  • id
  • globalId
  • name
  • crType
  • dbType
  • username
  • url
  • basepath
  • instantPublishing
  • languageInformation
  • permissionInformation
  • diffDelete
  • checkDate
  • checkStatus
  • statusDate
  • dataStatus

Request Parameters
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  
Response Codes
code condition
200 ContentRepository list is returned.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json ContentRepositoryListResponse (JSON) List of ContentRepositories
application/xml object

Example

Request
GET /contentrepositories
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ {
    "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" : "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" : "ok",
    "checkResult" : "...",
    "statusDate" : 12345,
    "dataStatus" : "unchecked",
    "dataCheckResult" : "...",
    "globalId" : "..."
  } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "deleteform", "deletefolder" ],
    "property2" : [ "delete", "createtemplates" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /contentrepositories

Create a new ContentRepository

Request Body
media type data type description
application/json ContentRepositoryModel (JSON) ContentRepository to create
application/xml object
Response Codes
code condition
201 ContentRepository was created.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json ContentRepositoryResponse (JSON) created ContentRepository
application/xml object

Example

Request
POST /contentrepositories
Content-Type: application/json
Accept: application/json

                
{
  "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" : "unchecked",
  "checkResult" : "...",
  "statusDate" : 12345,
  "dataStatus" : "error",
  "dataCheckResult" : "...",
  "globalId" : "..."
}
Response
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" : "unchecked",
    "dataCheckResult" : "...",
    "globalId" : "..."
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

DELETE /contentrepositories/{id}

Delete the ContentRepository with given id

Request Parameters
name type description
id path internal or external ContentRepository ID
Response Codes
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.
Response Body
media type data type description
application/json object (JSON) response
application/xml object

Example

Request
DELETE /contentrepositories/{id}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

GET /contentrepositories/{id}

Get the ContentRepository with given id

Request Parameters
name type description
id path internal or external ContentRepository ID
Response Codes
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.
Response Body
media type data type description
application/json ContentRepositoryResponse (JSON) Response containing the ContentRepository
application/xml object

Example

Request
GET /contentrepositories/{id}
Content-Type: application/json
Accept: application/json

                
...
Response
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" : "error",
    "dataCheckResult" : "...",
    "globalId" : "..."
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /contentrepositories/{id}

Update ContentRepository with given id

Request Parameters
name type description
id path internal or external ContentRepository ID
Request Body
media type data type description
application/json ContentRepositoryModel (JSON) updated ContentRepository
application/xml object
Response Codes
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.
Response Body
media type data type description
application/json ContentRepositoryResponse (JSON) updated ContentRepository
application/xml object

Example

Request
PUT /contentrepositories/{id}
Content-Type: application/json
Accept: application/json

                
{
  "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" : "unchecked",
  "checkResult" : "...",
  "statusDate" : 12345,
  "dataStatus" : "ok",
  "dataCheckResult" : "...",
  "globalId" : "..."
}
Response
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" : "queued",
    "dataCheckResult" : "...",
    "globalId" : "..."
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /contentrepositories/{id}/availableroles

Get the roles available in the Mesh instance for the Mesh ContentRepository

Request Parameters
name type description
id path ID of the Mesh ContentRepository
Response Codes
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.
Response Body
media type data type description
application/json MeshRolesResponse (JSON) response containing list of role names
application/xml object

Example

Request
GET /contentrepositories/{id}/availableroles
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "roles" : [ "...", "..." ],
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /contentrepositories/{id}/copy

Copy a ContentRepotiroy

Request Parameters
name type description
id path internal or external ID of the ContentRepository to copy
Response Codes
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.
Response Body
media type data type description
application/json ContentRepositoryResponse (JSON) response containing the copy
application/xml object

Example

Request
PUT /contentrepositories/{id}/copy
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
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" : "unchecked",
    "checkResult" : "...",
    "statusDate" : 12345,
    "dataStatus" : "running",
    "dataCheckResult" : "...",
    "globalId" : "..."
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /contentrepositories/{id}/cr_fragments

Get the ContnetRepository Fragments assigned to the ContentRepository.
The result can be filtered by

  • id
  • globalId
  • name
and sorted by
  • id
  • globalId
  • name

Request Parameters
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  
Response Codes
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.
Response Body
media type data type description
application/json ContentRepositoryFragmentListResponse (JSON) list of Cr Fragments
application/xml object

Example

Request
GET /contentrepositories/{id}/cr_fragments
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ {
    "id" : 12345,
    "name" : "...",
    "globalId" : "..."
  }, {
    "id" : 12345,
    "name" : "...",
    "globalId" : "..."
  } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "deleteform", "edit" ],
    "property2" : [ "publish", "read" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /contentrepositories/{id}/entries

Get the entries in the ContentRepository.
The result can be filtered by

  • id
  • globalId
  • tagname
  • mapname
  • foreignlinkAttribute
  • foreignlinkAttributeRule
  • category
  • fragmentName
and sorted by
  • id
  • globalId
  • tagname
  • mapname
  • object
  • attributeType
  • targetType
  • multivalue
  • optimized
  • filesystem
  • foreignlinkAttribute
  • foreignlinkAttributeRule
  • category
  • segmentfield
  • displayfield
  • urlfield
  • fragmentName

Request Parameters
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  
Response Codes
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.
Response Body
media type data type description
application/json TagmapEntryListResponse (JSON) list of entries
application/xml object

Example

Request
GET /contentrepositories/{id}/entries
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "updateitems", "deletetemplates" ],
    "property2" : [ "view", "updatetemplates" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /contentrepositories/{id}/entries

Create a new tagmap entry

Request Parameters
name type description
id path internal or external ID of the ContentRepository
Request Body
media type data type description
application/json TagmapEntryModel (JSON) entry to create
application/xml object
Response Codes
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.
Response Body
media type data type description
application/json TagmapEntryResponse (JSON) created entry
application/xml object

Example

Request
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" : "..."
}
Response
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 /contentrepositories/{id}/roles

Get the roles currently set in the datasource used in the roles object property for the Mesh ContentRepository

Request Parameters
name type description
id path ID of the Mesh ContentRepository
Response Codes
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.
Response Body
media type data type description
application/json MeshRolesResponse (JSON) response containing list of role names
application/xml object

Example

Request
GET /contentrepositories/{id}/roles
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "roles" : [ "...", "..." ],
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /contentrepositories/{id}/roles

Set the roles to be used in the datasource of the roles object property for the Mesh ContentRepository

Request Parameters
name type description
id path ID of the Mesh ContentRepository
Request Body
media type data type description
application/json MeshRolesRequest (JSON) request containing the roles to set
application/xml object
Response Codes
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.
Response Body
media type data type description
application/json MeshRolesResponse (JSON) response containing the list of set role names
application/xml object

Example

Request
POST /contentrepositories/{id}/roles
Content-Type: application/json
Accept: application/json

                
{
  "roles" : [ "...", "..." ]
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "roles" : [ "...", "..." ],
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

DELETE /contentrepositories/{id}/cr_fragments/{crFragmentId}

Remove the ContentRepository Fragment from the ContentRepository

Request Parameters
name type description
crFragmentId path internal or external ContentRepository Fragment ID
id path internal or external ContentRepository ID
Response Codes
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.
Response Body
media type data type description
application/json object (JSON) response
application/xml object

Example

Request
DELETE /contentrepositories/{id}/cr_fragments/{crFragmentId}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

GET /contentrepositories/{id}/cr_fragments/{crFragmentId}

Get a ContentRepository Fragment assigned to the ContentRepository

Request Parameters
name type description
crFragmentId path internal or external ID of the ContentRepository Fragment
id path internal or external ID of the ContentRepository
Response Codes
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.
Response Body
media type data type description
application/json ContentRepositoryFragmentResponse (JSON) response containing the ContentRepository Fragment
application/xml object

Example

Request
GET /contentrepositories/{id}/cr_fragments/{crFragmentId}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "contentRepositoryFragment" : {
    "id" : 12345,
    "name" : "...",
    "globalId" : "..."
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /contentrepositories/{id}/cr_fragments/{crFragmentId}

Assign a ContentRepository Fragment to the ContentRepository

Request Parameters
name type description
crFragmentId path internal or external ContentRepository Fragment ID
id path internal or external ContentRepository ID
Response Codes
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.
Response Body
media type data type description
application/json object (JSON) Response
application/xml object

Example

Request
PUT /contentrepositories/{id}/cr_fragments/{crFragmentId}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

PUT /contentrepositories/{id}/data/check

Check the data in the given contentrepository

Request Parameters
name type description
id path internal or external ContentRepository ID
Response Codes
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.
Response Body
media type data type description
application/json ContentRepositoryResponse (JSON) response
application/xml object

Example

Request
PUT /contentrepositories/{id}/data/check
Content-Type: application/json
Accept: application/json

                
...
Response
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" : "unchecked",
    "checkResult" : "...",
    "statusDate" : 12345,
    "dataStatus" : "error",
    "dataCheckResult" : "...",
    "globalId" : "..."
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /contentrepositories/{id}/data/repair

Check and repair the data in the given contentrepository

Request Parameters
name type description
id path internal or external ContentRepository ID
Response Codes
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.
Response Body
media type data type description
application/json ContentRepositoryResponse (JSON) response
application/xml object

Example

Request
PUT /contentrepositories/{id}/data/repair
Content-Type: application/json
Accept: application/json

                
...
Response
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" : "error",
    "dataCheckResult" : "...",
    "globalId" : "..."
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /contentrepositories/{id}/entries/check

Check consistency of tagmap entries and return inconsistencies

Request Parameters
name type description
id path internal or external ID
Response Codes
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.
Response Body
media type data type description
application/json TagmapEntryConsistencyResponse (JSON) consistency check result
application/xml object

Example

Request
GET /contentrepositories/{id}/entries/check
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "updatefolder", "updateform" ],
    "property2" : [ "updatefolder", "readitems" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

DELETE /contentrepositories/{id}/entries/{entryId}

Delete the tagmap entry

Request Parameters
name type description
entryId path internal or external entry ID
id path internal or external ContentRepository ID
Response Codes
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.
Response Body
media type data type description
application/json object (JSON) response
application/xml object

Example

Request
DELETE /contentrepositories/{id}/entries/{entryId}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

GET /contentrepositories/{id}/entries/{entryId}

Get a tagmap entry

Request Parameters
name type description
entryId path internal or external ID of the entry
id path internal or external ID of the ContentRepository
Response Codes
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.
Response Body
media type data type description
application/json TagmapEntryResponse (JSON) response containing the entry
application/xml object

Example

Request
GET /contentrepositories/{id}/entries/{entryId}
Content-Type: application/json
Accept: application/json

                
...
Response
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" : "..."
  }
}

PUT /contentrepositories/{id}/entries/{entryId}

Update tagmap entry

Request Parameters
name type description
entryId path internal or external entry ID
id path internal or external ContentRepository ID
Request Body
media type data type description
application/json TagmapEntryModel (JSON) updated entry
application/xml object
Response Codes
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.
Response Body
media type data type description
application/json TagmapEntryResponse (JSON) updated entry
application/xml object

Example

Request
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" : "..."
}
Response
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" : "..."
  }
}

PUT /contentrepositories/{id}/structure/check

Check the connectivity and structure of the given contentrepository

Request Parameters
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
Response Codes
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.
Response Body
media type data type description
application/json ContentRepositoryResponse (JSON) response
application/xml object

Example

Request
PUT /contentrepositories/{id}/structure/check
Content-Type: application/json
Accept: application/json

                
...
Response
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" : "ok",
    "checkResult" : "...",
    "statusDate" : 12345,
    "dataStatus" : "running",
    "dataCheckResult" : "...",
    "globalId" : "..."
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /contentrepositories/{id}/structure/repair

Check and repair the connectivity and structure of the given contentrepository

Request Parameters
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
Response Codes
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.
Response Body
media type data type description
application/json ContentRepositoryResponse (JSON) response
application/xml object

Example

Request
PUT /contentrepositories/{id}/structure/repair
Content-Type: application/json
Accept: application/json

                
...
Response
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" : "unchecked",
    "checkResult" : "...",
    "statusDate" : 12345,
    "dataStatus" : "unchecked",
    "dataCheckResult" : "...",
    "globalId" : "..."
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}