Introduction

IBM Content Manager REST services provide a set of programmatic RESTful APIs allowing you to access and interface with data in Content Manager repositories.  This guide was auto-generated using the APIs to provide examples and will help you develop applications using the APIs.

Ping API

Operations available for ping.

request
GET /cm8app/cm8rest/v1/ping HTTP/1.1
Host: cm8.unicom.com
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 9c001739-2e17-4089-94dc-d5cf342a481d
Content-Type: application/json
Content-Length: 212
Date: Mon, 18 Nov 2024 20:10:32 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "started",
  "version" : "8.7.00.400.95 - 2024-11-18 12:10:04:004 PST",
  "java.runtime.version" : "11.0.5+10",
  "os.name" : "Linux",
  "tokenDuration" : "30",
  "enableConnectionPool" : "false"
}

Login API

Operations available for authenticating.

request
POST /cm8app/cm8rest/v1/login HTTP/1.1
Content-Type: application/json
Host: cm8.unicom.com
Content-Length: 85

{
  "password" : "********",
  "servername" : "icmnlsdb",
  "username" : "icmadmin"
}
request fields
Path Type Description

servername

String

Server name or alias that represents a content manager repository to connect to

username

String

User name for establishing the connection

password

String

User’s password

connectString

String

(optional) Connect string to provide server-specfic connection options. This will be ignored when connection pooling is enabled.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 835d8443-1d07-46d0-8b99-7498b393129f:icmadmin:icmnlsdb:-73569268:null
Content-Type: text/plain
Content-Length: 164
Date: Mon, 18 Nov 2024 20:10:34 GMT
Keep-Alive: timeout=60
Connection: keep-alive

Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA

Itemtypes API

Operations available for item types.

GET /itemtypes

Retrieve a list of item types associated with a datastore.

request
GET /cm8app/cm8rest/v1/itemtypes HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request query parameters
Parameter Description

classification

(optional) Item type classification to filter on, {0|1|2|3}
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 9b155660-0502-4dd2-97d0-4552fc718231:icmadmin:icmnlsdb:-1615555951:null
Content-Type: application/json
Content-Length: 2305
Date: Mon, 18 Nov 2024 20:10:34 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "itemtypes" : [ {
    "name" : "XYZ_PolReport",
    "description" : "Police Report (Content Manager Sample Item Type)",
    "id" : 1016,
    "classification" : 2,
    "classificationName" : "Document",
    "isRoot" : true
  }, {
    "name" : "XYZ_InsPolicy",
    "description" : "Insurance Policy (Content Manager Sample Item Type)",
    "id" : 1015,
    "classification" : 2,
    "classificationName" : "Document",
    "isRoot" : true
  }, {
    "name" : "XYZ_ClaimForm",
    "description" : "Auto Claim Form (Content Manager Sample Item Type)",
    "id" : 1014,
    "classification" : 2,
    "classificationName" : "Document",
    "isRoot" : true
  }, {
    "name" : "XYZ_AutoPhoto",
    "description" : "Auto Photo (Content Manager Sample Item Type)",
    "id" : 1013,
    "classification" : 2,
    "classificationName" : "Document",
    "isRoot" : true
  }, {
    "name" : "XYZ_AdjReport",
    "description" : "Adjuster Report (Content Manager Sample Item Type)",
    "id" : 1012,
    "classification" : 2,
    "classificationName" : "Document",
    "isRoot" : true
  }, {
    "name" : "XYZ_ClaimFolder",
    "description" : "Claim Application Folder to contain other claim related documents (e.g. adjuster report, auto photos, claim form, etc) and linked by Claim Number",
    "id" : 1011,
    "classification" : 2,
    "classificationName" : "Document",
    "isRoot" : true
  }, {
    "name" : "ICMSearch",
    "description" : "ICMSearch",
    "id" : 1004,
    "classification" : 0,
    "classificationName" : "Item",
    "isRoot" : true
  }, {
    "name" : "ICMDRFOLDERS",
    "description" : "Document Routing Folders",
    "id" : 1003,
    "classification" : 2,
    "classificationName" : "Document",
    "isRoot" : true
  }, {
    "name" : "ICMFORMS",
    "description" : "Form Overlays for use with CM Clients",
    "id" : 1002,
    "classification" : 1,
    "classificationName" : "Resource Item",
    "isRoot" : true
  }, {
    "name" : "ICMSAVEDSEARCH",
    "description" : "ICM Saved Search",
    "id" : 1001,
    "classification" : 0,
    "classificationName" : "Item",
    "isRoot" : true
  }, {
    "name" : "NOINDEX",
    "description" : "NOINDEX",
    "id" : 1000,
    "classification" : 2,
    "classificationName" : "Document",
    "isRoot" : true
  } ]
}
Path Type Description

status

String

Status of the request

itemtypes

Array

An array of itemtypes

itemtypes[].name

String

Name of itemtype

itemtypes[].description

String

Description of itemtype

itemtypes[].id

Number

ID of itemtype

itemtypes[].isRoot

Boolean

Is it a root itemtype

itemtypes[].classification

Number

Classification of itemtype

itemtypes[].classificationName

String

Classification name of itemtype

GET /itemtypes?classification={0|1|2|3}

List all item types associated with a datastore, filtered by classification of 0, 1, 2 or 3.

request
GET /cm8app/cm8rest/v1/itemtypes?classification=2 HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request query parameters
Parameter Description

classification

(optional) Item type classification to filter on, {0|1|2|3}
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 7aa4ce18-2a41-43d2-938a-0d8470215e3c:icmadmin:icmnlsdb:1322598942:null
Content-Type: application/json
Content-Length: 1765
Date: Mon, 18 Nov 2024 20:10:35 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "itemtypes" : [ {
    "name" : "XYZ_PolReport",
    "description" : "Police Report (Content Manager Sample Item Type)",
    "id" : 1016,
    "classification" : 2,
    "classificationName" : "Document",
    "isRoot" : true
  }, {
    "name" : "XYZ_InsPolicy",
    "description" : "Insurance Policy (Content Manager Sample Item Type)",
    "id" : 1015,
    "classification" : 2,
    "classificationName" : "Document",
    "isRoot" : true
  }, {
    "name" : "XYZ_ClaimForm",
    "description" : "Auto Claim Form (Content Manager Sample Item Type)",
    "id" : 1014,
    "classification" : 2,
    "classificationName" : "Document",
    "isRoot" : true
  }, {
    "name" : "XYZ_AutoPhoto",
    "description" : "Auto Photo (Content Manager Sample Item Type)",
    "id" : 1013,
    "classification" : 2,
    "classificationName" : "Document",
    "isRoot" : true
  }, {
    "name" : "XYZ_AdjReport",
    "description" : "Adjuster Report (Content Manager Sample Item Type)",
    "id" : 1012,
    "classification" : 2,
    "classificationName" : "Document",
    "isRoot" : true
  }, {
    "name" : "XYZ_ClaimFolder",
    "description" : "Claim Application Folder to contain other claim related documents (e.g. adjuster report, auto photos, claim form, etc) and linked by Claim Number",
    "id" : 1011,
    "classification" : 2,
    "classificationName" : "Document",
    "isRoot" : true
  }, {
    "name" : "ICMDRFOLDERS",
    "description" : "Document Routing Folders",
    "id" : 1003,
    "classification" : 2,
    "classificationName" : "Document",
    "isRoot" : true
  }, {
    "name" : "NOINDEX",
    "description" : "NOINDEX",
    "id" : 1000,
    "classification" : 2,
    "classificationName" : "Document",
    "isRoot" : true
  } ]
}
Path Type Description

status

String

Status of the request

itemtypes

Array

An array of itemtypes

itemtypes[].name

String

Name of itemtype

itemtypes[].description

String

Description of itemtype

itemtypes[].id

Number

ID of itemtype

itemtypes[].isRoot

Boolean

Is it a root itemtype

itemtypes[].classification

Number

Classification of itemtype

itemtypes[].classificationName

String

Classification name of itemtype

GET /itemtypes/{name}

Retrieve an item type associated with a datastore.

request
GET /cm8app/cm8rest/v1/itemtypes/NOINDEX HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request path parameters
Parameter Description

name

Item type name
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 4204e05c-fe0d-470d-907e-e560ee6044ec:icmadmin:icmnlsdb:-1825679134:null
Content-Type: application/json
Content-Length: 205
Date: Mon, 18 Nov 2024 20:10:34 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "itemtype" : {
    "name" : "NOINDEX",
    "description" : "NOINDEX",
    "id" : 1000,
    "classification" : 2,
    "classificationName" : "Document",
    "isRoot" : true
  }
}
Path Type Description

status

String

Status of the request

itemtype

Object

Details of the itemtype

GET /itemtypes/{name}?include=attributes

Retrieve an item type and include details on the attributes and child components in the item type.

request
GET /cm8app/cm8rest/v1/itemtypes/NOINDEX?include=attributes HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request path parameters
Parameter Description

name

Item type name
request query parameters
Parameter Description

include

(optional) Details to include with the item type, {attributes}
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 2e0cb5d5-c362-4248-bc3e-1e841f719b31:icmadmin:icmnlsdb:816422014:null
Content-Type: application/json
Content-Length: 1164
Date: Mon, 18 Nov 2024 20:10:34 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "itemtype" : {
    "name" : "NOINDEX",
    "description" : "NOINDEX",
    "id" : 1000,
    "classification" : 2,
    "classificationName" : "Document",
    "attributes" : [ {
      "name" : "SOURCE",
      "description" : "Source",
      "type" : 1,
      "id" : 1001,
      "viewSequence" : 1,
      "minimum" : 0,
      "maximum" : 32,
      "characterType" : 16,
      "validateCharacterType" : false,
      "representsItem" : true,
      "isRequired" : false,
      "isUnique" : false,
      "isTextSearchable" : false
    }, {
      "name" : "USER_ID",
      "description" : "User ID",
      "type" : 1,
      "id" : 1002,
      "viewSequence" : 2,
      "minimum" : 0,
      "maximum" : 32,
      "characterType" : 4,
      "validateCharacterType" : false,
      "representsItem" : false,
      "isRequired" : false,
      "isUnique" : false,
      "isTextSearchable" : false
    }, {
      "name" : "TIMESTAMP",
      "description" : "Timestamp",
      "type" : 9,
      "id" : 1003,
      "viewSequence" : 3,
      "representsItem" : false,
      "isRequired" : false,
      "isUnique" : false
    } ],
    "isRoot" : true
  }
}
Path Type Description

status

String

Status of the request

itemtype

Object

Details of the itemtype

POST /itemtypes/{name}/items

Create an item.

Multiple content parts can be specified with the parameters parts and contentPartsX ( X should be 1,2…​ one for each part). parts.contentParts[] is an ordered JSON collection of the content parts metadata. The streams contentPartsX are mapped to the contentParts collection in the order specified in the collection. For example, contentParts1 maps to the first part in the collection.

Multiple annotation parts can be specified with the parameters parts and annotationPartsX ( X should be 1,2…​ one for each part). parts.annotationParts[] is an ordered JSON collection of the annotation parts metadata. The streams annotationPartsX are mapped to annotationParts collection in the order specified in the collection. For example, annotationParts1 maps to the first part in the collection.

Multiple notelog parts can be specified with the parameters parts and notelogPartsX ( X should be 1,2…​ one for each part). parts.notelogParts[] is an ordered JSON collection of the notelog parts metadata. The streams notelogPartsX are mapped to notelogParts collection in the order specified in the collection. For example, notelogParts1 maps to the first part in the collection.

request
POST /cm8app/cm8rest/v1/itemtypes/NOINDEX/items HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: multipart/form-data; boundary="69MwBVmiJ8o5Tucv9F7eL2h6afAF3DjrJ9"; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: cm8.unicom.com

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=attributes
Content-Type: application/json

[
    {
        "name": "SOURCE",
        "value": "simple_5page.pdf"
    },
    {
        "name": "USER_ID",
        "value": "user1"
    }
]
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=parts
Content-Type: application/json

{
	"contentParts": [
		{
			"mimetype": "image/tiff",
			"partType": "ICMBASE",
			"size": 13
		},
		{
			"mimetype": "image/tiff",
			"partType": "ICMBASE",
			"size": 24
		}
	],
	"annotationParts": [
		{
			"mimetype": "application/vnd.ibm.modcap",
			"partType": "ICMANNOTATION",
			"size": 19
		}
   ],
	"notelogParts": [
		{
			"mimetype": "text/plain",
			"partType": "ICMNOTELOG",
			"size": 16
		}
   ]
}
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=contentParts1; filename=content.tif
Content-Type: application/octet-stream

<<tiff data>>
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=contentParts2; filename=content2.tif
Content-Type: application/octet-stream

<<tiff data for part 2>>
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=annotationParts1; filename=annotation.t_l
Content-Type: application/octet-stream

<<annotation data>>
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=notelogParts1; filename=notelog.txt
Content-Type: application/octet-stream

<<notelog data>>
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
request path parameters
Parameter Description

name

Item type name
request body form data parts

The order of the multi-part form data is important. The parts meta data must be before the part file streams and the file streams must be in order, where 1 is before 2 and so on.

Part Description

attributes

(optional) Attributes of the item

parts

(optional) Parts meta data of the item

contentParts1

File stream for first content part

contentParts2

File stream for second content part

annotationParts1

File stream for first annotation part

notelogParts1

File stream for first notelog part
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: b816d251-c544-4ff9-87fa-88a4fed71202:icmadmin:icmnlsdb:213316172:null
Content-Type: application/json
Content-Length: 129
Date: Mon, 18 Nov 2024 20:10:37 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item created

POST /itemtypes/{name}/folders

Create a folder.

request
POST /cm8app/cm8rest/v1/itemtypes/NOINDEX/folders HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: application/json
Host: cm8.unicom.com
Content-Length: 99

[ {
  "name" : "SOURCE",
  "value" : "folder"
}, {
  "name" : "USER_ID",
  "value" : "icmadmin"
} ]
request path parameters
Parameter Description

name

Item type name
request fields
Path Type Description

[]

Array

Array of attributes

[].name

String

Name of the attribute

[].value

String

Value of the attribute
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 2d908cce-0e31-4a6d-a8aa-56d9793f07dc:icmadmin:icmnlsdb:-1409163166:null
Content-Type: application/json
Content-Length: 129
Date: Mon, 18 Nov 2024 20:10:49 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21050D0006818 A24K18B21050D000681 14 1000"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the folder created

Items API

Operations available for items.

POST /items/query?limit=10&latestVersion=true

Given a query, retrieve a list of item pids.

request
POST /cm8app/cm8rest/v1/items/query?limit=10&latestVersion=true HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: text/plain; charset=ISO-8859-1
Host: cm8.unicom.com
Content-Length: 8

/NOINDEX
request query parameters
Parameter Description

limit

(optional) Maximum number of items to retrieve. By default, this is 50. Use limit set to 0 to specify no limit.

retrieve

(optional) Specify data to retrieve, {attributes | partsMetaData}. By default, PIDs will be retrieved.

retrieveCheckoutDetail

(optional) Retrieve check out details, {true | false}. By default, this is false.

latestVersion

(optional) Specify whether to retrieve the latest version, {true | false}. By default, this is true.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 52e2e411-b794-4f98-bdef-b26b1cb5dc1f:icmadmin:icmnlsdb:400855341:null
Content-Type: application/json
Content-Length: 972
Date: Mon, 18 Nov 2024 20:10:35 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "items" : [ "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20I21A72245E0143218 A20I21A72245E014321 14 1000", "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20I21A72309E0143418 A20I21A72309E014341 14 1000", "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20I21A72652C0143618 A20I21A72652C014361 14 1000", "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20I21A72752A0143818 A20I21A72752A014381 14 1000", "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20I21A73332F0144018 A20I21A73332F014401 14 1000", "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A23A11B01538I0071718 A23A11B01538I007171 14 1000", "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A23A11B02440C0072318 A23A11B02440C007231 14 1000", "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20F22A82829A0068518 A20F22A82829A006851 14 1000", "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20F09A22532D0039618 A20F09A22532D003961 14 1000", "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24H06A75952C0031018 A24H06A75952C003101 14 1000" ]
}
Path Type Description

status

String

Status of the request

items

Array

Array of retrieved item identifiers, PIDs

POST /items/query?limit=2&retrieve=attributes&latestVersion=false

Given a query, retrieve a list of items with attribute details.

request
POST /cm8app/cm8rest/v1/items/query?limit=2&retrieve=attributes&latestVersion=false HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: text/plain; charset=ISO-8859-1
Host: cm8.unicom.com
Content-Length: 24

/NOINDEX[@VERSIONID = 1]
request query parameters
Parameter Description

limit

(optional) Maximum number of items to retrieve. By default, this is 50. Use limit set to 0 to specify no limit.

retrieve

(optional) Specify data to retrieve, {attributes | partsMetaData}. By default, PIDs will be retrieved.

retrieveCheckoutDetail

(optional) Retrieve check out details, {true | false}. By default, this is false.

latestVersion

(optional) Specify whether to retrieve the latest version, {true | false}. By default, this is true.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 028bcc55-b85e-4a55-8141-804ea3ffdac6:icmadmin:icmnlsdb:430924783:null
Content-Type: application/json
Content-Length: 1440
Date: Mon, 18 Nov 2024 20:10:37 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "items" : [ {
    "itemId" : "A1001001A20I21A72245E01432",
    "version" : "1",
    "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20I21A72245E0143218 A20I21A72245E014321 14 1000",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2020-09-21-07.22.46.334000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2020-09-21-07.22.46.334000",
    "itemtypeName" : "NOINDEX",
    "aclName" : "PublicReadACL",
    "attributes" : [ {
      "name" : "SOURCE",
      "type" : 1,
      "value" : "fiat.pdf"
    }, {
      "name" : "USER_ID",
      "type" : 1
    }, {
      "name" : "TIMESTAMP",
      "type" : 9
    } ],
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false
  }, {
    "itemId" : "A1001001A20I21A72309E01434",
    "version" : "1",
    "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20I21A72309E0143418 A20I21A72309E014341 14 1000",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2020-09-21-07.23.16.077000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2020-09-21-07.23.16.077000",
    "itemtypeName" : "NOINDEX",
    "aclName" : "PublicReadACL",
    "attributes" : [ {
      "name" : "SOURCE",
      "type" : 1,
      "value" : "mini.pdf"
    }, {
      "name" : "USER_ID",
      "type" : 1
    }, {
      "name" : "TIMESTAMP",
      "type" : 9
    } ],
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false
  } ]
}
Path Type Description

status

String

Status of the request

items

Array

Array of retrieved items

items[].version

String

Version of item

items[].pid

String

Identifier of item

items[].itemId

String

Item id from the persistent identifier (pid)

items[].createdUserid

String

Userid that created item

items[].createdTimestamp

String

Timestamp when item was created

items[].updatedUserid

String

Userid that made the last update to this item

items[].updatedTimestamp

String

Timestamp of last update to this item

items[].itemtypeName

String

Name of item type

items[].isDocument

Boolean

Is it a document

items[].isFolder

Boolean

Is it a folder

items[].isItem

Boolean

Is it an item

items[].attributes

Array

Attributes of the item

POST /items/query?limit=2&retrieve=partsMetaData&latestVersion=true

Given a query, retrieve a list of items with attribute and parts meta data detail.

request
POST /cm8app/cm8rest/v1/items/query?limit=2&retrieve=partsMetaData&latestVersion=true HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: text/plain; charset=ISO-8859-1
Host: cm8.unicom.com
Content-Length: 8

/NOINDEX
request query parameters
Parameter Description

limit

(optional) Maximum number of items to retrieve. By default, this is 50. Use limit set to 0 to specify no limit.

retrieve

(optional) Specify data to retrieve, {attributes | partsMetaData}. By default, PIDs will be retrieved.

retrieveCheckoutDetail

(optional) Retrieve check out details, {true | false}. By default, this is false.

latestVersion

(optional) Specify whether to retrieve the latest version, {true | false}. By default, this is true.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: a22b2439-93cf-49b1-a053-e20d795718e7:icmadmin:icmnlsdb:1658936055:null
Content-Type: application/json
Content-Length: 3529
Date: Mon, 18 Nov 2024 20:10:35 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "items" : [ {
    "itemId" : "A1001001A20I21A72245E01432",
    "version" : "1",
    "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20I21A72245E0143218 A20I21A72245E014321 14 1000",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2020-09-21-07.22.46.334000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2020-09-21-07.22.46.334000",
    "itemtypeName" : "NOINDEX",
    "aclName" : "PublicReadACL",
    "attributes" : [ {
      "name" : "SOURCE",
      "type" : 1,
      "value" : "fiat.pdf"
    }, {
      "name" : "USER_ID",
      "type" : 1
    }, {
      "name" : "TIMESTAMP",
      "type" : 9
    } ],
    "parts" : {
      "contentPartsCount" : 1,
      "annotationPartsCount" : 0,
      "notelogPartsCount" : 0,
      "contentParts" : [ {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A20I21A72245E0143318 A20I21A72245E014331 13 300",
        "mimetype" : "application/pdf",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/2020-Fiat.pdf?order=retrieve&item-id=A1001001A20I21A72245E01433&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2020-09-21+14%3A22%3A45.662129000&token=ADUA.Nnt0D2gmia_2_52LXQy1ncjblIit4HaW6sVp1_lgKY4dEl8mtyM83jbh;&content-length=0&content-type=application%2Fpdf",
        "size" : 130473,
        "originalFileName" : "2020-Fiat.pdf",
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2020-09-21 14:22:45.662129000",
        "updatedTimestamp" : "2020-09-21 14:22:45.662129000"
      } ],
      "annotationParts" : [ ],
      "notelogParts" : [ ]
    },
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false
  }, {
    "itemId" : "A1001001A20I21A72309E01434",
    "version" : "1",
    "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20I21A72309E0143418 A20I21A72309E014341 14 1000",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2020-09-21-07.23.16.077000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2020-09-21-07.23.16.077000",
    "itemtypeName" : "NOINDEX",
    "aclName" : "PublicReadACL",
    "attributes" : [ {
      "name" : "SOURCE",
      "type" : 1,
      "value" : "mini.pdf"
    }, {
      "name" : "USER_ID",
      "type" : 1
    }, {
      "name" : "TIMESTAMP",
      "type" : 9
    } ],
    "parts" : {
      "contentPartsCount" : 1,
      "annotationPartsCount" : 0,
      "notelogPartsCount" : 0,
      "contentParts" : [ {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A20I21A72309E0143518 A20I21A72309E014351 13 300",
        "mimetype" : "application/pdf",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/MINI-2020-Full-Line-Brochure.pdf?order=retrieve&item-id=A1001001A20I21A72309E01435&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2020-09-21+14%3A23%3A09.695133000&token=ADUA.Nnt0D2gmia_2_70NEkpgdj1vLJupwGxT8G.ulyjIvR_oQw1ZCdBaGaz8;&content-length=0&content-type=application%2Fpdf",
        "size" : 2612295,
        "originalFileName" : "MINI-2020-Full-Line-Brochure.pdf",
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2020-09-21 14:23:09.695133000",
        "updatedTimestamp" : "2020-09-21 14:23:09.695133000"
      } ],
      "annotationParts" : [ ],
      "notelogParts" : [ ]
    },
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false
  } ]
}
Path Type Description

status

String

Status of the request

items

Array

Array of retrieved items

POST /items

Retrieve a list of items for a given list of pids.

request
POST /cm8app/cm8rest/v1/items HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: application/json
Host: cm8.unicom.com
Content-Length: 932

[ "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20I21A72245E0143218 A20I21A72245E014321 14 1000", "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20I21A72309E0143418 A20I21A72309E014341 14 1000", "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20I21A72652C0143618 A20I21A72652C014361 14 1000", "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20I21A72752A0143818 A20I21A72752A014381 14 1000", "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20I21A73332F0144018 A20I21A73332F014401 14 1000", "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A23A11B01538I0071718 A23A11B01538I007171 14 1000", "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A23A11B02440C0072318 A23A11B02440C007231 14 1000", "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20F22A82829A0068518 A20F22A82829A006851 14 1000", "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20F09A22532D0039618 A20F09A22532D003961 14 1000", "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24H06A75952C0031018 A24H06A75952C003101 14 1000" ]
request query parameters
Parameter Description

retrieve

(optional) Specify data to retrieve, {attributes | partsMetaData}. By default, this is set to partsMetaData.

retrieveCheckoutDetail

(optional) Retrieve check out details, {true | false}. By default, this is false.

checkout

(optional) Check out retrieved items, {true | false}. By default, this is false.

version

(optional) Specify to retrieve the latest version or the specific version identified in the PID, {latest | specific}. The default value is latest.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: c8cc5dd7-55bb-4f95-a3f8-d1ec5a834369:icmadmin:icmnlsdb:1820528706:null
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 18 Nov 2024 20:10:35 GMT
Keep-Alive: timeout=60
Connection: keep-alive
Content-Length: 23834

{
  "status" : "success",
  "items" : [ {
    "itemId" : "A1001001A20I21A72245E01432",
    "version" : "1",
    "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20I21A72245E0143218 A20I21A72245E014321 14 1000",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2020-09-21-07.22.46.334000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2020-09-21-07.22.46.334000",
    "itemtypeName" : "NOINDEX",
    "aclName" : "PublicReadACL",
    "attributes" : [ {
      "name" : "SOURCE",
      "type" : 1,
      "value" : "fiat.pdf"
    }, {
      "name" : "USER_ID",
      "type" : 1
    }, {
      "name" : "TIMESTAMP",
      "type" : 9
    } ],
    "parts" : {
      "contentPartsCount" : 1,
      "annotationPartsCount" : 0,
      "notelogPartsCount" : 0,
      "contentParts" : [ {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A20I21A72245E0143318 A20I21A72245E014331 13 300",
        "mimetype" : "application/pdf",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/2020-Fiat.pdf?order=retrieve&item-id=A1001001A20I21A72245E01433&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2020-09-21+14%3A22%3A45.662129000&token=ADUA.Nnt0CogmhbU2_BZVDF.rCY3B0b_UP54ARyHBSxXxiJcNDXiyXMDIic7o;&content-length=0&content-type=application%2Fpdf",
        "size" : 130473,
        "originalFileName" : "2020-Fiat.pdf",
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2020-09-21 14:22:45.662129000",
        "updatedTimestamp" : "2020-09-21 14:22:45.662129000"
      } ],
      "annotationParts" : [ ],
      "notelogParts" : [ ]
    },
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false
  }, {
    "itemId" : "A1001001A20I21A72309E01434",
    "version" : "1",
    "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20I21A72309E0143418 A20I21A72309E014341 14 1000",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2020-09-21-07.23.16.077000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2020-09-21-07.23.16.077000",
    "itemtypeName" : "NOINDEX",
    "aclName" : "PublicReadACL",
    "attributes" : [ {
      "name" : "SOURCE",
      "type" : 1,
      "value" : "mini.pdf"
    }, {
      "name" : "USER_ID",
      "type" : 1
    }, {
      "name" : "TIMESTAMP",
      "type" : 9
    } ],
    "parts" : {
      "contentPartsCount" : 1,
      "annotationPartsCount" : 0,
      "notelogPartsCount" : 0,
      "contentParts" : [ {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A20I21A72309E0143518 A20I21A72309E014351 13 300",
        "mimetype" : "application/pdf",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/MINI-2020-Full-Line-Brochure.pdf?order=retrieve&item-id=A1001001A20I21A72309E01435&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2020-09-21+14%3A23%3A09.695133000&token=ADUA.Nnt0CogmhbU2_._vyzcpeH5jNfYgIK1m7fj4si_kY5.ks1F_lTHp_9Va;&content-length=0&content-type=application%2Fpdf",
        "size" : 2612295,
        "originalFileName" : "MINI-2020-Full-Line-Brochure.pdf",
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2020-09-21 14:23:09.695133000",
        "updatedTimestamp" : "2020-09-21 14:23:09.695133000"
      } ],
      "annotationParts" : [ ],
      "notelogParts" : [ ]
    },
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false
  }, {
    "itemId" : "A1001001A20I21A72652C01436",
    "version" : "1",
    "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20I21A72652C0143618 A20I21A72652C014361 14 1000",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2020-09-21-07.26.59.739000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2020-09-21-07.28.57.708000",
    "itemtypeName" : "NOINDEX",
    "aclName" : "PublicReadACL",
    "attributes" : [ {
      "name" : "SOURCE",
      "type" : 1,
      "value" : "VW-KarmannGhia_1957.pdf"
    }, {
      "name" : "USER_ID",
      "type" : 1
    }, {
      "name" : "TIMESTAMP",
      "type" : 9
    } ],
    "parts" : {
      "contentPartsCount" : 1,
      "annotationPartsCount" : 0,
      "notelogPartsCount" : 0,
      "contentParts" : [ {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A20I21A72652C0143718 A20I21A72652C014371 13 300",
        "mimetype" : "application/pdf",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/VW_int%20KarmannGhia_1957.pdf?order=retrieve&item-id=A1001001A20I21A72652C01437&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2020-09-21+14%3A26%3A52.462220000&token=ADUA.Nnt0CogmhbU2_1LNYyhMDoRnaiusA2zQTYMlKDKRW8BTSfWiA15p7cBX;&content-length=0&content-type=application%2Fpdf",
        "size" : 2448755,
        "originalFileName" : "VW_int KarmannGhia_1957.pdf",
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2020-09-21 14:26:52.462220000",
        "updatedTimestamp" : "2020-09-21 14:26:52.462220000"
      } ],
      "annotationParts" : [ ],
      "notelogParts" : [ ]
    },
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false
  }, {
    "itemId" : "A1001001A20I21A72752A01438",
    "version" : "1",
    "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20I21A72752A0143818 A20I21A72752A014381 14 1000",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2020-09-21-07.27.56.539000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2020-09-21-07.27.56.539000",
    "itemtypeName" : "NOINDEX",
    "aclName" : "PublicReadACL",
    "attributes" : [ {
      "name" : "SOURCE",
      "type" : 1,
      "value" : "VW-Golf_2018.pdf"
    }, {
      "name" : "USER_ID",
      "type" : 1
    }, {
      "name" : "TIMESTAMP",
      "type" : 9
    } ],
    "parts" : {
      "contentPartsCount" : 1,
      "annotationPartsCount" : 0,
      "notelogPartsCount" : 0,
      "contentParts" : [ {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A20I21A72752A0143918 A20I21A72752A014391 13 300",
        "mimetype" : "application/pdf",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/VW_US%20Golf_e_2018.pdf?order=retrieve&item-id=A1001001A20I21A72752A01439&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2020-09-21+14%3A27%3A52.285224000&token=ADUA.Nnt0CogmhbU2_9Mm_0PpfeMvdmDe7YzVmSsj_dFZ2lxt2JCBBtw4m.Pb;&content-length=0&content-type=application%2Fpdf",
        "size" : 1775468,
        "originalFileName" : "VW_US Golf_e_2018.pdf",
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2020-09-21 14:27:52.285224000",
        "updatedTimestamp" : "2020-09-21 14:27:52.285224000"
      } ],
      "annotationParts" : [ ],
      "notelogParts" : [ ]
    },
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false
  }, {
    "itemId" : "A1001001A20I21A73332F01440",
    "version" : "1",
    "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20I21A73332F0144018 A20I21A73332F014401 14 1000",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2020-09-21-07.33.36.361000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2020-09-21-07.33.36.361000",
    "itemtypeName" : "NOINDEX",
    "aclName" : "PublicReadACL",
    "attributes" : [ {
      "name" : "SOURCE",
      "type" : 1,
      "value" : "VW-Bus_1976.pdf"
    }, {
      "name" : "USER_ID",
      "type" : 1
    }, {
      "name" : "TIMESTAMP",
      "type" : 9
    } ],
    "parts" : {
      "contentPartsCount" : 1,
      "annotationPartsCount" : 0,
      "notelogPartsCount" : 0,
      "contentParts" : [ {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A20I21A73332F0144118 A20I21A73332F014411 13 300",
        "mimetype" : "application/pdf",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/VW_US%20Bus_1976.pdf?order=retrieve&item-id=A1001001A20I21A73332F01441&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2020-09-21+14%3A33%3A32.775236000&token=ADUA.Nnt0CogmhbU2_0ZWEw6pxssE2M41nfefWluRb2TfMIbxV7vsuBGlAm47;&content-length=0&content-type=application%2Fpdf",
        "size" : 1237272,
        "originalFileName" : "VW_US Bus_1976.pdf",
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2020-09-21 14:33:32.775236000",
        "updatedTimestamp" : "2020-09-21 14:33:32.775236000"
      } ],
      "annotationParts" : [ ],
      "notelogParts" : [ ]
    },
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false
  }, {
    "itemId" : "A1001001A23A11B01538I00717",
    "version" : "1",
    "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A23A11B01538I0071718 A23A11B01538I007171 14 1000",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2023-01-11-10.15.43.128000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2023-01-11-10.20.43.333000",
    "itemtypeName" : "NOINDEX",
    "aclName" : "PublicReadACL",
    "attributes" : [ {
      "name" : "SOURCE",
      "type" : 1,
      "value" : "simple_5page.pdf"
    }, {
      "name" : "USER_ID",
      "type" : 1,
      "value" : "ICMADMIN"
    }, {
      "name" : "TIMESTAMP",
      "type" : 9
    } ],
    "parts" : {
      "contentPartsCount" : 3,
      "annotationPartsCount" : 1,
      "notelogPartsCount" : 1,
      "contentParts" : [ {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A23A11B01538I0071818 A23A11B01538I007181 13 300",
        "mimetype" : "image/tiff",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/A1001001A23A11B01538I00718.tif?order=retrieve&item-id=A1001001A23A11B01538I00718&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2023-01-11+18%3A15%3A42.472792000&token=ADUA.Nnt0CogmhbU2_6u3Xvy8AWmj8Jzi8TM2vgcj9D2TwB3Q0QidyIFSKgjR;&content-length=0&content-type=image%2Ftiff",
        "size" : 13,
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2023-01-11 18:15:42.472792000",
        "updatedTimestamp" : "2023-01-11 18:15:42.472792000"
      }, {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A23A11B01538I0071918 A23A11B01538I007191 13 300",
        "mimetype" : "application/pdf",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/content-noindex.pdf?order=retrieve&item-id=A1001001A23A11B01538I00719&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2023-01-11+18%3A20%3A42.628817000&token=ADUA.Nnt0CogmhbU2_93n0z3N6fV5dks6L_JHPKjMw6ZKhpB4ggtCwWweGpih;&content-length=0&content-type=application%2Fpdf",
        "size" : 16,
        "originalFileName" : "content-noindex.pdf",
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2023-01-11 18:15:47.610795000",
        "updatedTimestamp" : "2023-01-11 18:20:42.628817000"
      }, {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A23A11B01816C0072218 A23A11B01816C007221 13 300",
        "mimetype" : "image/tiff",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/A1001001A23A11B01816C00722.tif?order=retrieve&item-id=A1001001A23A11B01816C00722&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2023-01-11+18%3A18%3A16.792808000&token=ADUA.Nnt0CogmhbU2_0HPWHJwM6T7ZaZ47kx3bjtMZN5lH4Q8gS8eV_cUcKAQ;&content-length=0&content-type=image%2Ftiff",
        "size" : 13,
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2023-01-11 18:18:16.792808000",
        "updatedTimestamp" : "2023-01-11 18:18:16.792808000"
      } ],
      "annotationParts" : [ {
        "pid" : "92 3 ICM8 icmnlsdb13 ICMANNOTATION58 26 A1001001A23A11B01538J0072118 A23A11B01538J007211 13 304",
        "mimetype" : "application/vnd.ibm.modcap",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/A1001001A23A11B01538J00721.mda?order=retrieve&item-id=A1001001A23A11B01538J00721&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2023-01-11+18%3A15%3A49.269798000&token=ADUA.Nnt0CogmhbU2_3w_KMDRXH1KBlFGTj90Aafl.O2S1w1r88ifP8Agyk7E;&content-length=0&content-type=application%2Fvnd.ibm.modcap",
        "size" : 19,
        "partType" : "ICMANNOTATION",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2023-01-11 18:15:49.269798000",
        "updatedTimestamp" : "2023-01-11 18:15:49.269798000"
      } ],
      "notelogParts" : [ {
        "pid" : "89 3 ICM8 icmnlsdb10 ICMNOTELOG58 26 A1001001A23A11B01538J0072018 A23A11B01538J007201 13 303",
        "mimetype" : "text/plain",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/A1001001A23A11B01538J00720.txt?order=retrieve&item-id=A1001001A23A11B01538J00720&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2023-01-11+18%3A15%3A51.083801000&token=ADUA.Nnt0CogmhbU2_7yEtBKa.mSz40tEoKYuNwKWA9N.MMjPsDRKYOpTtH5K;&content-length=0&content-type=text%2Fplain",
        "size" : 16,
        "partType" : "ICMNOTELOG",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2023-01-11 18:15:51.083801000",
        "updatedTimestamp" : "2023-01-11 18:15:51.083801000"
      } ]
    },
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false
  }, {
    "itemId" : "A1001001A23A11B02440C00723",
    "version" : "1",
    "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A23A11B02440C0072318 A23A11B02440C007231 14 1000",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2023-01-11-10.24.44.274000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2023-01-11-10.32.22.760000",
    "itemtypeName" : "NOINDEX",
    "aclName" : "PublicReadACL",
    "attributes" : [ {
      "name" : "SOURCE",
      "type" : 1,
      "value" : "simple_5page.pdf"
    }, {
      "name" : "USER_ID",
      "type" : 1,
      "value" : "ICMADMIN"
    }, {
      "name" : "TIMESTAMP",
      "type" : 9
    } ],
    "parts" : {
      "contentPartsCount" : 2,
      "annotationPartsCount" : 1,
      "notelogPartsCount" : 1,
      "contentParts" : [ {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A23A11B02440C0072418 A23A11B02440C007241 13 300",
        "mimetype" : "application/pdf",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/content-noindex.pdf?order=retrieve&item-id=A1001001A23A11B02440C00724&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2023-01-11+18%3A32%3A22.114857000&token=ADUA.Nnt0CogmhbU2_3iiNHf_.A5j_swCRSr6dwNuyzYvfrZOeiZao8bajXW4;&content-length=0&content-type=application%2Fpdf",
        "size" : 16,
        "originalFileName" : "content-noindex.pdf",
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2023-01-11 18:24:43.654823000",
        "updatedTimestamp" : "2023-01-11 18:32:22.114857000"
      }, {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A23A11B02718I0072818 A23A11B02718I007281 13 300",
        "mimetype" : "image/tiff",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/A1001001A23A11B02718I00728.tif?order=retrieve&item-id=A1001001A23A11B02718I00728&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2023-01-11+18%3A27%3A19.424839000&token=ADUA.Nnt0CogmhbU2_AKrAlwL0Qivm2k8V8azZ357Fz6hwldQOzsmYb2d6wz1;&content-length=0&content-type=image%2Ftiff",
        "size" : 13,
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2023-01-11 18:27:19.424839000",
        "updatedTimestamp" : "2023-01-11 18:27:19.424839000"
      } ],
      "annotationParts" : [ {
        "pid" : "92 3 ICM8 icmnlsdb13 ICMANNOTATION58 26 A1001001A23A11B02440C0072718 A23A11B02440C007271 13 304",
        "mimetype" : "application/vnd.ibm.modcap",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/A1001001A23A11B02440C00727.mda?order=retrieve&item-id=A1001001A23A11B02440C00727&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2023-01-11+18%3A24%3A50.304829000&token=ADUA.Nnt0CogmhbU2_1dtGD7mmIMKSBIqqveHZ9O_AZEqpW59wlS2ZjnbRPOC;&content-length=0&content-type=application%2Fvnd.ibm.modcap",
        "size" : 19,
        "partType" : "ICMANNOTATION",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2023-01-11 18:24:50.304829000",
        "updatedTimestamp" : "2023-01-11 18:24:50.304829000"
      } ],
      "notelogParts" : [ {
        "pid" : "89 3 ICM8 icmnlsdb10 ICMNOTELOG58 26 A1001001A23A11B02440C0072618 A23A11B02440C007261 13 303",
        "mimetype" : "text/plain",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/A1001001A23A11B02440C00726.txt?order=retrieve&item-id=A1001001A23A11B02440C00726&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2023-01-11+18%3A24%3A52.096832000&token=ADUA.Nnt0CogmhbU2_DT6u3lGA6OuOl8g52F6hvHpWr17rz0IKGCHk0MDlzaA;&content-length=0&content-type=text%2Fplain",
        "size" : 16,
        "partType" : "ICMNOTELOG",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2023-01-11 18:24:52.096832000",
        "updatedTimestamp" : "2023-01-11 18:24:52.096832000"
      } ]
    },
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false
  }, {
    "itemId" : "A1001001A20F22A82829A00685",
    "version" : "1",
    "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20F22A82829A0068518 A20F22A82829A006851 14 1000",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2020-06-22-08.28.29.423000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2020-06-22-08.28.29.423000",
    "itemtypeName" : "NOINDEX",
    "aclName" : "PublicReadACL",
    "attributes" : [ {
      "name" : "SOURCE",
      "type" : 1,
      "value" : "folder"
    }, {
      "name" : "USER_ID",
      "type" : 1,
      "value" : "icmadmin"
    }, {
      "name" : "TIMESTAMP",
      "type" : 9
    } ],
    "parts" : {
      "contentPartsCount" : 0,
      "annotationPartsCount" : 0,
      "notelogPartsCount" : 0,
      "contentParts" : [ ],
      "annotationParts" : [ ],
      "notelogParts" : [ ]
    },
    "isDocument" : false,
    "isFolder" : true,
    "isItem" : false
  }, {
    "itemId" : "A1001001A20F09A22532D00396",
    "version" : "1",
    "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A20F09A22532D0039618 A20F09A22532D003961 14 1000",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2020-06-09-02.25.32.360000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2020-06-09-02.25.32.360000",
    "itemtypeName" : "NOINDEX",
    "aclName" : "PublicReadACL",
    "attributes" : [ {
      "name" : "SOURCE",
      "type" : 1,
      "value" : "folder"
    }, {
      "name" : "USER_ID",
      "type" : 1,
      "value" : "icmadmin"
    }, {
      "name" : "TIMESTAMP",
      "type" : 9
    } ],
    "parts" : {
      "contentPartsCount" : 0,
      "annotationPartsCount" : 0,
      "notelogPartsCount" : 0,
      "contentParts" : [ ],
      "annotationParts" : [ ],
      "notelogParts" : [ ]
    },
    "isDocument" : false,
    "isFolder" : true,
    "isItem" : false
  }, {
    "itemId" : "A1001001A24H06A75952C00310",
    "version" : "1",
    "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24H06A75952C0031018 A24H06A75952C003101 14 1000",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2024-08-06-07.59.53.158000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2024-08-06-07.59.55.093000",
    "itemtypeName" : "NOINDEX",
    "aclName" : "PublicReadACL",
    "attributes" : [ {
      "name" : "SOURCE",
      "type" : 1,
      "value" : "simple_5page.pdf"
    }, {
      "name" : "USER_ID",
      "type" : 1,
      "value" : "user1"
    }, {
      "name" : "TIMESTAMP",
      "type" : 9
    } ],
    "parts" : {
      "contentPartsCount" : 2,
      "annotationPartsCount" : 1,
      "notelogPartsCount" : 1,
      "contentParts" : [ {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A24H06A75952C0031118 A24H06A75952C003111 13 300",
        "mimetype" : "image/tiff",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/A1001001A24H06A75952C00311.tif?order=retrieve&item-id=A1001001A24H06A75952C00311&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2024-08-06+14%3A59%3A52.971934000&token=ADUA.Nnt0CogmhbU2_7OnpqYcz0ABdtuGo3NbnuRxwLL7UhV8D20nwVUcHoXX;&content-length=0&content-type=image%2Ftiff",
        "size" : 13,
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2024-08-06 14:59:52.971934000",
        "updatedTimestamp" : "2024-08-06 14:59:52.971934000"
      }, {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A24H06A75952C0031218 A24H06A75952C003121 13 300",
        "mimetype" : "image/tiff",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/A1001001A24H06A75952C00312.tif?order=retrieve&item-id=A1001001A24H06A75952C00312&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2024-08-06+14%3A59%3A54.049937000&token=ADUA.Nnt0CogmhbU2_6IusojI7NVz2YCzh19zCP3OMvi6CL5hmjZ85sisQ6TK;&content-length=0&content-type=image%2Ftiff",
        "size" : 24,
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2024-08-06 14:59:54.049937000",
        "updatedTimestamp" : "2024-08-06 14:59:54.049937000"
      } ],
      "annotationParts" : [ {
        "pid" : "92 3 ICM8 icmnlsdb13 ICMANNOTATION58 26 A1001001A24H06A75952C0031418 A24H06A75952C003141 13 304",
        "mimetype" : "application/vnd.ibm.modcap",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/A1001001A24H06A75952C00314.mda?order=retrieve&item-id=A1001001A24H06A75952C00314&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2024-08-06+14%3A59%3A54.487940000&token=ADUA.Nnt0CogmhbU2_2ERCOHwTxwrcjL8sFV9cs2voEZhS8pnLM2hcNmyZNLs;&content-length=0&content-type=application%2Fvnd.ibm.modcap",
        "size" : 19,
        "partType" : "ICMANNOTATION",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2024-08-06 14:59:54.487940000",
        "updatedTimestamp" : "2024-08-06 14:59:54.487940000"
      } ],
      "notelogParts" : [ {
        "pid" : "89 3 ICM8 icmnlsdb10 ICMNOTELOG58 26 A1001001A24H06A75952C0031318 A24H06A75952C003131 13 303",
        "mimetype" : "text/plain",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/A1001001A24H06A75952C00313.txt?order=retrieve&item-id=A1001001A24H06A75952C00313&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2024-08-06+14%3A59%3A54.905943000&token=ADUA.Nnt0CogmhbU2_0BjCbfLyusGp52UilqOrVFh1ZQ80rhjBR4CykGm5j3y;&content-length=0&content-type=text%2Fplain",
        "size" : 16,
        "partType" : "ICMNOTELOG",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2024-08-06 14:59:54.905943000",
        "updatedTimestamp" : "2024-08-06 14:59:54.905943000"
      } ]
    },
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false
  } ]
}
Path Type Description

status

String

Status of the request

items

Array

Array of retrieved items

GET /items/{pid}

Retrieve an item.

request
GET /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000 HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request path parameters
Parameter Description

pid

Identifier of item
request query parameters
Parameter Description

retrieve

(optional) Specify data to retrieve, {attributes | partsMetaData}. By default, this is set to partsMetaData.

checkout

(optional) Check out retrieved items, {true | false}. By default, this is false.

version

(optional) Specify to retrieve the latest version or the specific version identified in the PID or all versions,{latest | specific | all}. The default value is latest.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: c1f9347a-ec12-4948-bba7-d5d52b00a5fc:icmadmin:icmnlsdb:-1932631052:null
Content-Type: application/json
Content-Length: 4163
Date: Mon, 18 Nov 2024 20:10:37 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "item" : {
    "itemId" : "A1001001A24K18B21036E00060",
    "version" : "1",
    "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2024-11-18-12.10.36.616000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2024-11-18-12.10.36.993000",
    "itemtypeName" : "NOINDEX",
    "aclName" : "PublicReadACL",
    "attributes" : [ {
      "name" : "SOURCE",
      "type" : 1,
      "value" : "simple_5page.pdf"
    }, {
      "name" : "USER_ID",
      "type" : 1,
      "value" : "user1"
    }, {
      "name" : "TIMESTAMP",
      "type" : 9
    } ],
    "parts" : {
      "contentPartsCount" : 2,
      "annotationPartsCount" : 1,
      "notelogPartsCount" : 1,
      "contentParts" : [ {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A24K18B21036E0006118 A24K18B21036E000611 13 300",
        "mimetype" : "image/tiff",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/A1001001A24K18B21036E00061.tif?order=retrieve&item-id=A1001001A24K18B21036E00061&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2024-11-18+20%3A10%3A36.537749000&token=ADUA.Nnt0DIgmjYU2_4AkiFgDG3uDjXQ9ITUFSzuwxxe51ZsarxU_6_HzjJSi;&content-length=0&content-type=image%2Ftiff",
        "size" : 13,
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2024-11-18 20:10:36.537749000",
        "updatedTimestamp" : "2024-11-18 20:10:36.537749000"
      }, {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A24K18B21036E0006218 A24K18B21036E000621 13 300",
        "mimetype" : "image/tiff",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/A1001001A24K18B21036E00062.tif?order=retrieve&item-id=A1001001A24K18B21036E00062&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2024-11-18+20%3A10%3A36.695752000&token=ADUA.Nnt0DIgmjYU2_AX7U0MMw4wsuZfssiVpejZhL5Pb_HSvBiXCXp5jUdVK;&content-length=0&content-type=image%2Ftiff",
        "size" : 24,
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2024-11-18 20:10:36.695752000",
        "updatedTimestamp" : "2024-11-18 20:10:36.695752000"
      } ],
      "annotationParts" : [ {
        "pid" : "92 3 ICM8 icmnlsdb13 ICMANNOTATION58 26 A1001001A24K18B21036E0006418 A24K18B21036E000641 13 304",
        "mimetype" : "application/vnd.ibm.modcap",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/A1001001A24K18B21036E00064.mda?order=retrieve&item-id=A1001001A24K18B21036E00064&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2024-11-18+20%3A10%3A36.804755000&token=ADUA.Nnt0DIgmjYU2_4jSFnqqdFaUMiFrJJrFatMQaj.WYqh05b1LhCxC6gg2;&content-length=0&content-type=application%2Fvnd.ibm.modcap",
        "size" : 19,
        "partType" : "ICMANNOTATION",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2024-11-18 20:10:36.804755000",
        "updatedTimestamp" : "2024-11-18 20:10:36.804755000"
      } ],
      "notelogParts" : [ {
        "pid" : "89 3 ICM8 icmnlsdb10 ICMNOTELOG58 26 A1001001A24K18B21036E0006318 A24K18B21036E000631 13 303",
        "mimetype" : "text/plain",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/A1001001A24K18B21036E00063.txt?order=retrieve&item-id=A1001001A24K18B21036E00063&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2024-11-18+20%3A10%3A36.927758000&token=ADUA.Nnt0DIgmjYU2_6OibXUvIif5.AEM8dFcSIo6EFip9fvv5SbZn44pz2NF;&content-length=0&content-type=text%2Fplain",
        "size" : 16,
        "partType" : "ICMNOTELOG",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2024-11-18 20:10:36.927758000",
        "updatedTimestamp" : "2024-11-18 20:10:36.927758000"
      } ]
    },
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false,
    "isCheckedOut" : false
  }
}
Path Type Description

status

String

Status of the request

item

Object

Details of the item

GET /items/{pid}?checkout=true&version=specific&retrieve=attributes

Retrieve an item.

request
GET /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000?checkout=true&version=specific&retrieve=attributes HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request path parameters
Parameter Description

pid

Identifier of item
request query parameters
Parameter Description

retrieve

(optional) Specify data to retrieve, {attributes | partsMetaData}. By default, this is set to partsMetaData.

checkout

(optional) Check out retrieved items, {true | false}. By default, this is false.

version

(optional) Specify to retrieve the latest version or the specific version identified in the PID or all versions,{latest | specific | all}. The default value is latest.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 39f76eb6-d812-4886-92cc-8b134b5b72bb:icmadmin:icmnlsdb:185486668:null
Content-Type: application/json
Content-Length: 833
Date: Mon, 18 Nov 2024 20:10:37 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "item" : {
    "itemId" : "A1001001A24K18B21036E00060",
    "version" : "1",
    "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2024-11-18-12.10.36.616000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2024-11-18-12.10.36.993000",
    "itemtypeName" : "NOINDEX",
    "aclName" : "PublicReadACL",
    "attributes" : [ {
      "name" : "SOURCE",
      "type" : 1,
      "value" : "simple_5page.pdf"
    }, {
      "name" : "USER_ID",
      "type" : 1,
      "value" : "user1"
    }, {
      "name" : "TIMESTAMP",
      "type" : 9
    } ],
    "checkedOutUserid" : "ICMADMIN",
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false,
    "isCheckedOut" : true
  }
}
Path Type Description

status

String

Status of the request

item

Object

Details of the item

PUT /items/{pid}/checkout

Checkout an item.

request
PUT /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/checkout HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request path parameters
Parameter Description

pid

Identifier of item
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 2e827d41-26f5-431b-9863-99ed2fbd0f11:icmadmin:icmnlsdb:654528197:null
Content-Type: application/json
Content-Length: 129
Date: Mon, 18 Nov 2024 20:10:38 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item checked out

PUT /items/{pid}/checkin

Checkin an item.

request
PUT /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/checkin HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request path parameters
Parameter Description

pid

Identifier of item
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 433c396d-7dd0-42da-b814-8299699b75db:icmadmin:icmnlsdb:953600113:null
Content-Type: application/json
Content-Length: 129
Date: Mon, 18 Nov 2024 20:10:38 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item checked in

PATCH /items/{pid}

Update attributes for an item.

request
PATCH /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000 HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: application/json
Host: cm8.unicom.com
Content-Length: 52

[ {
  "name" : "USER_ID",
  "value" : "ICMADMIN"
} ]
request path parameters
Parameter Description

pid

Identifier of item
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
request fields
Path Type Description

[]

Array

Array of attributes

[].name

String

Name of the attribute

[].value

String

Value of the attribute
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: b3967dac-66d0-48b6-8ae6-5b388367058d:icmadmin:icmnlsdb:-1265027237:null
Content-Type: application/json
Content-Length: 129
Date: Mon, 18 Nov 2024 20:10:38 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item updated

PATCH /items/{pid}

Replace child components for an item.

request
PATCH /cm8app/cm8rest/v1/items/93%203%20ICM8%20icmnlsdb13%20XYZ_InsPolicy59%2026%20A1001001A24K18B21050J0006918%20A24K18B21050J000691%2014%201032 HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: application/json
Host: cm8.unicom.com
Content-Length: 256

[ {
  "name" : "XYZ_Insured",
  "children" : [ {
    "pid" : "91 3 ICM8 icmnlsdb11 XYZ_Insured59 26 A1001001A24K18B21050J0006918 A24K18B21050J457491 14 1033",
    "attributes" : [ {
      "name" : "XYZ_InsrdFName",
      "value" : "Holly"
    } ]
  } ]
} ]
request path parameters
Parameter Description

pid

Identifier of item
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is ‘Prompt to create’, {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
request fields
Path Type Description

[]

Array

Array of attributes

[].name

String

Collection name of the attribute

[].children[]

Array

Set of sub items in the collection identified by the name

[].children[].pid

String

Identifier of the sub item

[].children[].attributes

Array

Attributes of the sub item
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 3ac33d20-9d30-4091-88fc-8b433c5f2551:icmadmin:icmnlsdb:-1097697501:null
Content-Type: application/json
Content-Length: 136
Date: Mon, 18 Nov 2024 20:10:50 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "93 3 ICM8 icmnlsdb13 XYZ_InsPolicy59 26 A1001001A24K18B21050J0006918 A24K18B21050J000691 24 1032"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item updated

PATCH /items/{pid}

Add child components for an item.

request
PATCH /cm8app/cm8rest/v1/items/93%203%20ICM8%20icmnlsdb13%20XYZ_InsPolicy59%2026%20A1001001A24K18B21050J0006918%20A24K18B21050J000691%2014%201032 HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: application/json
Host: cm8.unicom.com
Content-Length: 213

[ {
  "name" : "XYZ_Insured",
  "children" : [ {
    "attributes" : [ {
      "name" : "XYZ_InsrdFName",
      "value" : "Sally"
    }, {
      "name" : "XYZ_InsrdLName",
      "value" : "Neruda"
    } ]
  } ]
} ]
request path parameters
Parameter Description

pid

Identifier of item
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
request fields
Path Type Description

[]

Array

Array of attributes

[].name

String

Collection name of the attribute

[].children[]

Array

Set of sub items in the collection identified by the name

[].children[].parentPid

String

(optional)Identifier of the parent of the sub item. It is the item pid if not specified

[].children[].attributes

Array

Attributes of the sub item
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 79e3ab87-bd17-4d79-b379-56b1d37864d2:icmadmin:icmnlsdb:-1750204470:null
Content-Type: application/json
Content-Length: 136
Date: Mon, 18 Nov 2024 20:10:50 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "93 3 ICM8 icmnlsdb13 XYZ_InsPolicy59 26 A1001001A24K18B21050J0006918 A24K18B21050J000691 34 1032"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item updated

PATCH /items/{pid}

Delete child components for an item.

request
PATCH /cm8app/cm8rest/v1/items/93%203%20ICM8%20icmnlsdb13%20XYZ_InsPolicy59%2026%20A1001001A24K18B21050J0006918%20A24K18B21050J000691%2014%201032 HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: application/json
Host: cm8.unicom.com
Content-Length: 167

[ {
  "name" : "XYZ_Insured",
  "children" : [ {
    "pid" : "91 3 ICM8 icmnlsdb11 XYZ_Insured59 26 A1001001A24K18B21050J0006918 A24K18B21050J457491 14 1033"
  } ]
} ]
request path parameters
Parameter Description

pid

Identifier of item
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
request fields
Path Type Description

[]

Array

Array of attributes

[].name

String

Collection name of the attribute

[].children[]

Array

Set of sub items in the collection identified by the name

[].children[].pid

String

Identifier of the sub item
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: d3e7ea82-e239-4263-af05-4b07261354dc:icmadmin:icmnlsdb:333961775:null
Content-Type: application/json
Content-Length: 136
Date: Mon, 18 Nov 2024 20:10:51 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "93 3 ICM8 icmnlsdb13 XYZ_InsPolicy59 26 A1001001A24K18B21050J0006918 A24K18B21050J000691 44 1032"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item updated

GET /items/{pid}/folders?limit=10&retrieve=attributes&retrieveCheckoutDetail=true

Retrieve a list of parent folders for an item.

request
GET /cm8app/cm8rest/v1/items/93%203%20ICM8%20icmnlsdb13%20XYZ_ClaimForm59%2026%20A1001001A20E21B04204D0001518%20A20E21B04204D000151%2014%201030/folders?limit=10&retrieve=attributes&retrieveCheckoutDetail=true HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request path parameters
Parameter Description

pid

Identifier of the item
request query parameters
Parameter Description

limit

(optional) Maximum number of items to retrieve. By default, this is 50. Use limit set to 0 to specify no limit.

retrieve

(optional) Specify data to retrieve, {attributes | partsMetaData}. By default, PIDs will be retrieved.

retrieveCheckoutDetail

(optional) Retrieve check out details, {true | false}. By default, this is false.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 47216614-7b85-4a3a-942e-a942a6e24cd5:icmadmin:icmnlsdb:1805735610:null
Content-Type: application/json
Content-Length: 693
Date: Mon, 18 Nov 2024 20:10:50 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "items" : [ {
    "itemId" : "A1001001A20E21B04204E00017",
    "version" : "1",
    "pid" : "95 3 ICM8 icmnlsdb15 XYZ_ClaimFolder59 26 A1001001A20E21B04204E0001718 A20E21B04204E000171 14 1024",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2020-05-21-10.42.04.484000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2020-05-21-10.42.04.484000",
    "itemtypeName" : "XYZ_ClaimFolder",
    "aclName" : "XYZClaimFolderACL",
    "attributes" : [ {
      "name" : "XYZ_ClaimNumber",
      "type" : 1,
      "value" : "6-987654"
    } ],
    "isDocument" : false,
    "isFolder" : true,
    "isItem" : false,
    "isCheckedOut" : false
  } ]
}
Path Type Description

status

String

Status of the request

items

Array

Array of retrieved items

PUT /items/{pid}/move

Move the item to the destination item type. Implicit checkout/checkin of the item will be done if it is not locked.

request
PUT /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/move HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: application/json
Host: cm8.unicom.com
Content-Length: 470

{
  "itemtypeName" : "XYZ_AutoPhoto",
  "attributes" : [ {
    "name" : "XYZ_AdjustDate",
    "value" : "2023-05-12"
  }, {
    "name" : "XYZ_AdjustFName",
    "value" : "Michael"
  }, {
    "name" : "XYZ_AdjustLName",
    "value" : "Reed"
  }, {
    "name" : "XYZ_ClaimNumber",
    "value" : "6-987654"
  }, {
    "name" : "XYZ_PolicyNum",
    "value" : "10452136412"
  }, {
    "name" : "XYZ_VIN",
    "value" : "1HOME10R4KL987258"
  } ],
  "aclName" : "DocRouteACL"
}
request path parameters
Parameter Description

pid

Identifier of source item
request query parameters
Parameter Description

newVersion

(optional) {true | false}. By default, this is false and the destination item will be the latest version number of the source item. For item types of classification Item, Document or Document Part, newVersion true will increment the version, regardless of the version control setting of the destination item type. In this case, there will still be only one version of the destination item, but that version incremented. For example, if the latest version of the source item is 2, the only version of the destination item will be 3.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit and if the item is checked out before this operation it will remain checked out after.

autoFolder

(optional) {true | false}. By default, this is false, which means to remove from the current auto folder.
request fields
Path Type Description

itemtypeName

String

Destination item type name

attributes.[]

Array

(optional) Array of attributes of destination item

attributes.[].name

String

Name of the attribute

attributes.[].value

String

Value of the attribute

aclName

String

(optional) ACL name of destination item. Note:ACL of the parts remains unchanged.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: eb840f78-0af6-49c9-ab17-20e925db40b3:icmadmin:icmnlsdb:-160017014:null
Content-Type: application/json
Content-Length: 136
Date: Mon, 18 Nov 2024 20:10:48 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "93 3 ICM8 icmnlsdb13 XYZ_AutoPhoto59 26 A1001001A24K18B21036E0006018 A24K18B21048I324381 14 1028"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item moved

DELETE /items/{pid}

Delete an item.

request
DELETE /cm8app/cm8rest/v1/items/93%203%20ICM8%20icmnlsdb13%20XYZ_AutoPhoto59%2026%20A1001001A24K18B21036E0006018%20A24K18B21048I324381%2014%201028 HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request path parameters
Parameter Description

pid

Identifier of item
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: b08ad039-e3a3-4b2c-a517-987839180e0c:icmadmin:icmnlsdb:819879023:null
Content-Type: application/json
Content-Length: 26
Date: Mon, 18 Nov 2024 20:10:48 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success"
}
Path Type Description

status

String

Status of the request

Content Base Part API

Operations available for content base parts.

POST /items/{pid}/contents

Create a base part or the resource content of an item. The part is stored using a binary stream. Implicit item checkout will be done if the item is not locked.

Only one content part can be specified in the request body with form data parts part and partStream.

request
POST /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/contents HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: multipart/form-data; boundary="arFpftA8XI-41vCAh1Ie6hJa2sQcCuMicwhjb1o"; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: cm8.unicom.com

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=part
Content-Type: application/json

{
	"mimetype": "image/tiff",
	"size": 13
}
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=partStream; filename=content.tif
Content-Type: application/octet-stream

<<tiff data>>
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
request path parameters
Parameter Description

pid

Identifier of item
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
request body form data parts

The order of the multi-part form data is important. The part meta data must be before the part file stream.

Part Description

part

Metadata for the content part

partStream

File stream for the content part
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 358cbf76-78d4-44d2-8ef0-889316c83c74:icmadmin:icmnlsdb:-509588428:null
Content-Type: application/json
Content-Length: 235
Date: Mon, 18 Nov 2024 20:10:38 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A24K18B21038I0006518 A24K18B21038I000651 13 300"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item

partPid

String

Identifier of the part created

PUT /items/{pid}/contents

Replace the first base content part or resource content of an item. The part is stored with a binary stream. Implicit item checkout will be done if the item is not locked.

request
PUT /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/contents HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: multipart/form-data; boundary="CpaSSNBrmKn4a6WG3lXq4C5gTQc9WgN_La99qdr"; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: cm8.unicom.com

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=part
Content-Type: application/json

{
  "mimetype" : "application/pdf",
  "size" : 16,
  "originalFileName" : "replaced_content.pdf"
}
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=partStream; filename=content.pdf
Content-Type: application/octet-stream

<<content data>>
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
request path parameters
Parameter Description

pid

Identifier of item
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
request body form data parts

The order of the multi-part form data is important. The part meta data must be before the part file stream.

Part Description

part

Metadata for the content part

partStream

File stream for first content part
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 71062bb5-8411-4b9a-b0cf-55e62c17144b:icmadmin:icmnlsdb:-586762890:null
Content-Type: application/json
Content-Length: 235
Date: Mon, 18 Nov 2024 20:10:41 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A24K18B21036E0006118 A24K18B21036E000611 13 300"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item replaced

partPid

String

Identifier of the part

PUT /items/{pid}/contents/{partPid}

Replace a base content part or resource content of an item. The part is stored with a binary stream. Implicit item checkout will be done if the item is not locked.

request
PUT /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/contents/85%203%20ICM8%20icmnlsdb7%20ICMBASE58%2026%20A1001001A24K18B21036E0006218%20A24K18B21036E000621%2013%20300 HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: multipart/form-data; boundary="fQCE8bOA-0KvNRY1R9HRSE2-Estr4qg"; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: cm8.unicom.com

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=part
Content-Type: application/json

{
  "mimetype" : "application/pdf",
  "size" : 16,
  "originalFileName" : "replaced_content.pdf"
}
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=partStream; filename=content.pdf
Content-Type: application/octet-stream

<<content data>>
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
request path parameters
Parameter Description

pid

Identifier of item

partPid

Identifier of content part
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
request body form data parts

The order of the multi-part form data is important. The part meta data must be before the part file stream.

Part Description

part

Metadata for the content part

partStream

File stream for first content part
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 1b95a792-9895-4eae-85a8-f2bc6ef3b874:icmadmin:icmnlsdb:2145692968:null
Content-Type: application/json
Content-Length: 235
Date: Mon, 18 Nov 2024 20:10:39 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A24K18B21036E0006218 A24K18B21036E000621 13 300"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item replaced

partPid

String

Identifier of the part replaced

PATCH /items/{pid}/contents

Modify the first base part or resource content: change the mimetype or original file name. Implicit item checkout will be done if the item is not locked. Attributes other than mimetype or original file name are ignored.

request
PATCH /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/contents HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: application/json
Host: cm8.unicom.com
Content-Length: 82

{
  "mimetype" : "application/pdf",
  "originalFileName" : "content-noindex.pdf"
}
request path parameters
Parameter Description

pid

Identifier of item
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 3f068d6f-5ed3-43d5-93b9-dba8cbe00d73:icmadmin:icmnlsdb:1233044731:null
Content-Type: application/json
Content-Length: 235
Date: Mon, 18 Nov 2024 20:10:41 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A24K18B21036E0006118 A24K18B21036E000611 13 300"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item modified

partPid

String

Identifier of the part

PATCH /items/{pid}/contents/{partPid}

Modify a base part or resource content: change the mimetype or original file name. Implicit item checkout will be done if the item is not locked. Attributes other than mimetype or original file name are ignored.

request
PATCH /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/contents/85%203%20ICM8%20icmnlsdb7%20ICMBASE58%2026%20A1001001A24K18B21036E0006218%20A24K18B21036E000621%2013%20300 HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: application/json
Host: cm8.unicom.com
Content-Length: 82

{
  "mimetype" : "application/pdf",
  "originalFileName" : "content-noindex.pdf"
}
request path parameters
Parameter Description

pid

Identifier of item

partPid

Identifier of content part
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: ad0abd65-a18b-49b4-8559-8a58b4839024:icmadmin:icmnlsdb:-470521933:null
Content-Type: application/json
Content-Length: 235
Date: Mon, 18 Nov 2024 20:10:40 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A24K18B21036E0006218 A24K18B21036E000621 13 300"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item modified

partPid

String

Identifier of the part modified

DELETE /items/{pid}/contents

Delete the first base part or resource content of an item. Implicit item checkout will be done if the item is not locked.

request
DELETE /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/contents HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request path parameters
Parameter Description

pid

Identifier of item
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: fa368b1a-95d7-402d-8a82-1102db3a220b:icmadmin:icmnlsdb:-991569762:null
Content-Type: application/json
Content-Length: 235
Date: Mon, 18 Nov 2024 20:10:42 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A24K18B21036E0006118 A24K18B21036E000611 13 300"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item deleted

partPid

String

Identifier of the part

DELETE /items/{pid}/contents/{partPid}

Delete base part or resource content of an item. Implicit item checkout will be done if the item is not locked.

request
DELETE /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/contents/85%203%20ICM8%20icmnlsdb7%20ICMBASE58%2026%20A1001001A24K18B21036E0006218%20A24K18B21036E000621%2013%20300 HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request path parameters
Parameter Description

pid

Identifier of item

partPid

Identifier of content part
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 016af22d-6481-44ea-8378-27ccf768a03e:icmadmin:icmnlsdb:-170294681:null
Content-Type: application/json
Content-Length: 235
Date: Mon, 18 Nov 2024 20:10:40 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A24K18B21036E0006218 A24K18B21036E000621 13 300"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item deleted

partPid

String

Identifier of the part deleted

Annotation Part API

Operations available for annotation parts.

POST /items/{pid}/annotations

Create annotation part of an item. The part is stored using a binary stream. Implicit item checkout will be done if the item is not locked.

Only one annotation part can be specified in the request body with form data parts part and partStream.

request
POST /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/annotations HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: multipart/form-data; boundary="LqjKYzYfl8A9gJIqwofj9XANglCKYfA"; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: cm8.unicom.com

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=part
Content-Type: application/json

{
	"mimetype": "application/vnd.ibm.modcap",
	"size": 19
}
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=partStream; filename=annotation.t_l
Content-Type: application/octet-stream

<<annotation data>>
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
request path parameters
Parameter Description

pid

Identifier of item
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
request body form data parts

The order of the multi-part form data is important. The part meta data must be before the part file stream.

Part Description

part

Metadata for the annotation part

partStream

File stream for the annotation part
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: e574418f-b20b-4bdd-ad9f-d9c7ebf4a75d:icmadmin:icmnlsdb:-1634649932:null
Content-Type: application/json
Content-Length: 242
Date: Mon, 18 Nov 2024 20:10:42 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "92 3 ICM8 icmnlsdb13 ICMANNOTATION58 26 A1001001A24K18B21043A0006618 A24K18B21043A000661 13 304"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item

partPid

String

Identifier of the part created

PUT /items/{pid}/annotations

Replace the first annotation part of an item, the part is stored with a binary stream. Implicit item checkout will be done if the item is not locked.

request
PUT /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/annotations HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: multipart/form-data; boundary="lbwPdta_ISR5jyIDnnMDH8jI3ZwMW5yuMGq0EH"; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: cm8.unicom.com

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=part
Content-Type: application/json

{
  "mimetype" : "application/vnd.ibm.modcap",
  "size" : 19,
  "originalFileName" : "replaced_annotation.t_l"
}
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=partStream; filename=annotation.t_l
Content-Type: application/octet-stream

<<annotation data>>
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
request path parameters
Parameter Description

pid

Identifier of item
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
request body form data parts

The order of the multi-part form data is important. The part meta data must be before the part file stream.

Part Description

part

Metadata for the annotation part

partStream

File stream for first annotation part
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 2242b2ce-721d-4db3-bb43-59b8eddc3041:icmadmin:icmnlsdb:-808930160:null
Content-Type: application/json
Content-Length: 242
Date: Mon, 18 Nov 2024 20:10:45 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "92 3 ICM8 icmnlsdb13 ICMANNOTATION58 26 A1001001A24K18B21043A0006618 A24K18B21043A000661 13 304"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item replaced

partPid

String

Identifier of the part

PUT /items/{pid}/annotations/{partPid}

Replace an annotation part of an item. The part is stored with a binary stream. Implicit item checkout will be done if the item is not locked.

request
PUT /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/annotations/92%203%20ICM8%20icmnlsdb13%20ICMANNOTATION58%2026%20A1001001A24K18B21036E0006418%20A24K18B21036E000641%2013%20304 HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: multipart/form-data; boundary="SZzwn0COcOlKyPyxe7stkgFBYZRCnXaALAgU"; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: cm8.unicom.com

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=part
Content-Type: application/json

{
  "mimetype" : "application/vnd.ibm.modcap",
  "size" : 19,
  "originalFileName" : "replaced_annotation.t_l"
}
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=partStream; filename=annotation.t_l
Content-Type: application/octet-stream

<<annotation data>>
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
request path parameters
Parameter Description

pid

Identifier of item

partPid

Identifier of annotation part
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
request body form data parts

The order of the multi-part form data is important. The part meta data must be before the part file stream.

Part Description

part

Metadata for the annotation part

partStream

File stream for first annotation part
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 4f386536-7d9f-4bb9-a7f3-c516c9dec85a:icmadmin:icmnlsdb:324713875:null
Content-Type: application/json
Content-Length: 242
Date: Mon, 18 Nov 2024 20:10:43 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "92 3 ICM8 icmnlsdb13 ICMANNOTATION58 26 A1001001A24K18B21036E0006418 A24K18B21036E000641 13 304"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item replaced

partPid

String

Identifier of the part replaced

PATCH /items/{pid}/annotations

Modify the fist annotation part of an item: change the mimetype or original file name. Implicit item checkout will be done if the item is not locked. Attributes other than mimetype or original file name are ignored.

request
PATCH /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/annotations HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: application/json
Host: cm8.unicom.com
Content-Length: 47

{
  "mimetype" : "application/vnd.ibm.modcap"
}
request path parameters
Parameter Description

pid

Identifier of item
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 6dc1e2b6-916c-41a6-aa85-02a564f2e558:icmadmin:icmnlsdb:1315775077:null
Content-Type: application/json
Content-Length: 242
Date: Mon, 18 Nov 2024 20:10:45 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "92 3 ICM8 icmnlsdb13 ICMANNOTATION58 26 A1001001A24K18B21043A0006618 A24K18B21043A000661 13 304"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item modified

partPid

String

Identifier of the part

PATCH /items/{pid}/annotations/{partPid}

Modify an annotation part: change the mimetype or original file name. Implicit item checkout will be done if the item is not locked. Attributes other than mimetype or original file name are ignored.

request
PATCH /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/annotations/92%203%20ICM8%20icmnlsdb13%20ICMANNOTATION58%2026%20A1001001A24K18B21036E0006418%20A24K18B21036E000641%2013%20304 HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: application/json
Host: cm8.unicom.com
Content-Length: 47

{
  "mimetype" : "application/vnd.ibm.modcap"
}
request path parameters
Parameter Description

pid

Identifier of item

partPid

Identifier of content part
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: ebd40625-0690-40e5-9f2e-90ca9d7b7ed2:icmadmin:icmnlsdb:1989906626:null
Content-Type: application/json
Content-Length: 242
Date: Mon, 18 Nov 2024 20:10:43 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "92 3 ICM8 icmnlsdb13 ICMANNOTATION58 26 A1001001A24K18B21036E0006418 A24K18B21036E000641 13 304"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item modified

partPid

String

Identifier of the part modified

DELETE /items/{pid}/annotations

Delete the first annotation part of an item. Implicit item checkout will be done if the item is not locked.

request
DELETE /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/annotations HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request path parameters
Parameter Description

pid

Identifier of item
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 2fcf7adc-037e-45ba-ab19-f13c7ef13220:icmadmin:icmnlsdb:1140811220:null
Content-Type: application/json
Content-Length: 242
Date: Mon, 18 Nov 2024 20:10:45 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "92 3 ICM8 icmnlsdb13 ICMANNOTATION58 26 A1001001A24K18B21043A0006618 A24K18B21043A000661 13 304"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item deleted

partPid

String

Identifier of the part

DELETE /items/{pid}/annotations/{partPid}

Delete annotation part of an item. Implicit item checkout will be done if the item is not locked.

request
DELETE /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/annotations/92%203%20ICM8%20icmnlsdb13%20ICMANNOTATION58%2026%20A1001001A24K18B21036E0006418%20A24K18B21036E000641%2013%20304 HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request path parameters
Parameter Description

pid

Identifier of item

partPid

Identifier of content part
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: b511e765-c57c-4962-acec-50babd8aa3a7:icmadmin:icmnlsdb:-1870354530:null
Content-Type: application/json
Content-Length: 242
Date: Mon, 18 Nov 2024 20:10:43 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "92 3 ICM8 icmnlsdb13 ICMANNOTATION58 26 A1001001A24K18B21036E0006418 A24K18B21036E000641 13 304"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item deleted

partPid

String

Identifier of the part deleted

Notelog Part API

Operations available for notelog parts.

POST /items/{pid}/notelogs

Create a notelog part for an item, The part is stored using a binary stream. Implicit item checkout will be done if the item is not locked.

Only one notelog part can be specified in the request body with form data parts part and partStream.

request
POST /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/notelogs HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: multipart/form-data; boundary="MY6obWOzsxsSZDIaRvuDermDm_iHrEj2Y"; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: cm8.unicom.com

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=part
Content-Type: application/json

{
	"mimetype": "text/plain",
	"size": 16
}

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=partStream; filename=notelog.txt
Content-Type: application/octet-stream

<<notelog data>>
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
request path parameters
Parameter Description

pid

Identifier of item
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
request body form data parts

The order of the multi-part form data is important. The part meta data must be before the part file stream.

Part Description

part

Metadata for the notelog part

partStream

File stream for the notelog part
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 94ff92d0-3617-4cbd-a8f0-e62fe9205afb:icmadmin:icmnlsdb:-1900111871:null
Content-Type: application/json
Content-Length: 239
Date: Mon, 18 Nov 2024 20:10:46 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "89 3 ICM8 icmnlsdb10 ICMNOTELOG58 26 A1001001A24K18B21046A0006718 A24K18B21046A000671 13 303"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item

partPid

String

Identifier of the part

PUT /items/{pid}/notelogs

Replace the first notelog part of an item, the part is stored with a binary stream. Implicit item checkout will be done if the item is not locked.

request
PUT /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/notelogs HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: multipart/form-data; boundary="_Q75xiHgM4Xeuji1dKjvBo1wDxTBdoRC1FtrxBz"; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: cm8.unicom.com

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=part
Content-Type: application/json

{
  "mimetype" : "text/plain",
  "size" : 16,
  "originalFileName" : "replaced_notelog.txt"
}
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=partStream; filename=notelog.txt
Content-Type: application/octet-stream

<<notelog data>>
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
request path parameters
Parameter Description

pid

Identifier of item
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
request body form data parts

The order of the multi-part form data is important. The part meta data must be before the part file stream.

Part Description

part

Metadata for the notelog part

partStream

File stream for first notelog part
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: ac9eba78-6479-473e-9a24-4c997929af95:icmadmin:icmnlsdb:-28239905:null
Content-Type: application/json
Content-Length: 239
Date: Mon, 18 Nov 2024 20:10:47 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "89 3 ICM8 icmnlsdb10 ICMNOTELOG58 26 A1001001A24K18B21046A0006718 A24K18B21046A000671 13 303"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item replaced

partPid

String

Identifier of the part

PUT /items/{pid}/notelogs/{partPid}

Replace a notelog part of an item, the part is stored with a binary stream. Implicit item checkout will be done if the item is not locked.

request
PUT /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/notelogs/89%203%20ICM8%20icmnlsdb10%20ICMNOTELOG58%2026%20A1001001A24K18B21036E0006318%20A24K18B21036E000631%2013%20303 HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: multipart/form-data; boundary="ksrD8m2bBHjFloOOe2RW4AN8tVfCEIAdP3qrZyQw"; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Host: cm8.unicom.com

--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=part
Content-Type: application/json

{
  "mimetype" : "text/plain",
  "size" : 16,
  "originalFileName" : "replaced_notelog.txt"
}
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=partStream; filename=notelog.txt
Content-Type: application/octet-stream

<<notelog data>>
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
request path parameters
Parameter Description

pid

Identifier of item

partPid

Identifier of notelog part
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
request body form data parts

The order of the multi-part form data is important. The part meta data must be before the part file stream.

Part Description

part

Metadata for the notelog part

partStream

File stream for first notelog part
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 3183ec2a-5750-4c08-9c4f-6e5bddea8491:icmadmin:icmnlsdb:770619205:null
Content-Type: application/json
Content-Length: 239
Date: Mon, 18 Nov 2024 20:10:46 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "89 3 ICM8 icmnlsdb10 ICMNOTELOG58 26 A1001001A24K18B21036E0006318 A24K18B21036E000631 13 303"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item replaced

partPid

String

Identifier of the part replaced

PATCH /items/{pid}/notelogs

Modify the first notelog part: change the mimetype or original file name. Implicit item checkout will be done if the item is not locked. Attributes other than mimetype or original file name are ignored.

request
PATCH /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/notelogs HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: application/json
Host: cm8.unicom.com
Content-Length: 47

{
  "originalFileName" : "notelog_modify.txt"
}
request path parameters
Parameter Description

pid

Identifier of item
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 4d5a57bf-24ac-471e-a6aa-b9b04f71ccf5:icmadmin:icmnlsdb:1841721432:null
Content-Type: application/json
Content-Length: 239
Date: Mon, 18 Nov 2024 20:10:47 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "89 3 ICM8 icmnlsdb10 ICMNOTELOG58 26 A1001001A24K18B21046A0006718 A24K18B21046A000671 13 303"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item modified

partPid

String

Identifier of the part

PATCH /items/{pid}/notelogs/{partPid}

Modify a notelog part: change the mimetype or original file name. Implicit item checkout will be done if the item is not locked. Attributes other than mimetype or original file name are ignored.

request
PATCH /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/notelogs/89%203%20ICM8%20icmnlsdb10%20ICMNOTELOG58%2026%20A1001001A24K18B21036E0006318%20A24K18B21036E000631%2013%20303 HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: application/json
Host: cm8.unicom.com
Content-Length: 47

{
  "originalFileName" : "notelog_modify.txt"
}
request path parameters
Parameter Description

pid

Identifier of item

partPid

Identifier of notelog part
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 187e3c74-cc42-482b-8aca-18b7fd7fdc7f:icmadmin:icmnlsdb:906488642:null
Content-Type: application/json
Content-Length: 239
Date: Mon, 18 Nov 2024 20:10:47 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "89 3 ICM8 icmnlsdb10 ICMNOTELOG58 26 A1001001A24K18B21036E0006318 A24K18B21036E000631 13 303"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item modified

partPid

String

Identifier of the part modified

DELETE /items/{pid}/notelogs

Delete the first notelog part of an item. Implicit item checkout will be done if the item is not locked.

request
DELETE /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/notelogs HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request path parameters
Parameter Description

pid

Identifier of item
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 74e39815-f2e5-41cb-8fbd-fbd732b92469:icmadmin:icmnlsdb:-788417760:null
Content-Type: application/json
Content-Length: 239
Date: Mon, 18 Nov 2024 20:10:48 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "89 3 ICM8 icmnlsdb10 ICMNOTELOG58 26 A1001001A24K18B21046A0006718 A24K18B21046A000671 13 303"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item deleted

partPid

String

Identifier of the part

DELETE /items/{pid}/notelogs/{partPid}

Delete a notelog part of an item. Implicit item checkout will be done if the item is not locked.

request
DELETE /cm8app/cm8rest/v1/items/86%203%20ICM8%20icmnlsdb7%20NOINDEX59%2026%20A1001001A24K18B21036E0006018%20A24K18B21036E000601%2014%201000/notelogs/89%203%20ICM8%20icmnlsdb10%20ICMNOTELOG58%2026%20A1001001A24K18B21036E0006318%20A24K18B21036E000631%2013%20303 HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request path parameters
Parameter Description

pid

Identifier of item

partPid

Identifier of notelog part
request query parameters
Parameter Description

newVersion

(optional) Create a new version or update current latest version only if the defined version policy is 'Prompt to create', {true | false}. By default, this is false.

checkin

(optional) Check in item after update, {true | false | implicit}. By default, this is implicit.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 2a811d44-a747-4ea4-a901-6a1badab0460:icmadmin:icmnlsdb:1782932400:null
Content-Type: application/json
Content-Length: 239
Date: Mon, 18 Nov 2024 20:10:47 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "pid" : "86 3 ICM8 icmnlsdb7 NOINDEX59 26 A1001001A24K18B21036E0006018 A24K18B21036E000601 14 1000",
  "partPid" : "89 3 ICM8 icmnlsdb10 ICMNOTELOG58 26 A1001001A24K18B21036E0006318 A24K18B21036E000631 13 303"
}
Path Type Description

status

String

Status of the request

pid

String

Identifier of the item deleted

partPid

String

Identifier of the part deleted

Folders API

Operations available for folders.

GET /folders/{pid}/items

Retrieve a list of pids for items in a folder.

request
GET /cm8app/cm8rest/v1/folders/95%203%20ICM8%20icmnlsdb15%20XYZ_ClaimFolder59%2026%20A1001001A20E21B04204E0001718%20A20E21B04204E000171%2014%201024/items HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request path parameters
Parameter Description

pid

Identifier of the folder
request query parameters
Parameter Description

retrieve

(optional) Specify data to retrieve, {attributes | partsMetaData}. By default, PIDs will be retrieved.

retrieveCheckoutDetail

(optional) Retrieve check out details, {true | false}. By default, this is false.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: d78f18e9-e123-4d82-9b65-e9e3b0e81fa0:icmadmin:icmnlsdb:1618617211:null
Content-Type: application/json
Content-Length: 442
Date: Mon, 18 Nov 2024 20:10:48 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "items" : [ "93 3 ICM8 icmnlsdb13 XYZ_ClaimForm59 26 A1001001A20E21B04204D0001518 A20E21B04204D000151 14 1030", "93 3 ICM8 icmnlsdb13 XYZ_AdjReport59 26 A1001001A20E21B04204J0002418 A20E21B04204J000241 14 1026", "93 3 ICM8 icmnlsdb13 XYZ_PolReport59 26 A1001001A20E21B04205D0003018 A20E21B04205D000301 14 1036", "93 3 ICM8 icmnlsdb13 XYZ_AutoPhoto59 26 A1001001A20E21B04206B0004218 A20E21B04206B000421 14 1028" ]
}
Path Type Description

status

String

Status of the request

items

Array

An array of items

GET /folders/{pid}/items?retrieve=attributes&retrieveCheckoutDetail=true

Retrieve a list of items in a folder.

request
GET /cm8app/cm8rest/v1/folders/95%203%20ICM8%20icmnlsdb15%20XYZ_ClaimFolder59%2026%20A1001001A20E21B04204E0001718%20A20E21B04204E000171%2014%201024/items?retrieve=attributes&retrieveCheckoutDetail=true HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request path parameters
Parameter Description

pid

Identifier of the folder
request query parameters
Parameter Description

retrieve

(optional) Specify data to retrieve, {attributes | partsMetaData}. By default, PIDs will be retrieved.

retrieveCheckoutDetail

(optional) Retrieve check out details, {true | false}. By default, this is false.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 7650c06a-3273-45a7-98d3-31fcfca789fb:icmadmin:icmnlsdb:955976249:null
Content-Type: application/json
Content-Length: 4978
Date: Mon, 18 Nov 2024 20:10:49 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "items" : [ {
    "itemId" : "A1001001A20E21B04204D00015",
    "version" : "1",
    "pid" : "93 3 ICM8 icmnlsdb13 XYZ_ClaimForm59 26 A1001001A20E21B04204D0001518 A20E21B04204D000151 14 1030",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2020-05-21-10.42.04.438000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2020-05-21-10.42.04.438000",
    "itemtypeName" : "XYZ_ClaimForm",
    "aclName" : "XYZClaimFormACL",
    "attributes" : [ {
      "name" : "XYZ_ClaimFName",
      "type" : 1,
      "value" : "Gregory"
    }, {
      "name" : "XYZ_ClaimLName",
      "type" : 1,
      "value" : "Twain"
    }, {
      "name" : "XYZ_ClaimNumber",
      "type" : 1,
      "value" : "6-987654"
    }, {
      "name" : "XYZ_DriversLic",
      "type" : 1,
      "value" : "B12345696"
    }, {
      "name" : "XYZ_IncDate",
      "type" : 7,
      "value" : "2001-01-20"
    }, {
      "name" : "XYZ_InsrdFName",
      "type" : 1,
      "value" : "Gregory"
    }, {
      "name" : "XYZ_InsrdLName",
      "type" : 1,
      "value" : "Twain"
    }, {
      "name" : "XYZ_PolicyNum",
      "type" : 1,
      "value" : "10452136412"
    } ],
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false,
    "isCheckedOut" : false
  }, {
    "itemId" : "A1001001A20E21B04204J00024",
    "version" : "1",
    "pid" : "93 3 ICM8 icmnlsdb13 XYZ_AdjReport59 26 A1001001A20E21B04204J0002418 A20E21B04204J000241 14 1026",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2020-05-21-10.42.05.031000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2020-05-21-10.42.05.031000",
    "itemtypeName" : "XYZ_AdjReport",
    "aclName" : "XYZAdjusterReportACL",
    "attributes" : [ {
      "name" : "XYZ_AdjustDate",
      "type" : 7,
      "value" : "2001-02-01"
    }, {
      "name" : "XYZ_AdjustFName",
      "type" : 1,
      "value" : "Michael"
    }, {
      "name" : "XYZ_AdjustLName",
      "type" : 1,
      "value" : "Reed"
    }, {
      "name" : "XYZ_ClaimFName",
      "type" : 1,
      "value" : "Gregory"
    }, {
      "name" : "XYZ_ClaimLName",
      "type" : 1,
      "value" : "Twain"
    }, {
      "name" : "XYZ_ClaimNumber",
      "type" : 1,
      "value" : "6-987654"
    }, {
      "name" : "XYZ_IncDate",
      "type" : 7,
      "value" : "2001-01-20"
    }, {
      "name" : "XYZ_LicPlate",
      "type" : 1,
      "value" : "4IBM134"
    }, {
      "name" : "XYZ_PolicyNum",
      "type" : 1,
      "value" : "10452136412"
    } ],
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false,
    "isCheckedOut" : false
  }, {
    "itemId" : "A1001001A20E21B04205D00030",
    "version" : "1",
    "pid" : "93 3 ICM8 icmnlsdb13 XYZ_PolReport59 26 A1001001A20E21B04205D0003018 A20E21B04205D000301 14 1036",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2020-05-21-10.42.05.438000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2020-05-21-10.42.05.438000",
    "itemtypeName" : "XYZ_PolReport",
    "aclName" : "XYZPoliceReportACL",
    "attributes" : [ {
      "name" : "XYZ_ClaimNumber",
      "type" : 1,
      "value" : "6-987654"
    }, {
      "name" : "XYZ_ReportNum",
      "type" : 1,
      "value" : "01202001-30"
    }, {
      "name" : "XYZ_IncDate",
      "type" : 7,
      "value" : "2001-01-20"
    }, {
      "name" : "XYZ_VictimInfo",
      "type" : 1072,
      "children" : [ {
        "pid" : "94 3 ICM8 icmnlsdb14 XYZ_VictimInfo59 26 A1001001A20E21B04205D0003018 A20E21B04205E693931 14 1037",
        "attributes" : [ {
          "name" : "XYZ_LicPlate",
          "type" : 1,
          "value" : "4IBM134"
        }, {
          "name" : "XYZ_DriversLic",
          "type" : 1,
          "value" : "B12345696"
        } ]
      } ]
    } ],
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false,
    "isCheckedOut" : false
  }, {
    "itemId" : "A1001001A20E21B04206B00042",
    "version" : "1",
    "pid" : "93 3 ICM8 icmnlsdb13 XYZ_AutoPhoto59 26 A1001001A20E21B04206B0004218 A20E21B04206B000421 14 1028",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2020-05-21-10.42.06.266000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2020-05-21-10.42.06.266000",
    "itemtypeName" : "XYZ_AutoPhoto",
    "aclName" : "XYZAutoPhotoACL",
    "attributes" : [ {
      "name" : "XYZ_AdjustDate",
      "type" : 7,
      "value" : "2001-02-01"
    }, {
      "name" : "XYZ_AdjustFName",
      "type" : 1,
      "value" : "Michael"
    }, {
      "name" : "XYZ_AdjustLName",
      "type" : 1,
      "value" : "Reed"
    }, {
      "name" : "XYZ_ClaimNumber",
      "type" : 1,
      "value" : "6-987654"
    }, {
      "name" : "XYZ_PolicyNum",
      "type" : 1,
      "value" : "10452136412"
    }, {
      "name" : "XYZ_VIN",
      "type" : 1,
      "value" : "1HOME10R4KL987258"
    } ],
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false,
    "isCheckedOut" : false
  } ]
}
Path Type Description

status

String

Status of the request

items

Array

An array of items

GET /folders/{pid}/items?retrieve=partsMetaData

Retrieve a list of items in a folder.

request
GET /cm8app/cm8rest/v1/folders/95%203%20ICM8%20icmnlsdb15%20XYZ_ClaimFolder59%2026%20A1001001A20E21B04204E0001718%20A20E21B04204E000171%2014%201024/items?retrieve=partsMetaData HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request path parameters
Parameter Description

pid

Identifier of the folder
request query parameters
Parameter Description

retrieve

(optional) Specify data to retrieve, {attributes | partsMetaData}. By default, PIDs will be retrieved.

retrieveCheckoutDetail

(optional) Retrieve check out details, {true | false}. By default, this is false.
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 33d4acf2-47d1-4d73-abc8-b9452d2b151c:icmadmin:icmnlsdb:-623105896:null
Content-Type: application/json
Content-Length: 9589
Date: Mon, 18 Nov 2024 20:10:49 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "items" : [ {
    "itemId" : "A1001001A20E21B04204D00015",
    "version" : "1",
    "pid" : "93 3 ICM8 icmnlsdb13 XYZ_ClaimForm59 26 A1001001A20E21B04204D0001518 A20E21B04204D000151 14 1030",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2020-05-21-10.42.04.438000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2020-05-21-10.42.04.438000",
    "itemtypeName" : "XYZ_ClaimForm",
    "aclName" : "XYZClaimFormACL",
    "attributes" : [ {
      "name" : "XYZ_ClaimFName",
      "type" : 1,
      "value" : "Gregory"
    }, {
      "name" : "XYZ_ClaimLName",
      "type" : 1,
      "value" : "Twain"
    }, {
      "name" : "XYZ_ClaimNumber",
      "type" : 1,
      "value" : "6-987654"
    }, {
      "name" : "XYZ_DriversLic",
      "type" : 1,
      "value" : "B12345696"
    }, {
      "name" : "XYZ_IncDate",
      "type" : 7,
      "value" : "2001-01-20"
    }, {
      "name" : "XYZ_InsrdFName",
      "type" : 1,
      "value" : "Gregory"
    }, {
      "name" : "XYZ_InsrdLName",
      "type" : 1,
      "value" : "Twain"
    }, {
      "name" : "XYZ_PolicyNum",
      "type" : 1,
      "value" : "10452136412"
    } ],
    "parts" : {
      "contentPartsCount" : 1,
      "annotationPartsCount" : 0,
      "notelogPartsCount" : 0,
      "contentParts" : [ {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A20E21B04204D0001618 A20E21B04204D000161 13 300",
        "mimetype" : "image/tiff",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/A1001001A20E21B04204D00016.tif?order=retrieve&item-id=A1001001A20E21B04204D00016&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2020-05-21+17%3A42%3A04.391011000&token=ADUA.Nnt0GIgmvGU2_CfOl5kp7OMPeoH7IlZenW_VSjDn2nwbPklgsfnb1aXR;&content-length=0&content-type=image%2Ftiff",
        "size" : 20516,
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2020-05-21 17:42:04.391011000",
        "updatedTimestamp" : "2020-05-21 17:42:04.391011000"
      } ],
      "annotationParts" : [ ],
      "notelogParts" : [ ]
    },
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false
  }, {
    "itemId" : "A1001001A20E21B04204J00024",
    "version" : "1",
    "pid" : "93 3 ICM8 icmnlsdb13 XYZ_AdjReport59 26 A1001001A20E21B04204J0002418 A20E21B04204J000241 14 1026",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2020-05-21-10.42.05.031000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2020-05-21-10.42.05.031000",
    "itemtypeName" : "XYZ_AdjReport",
    "aclName" : "XYZAdjusterReportACL",
    "attributes" : [ {
      "name" : "XYZ_AdjustDate",
      "type" : 7,
      "value" : "2001-02-01"
    }, {
      "name" : "XYZ_AdjustFName",
      "type" : 1,
      "value" : "Michael"
    }, {
      "name" : "XYZ_AdjustLName",
      "type" : 1,
      "value" : "Reed"
    }, {
      "name" : "XYZ_ClaimFName",
      "type" : 1,
      "value" : "Gregory"
    }, {
      "name" : "XYZ_ClaimLName",
      "type" : 1,
      "value" : "Twain"
    }, {
      "name" : "XYZ_ClaimNumber",
      "type" : 1,
      "value" : "6-987654"
    }, {
      "name" : "XYZ_IncDate",
      "type" : 7,
      "value" : "2001-01-20"
    }, {
      "name" : "XYZ_LicPlate",
      "type" : 1,
      "value" : "4IBM134"
    }, {
      "name" : "XYZ_PolicyNum",
      "type" : 1,
      "value" : "10452136412"
    } ],
    "parts" : {
      "contentPartsCount" : 1,
      "annotationPartsCount" : 0,
      "notelogPartsCount" : 0,
      "contentParts" : [ {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A20E21B04204J0002518 A20E21B04204J000251 13 300",
        "mimetype" : "image/tiff",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/A1001001A20E21B04204J00025.tif?order=retrieve&item-id=A1001001A20E21B04204J00025&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2020-05-21+17%3A42%3A04.984023000&token=ADUA.Nnt0GIgmvGU2_5aZs7Ym7iwMekZ8qfiiOYB2zDztQrrHSaj3Ft8linXE;&content-length=0&content-type=image%2Ftiff",
        "size" : 37964,
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2020-05-21 17:42:04.984023000",
        "updatedTimestamp" : "2020-05-21 17:42:04.984023000"
      } ],
      "annotationParts" : [ ],
      "notelogParts" : [ ]
    },
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false
  }, {
    "itemId" : "A1001001A20E21B04205D00030",
    "version" : "1",
    "pid" : "93 3 ICM8 icmnlsdb13 XYZ_PolReport59 26 A1001001A20E21B04205D0003018 A20E21B04205D000301 14 1036",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2020-05-21-10.42.05.438000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2020-05-21-10.42.05.438000",
    "itemtypeName" : "XYZ_PolReport",
    "aclName" : "XYZPoliceReportACL",
    "attributes" : [ {
      "name" : "XYZ_ClaimNumber",
      "type" : 1,
      "value" : "6-987654"
    }, {
      "name" : "XYZ_ReportNum",
      "type" : 1,
      "value" : "01202001-30"
    }, {
      "name" : "XYZ_IncDate",
      "type" : 7,
      "value" : "2001-01-20"
    }, {
      "name" : "XYZ_VictimInfo",
      "type" : 1072,
      "children" : [ {
        "pid" : "94 3 ICM8 icmnlsdb14 XYZ_VictimInfo59 26 A1001001A20E21B04205D0003018 A20E21B04205E693931 14 1037",
        "attributes" : [ {
          "name" : "XYZ_LicPlate",
          "type" : 1,
          "value" : "4IBM134"
        }, {
          "name" : "XYZ_DriversLic",
          "type" : 1,
          "value" : "B12345696"
        } ]
      } ]
    } ],
    "parts" : {
      "contentPartsCount" : 1,
      "annotationPartsCount" : 0,
      "notelogPartsCount" : 0,
      "contentParts" : [ {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A20E21B04205D0003118 A20E21B04205D000311 13 300",
        "mimetype" : "image/tiff",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/A1001001A20E21B04205D00031.tif?order=retrieve&item-id=A1001001A20E21B04205D00031&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2020-05-21+17%3A42%3A05.391035000&token=ADUA.Nnt0GIgmvGU2_3aJFfUWyXgHLweNBhx.VWxubiYymkqmjVShSXfxVC39;&content-length=0&content-type=image%2Ftiff",
        "size" : 55848,
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2020-05-21 17:42:05.391035000",
        "updatedTimestamp" : "2020-05-21 17:42:05.391035000"
      } ],
      "annotationParts" : [ ],
      "notelogParts" : [ ]
    },
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false
  }, {
    "itemId" : "A1001001A20E21B04206B00042",
    "version" : "1",
    "pid" : "93 3 ICM8 icmnlsdb13 XYZ_AutoPhoto59 26 A1001001A20E21B04206B0004218 A20E21B04206B000421 14 1028",
    "createdUserid" : "ICMADMIN",
    "createdTimestamp" : "2020-05-21-10.42.06.266000",
    "updatedUserid" : "ICMADMIN",
    "updatedTimestamp" : "2020-05-21-10.42.06.266000",
    "itemtypeName" : "XYZ_AutoPhoto",
    "aclName" : "XYZAutoPhotoACL",
    "attributes" : [ {
      "name" : "XYZ_AdjustDate",
      "type" : 7,
      "value" : "2001-02-01"
    }, {
      "name" : "XYZ_AdjustFName",
      "type" : 1,
      "value" : "Michael"
    }, {
      "name" : "XYZ_AdjustLName",
      "type" : 1,
      "value" : "Reed"
    }, {
      "name" : "XYZ_ClaimNumber",
      "type" : 1,
      "value" : "6-987654"
    }, {
      "name" : "XYZ_PolicyNum",
      "type" : 1,
      "value" : "10452136412"
    }, {
      "name" : "XYZ_VIN",
      "type" : 1,
      "value" : "1HOME10R4KL987258"
    } ],
    "parts" : {
      "contentPartsCount" : 2,
      "annotationPartsCount" : 0,
      "notelogPartsCount" : 0,
      "contentParts" : [ {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A20E21B04206B0004318 A20E21B04206B000431 13 300",
        "mimetype" : "image/tiff",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/A1001001A20E21B04206B00043.tif?order=retrieve&item-id=A1001001A20E21B04206B00043&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2020-05-21+17%3A42%3A06.203059000&token=ADUA.Nnt0GIgmvGU2_AQi6TiPPDdSr_1G83vXZDvlWVxOVe.0LMlrvrPrURL2;&content-length=0&content-type=image%2Ftiff",
        "size" : 207904,
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2020-05-21 17:42:06.203059000",
        "updatedTimestamp" : "2020-05-21 17:42:06.203059000"
      }, {
        "pid" : "85 3 ICM8 icmnlsdb7 ICMBASE58 26 A1001001A20E21B04206B0004418 A20E21B04206B000441 13 300",
        "mimetype" : "image/tiff",
        "url" : "http://cmdvw1.development.unicom.software:9080/icmrm/ICMResourceManager/A1001001A20E21B04206B00044.tif?order=retrieve&item-id=A1001001A20E21B04206B00044&version=1&collection=CBR.CLLCT001&libname=icmnlsdb&update-date=2020-05-21+17%3A42%3A06.235062000&token=ADUA.Nnt0GIgmvGU2_9t0OSg15XdtUNSyghYi8OE3h.t_NvI7hJOYdkkdIw22;&content-length=0&content-type=image%2Ftiff",
        "size" : 186868,
        "partType" : "ICMBASE",
        "rmName" : "rmdb",
        "smsCollName" : "CBR.CLLCT001",
        "createdTimestamp" : "2020-05-21 17:42:06.235062000",
        "updatedTimestamp" : "2020-05-21 17:42:06.235062000"
      } ],
      "annotationParts" : [ ],
      "notelogParts" : [ ]
    },
    "isDocument" : true,
    "isFolder" : false,
    "isItem" : false
  } ]
}
Path Type Description

status

String

Status of the request

items

Array

An array of items

POST /folders/{pid}/items/{itemPid}

Add an item to a folder. Implicit checkout/checkin of the item will be done.

request
POST /cm8app/cm8rest/v1/folders/95%203%20ICM8%20icmnlsdb15%20XYZ_ClaimFolder59%2026%20A1001001A20E21B04204E0001718%20A20E21B04204E000171%2014%201024/items/93%203%20ICM8%20icmnlsdb13%20XYZ_ClaimForm59%2026%20A1001001A20E21B04204D0001518%20A20E21B04204D000151%2014%201030 HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: application/x-www-form-urlencoded; charset=ISO-8859-1
Host: cm8.unicom.com
request path parameters
Parameter Description

pid

Identifier of the folder

itemPid

Identifier of the item
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: f2a57164-6bee-4acf-aa0b-87fe97ac735f:icmadmin:icmnlsdb:2054303865:null
Content-Type: application/json
Content-Length: 258
Date: Mon, 18 Nov 2024 20:10:49 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success",
  "folderPid" : "95 3 ICM8 icmnlsdb15 XYZ_ClaimFolder59 26 A1001001A20E21B04204E0001718 A20E21B04204E000171 14 1024",
  "itemPid" : "93 3 ICM8 icmnlsdb13 XYZ_ClaimForm59 26 A1001001A20E21B04204D0001518 A20E21B04204D000151 14 1030"
}
Path Type Description

status

String

Status of the request

folderPid

String

Identifier of the folder modified

itemPid

String

Identifier of the item added into the folder

DELETE /folders/{pid}/items/{itemPid}

Remove an item from a folder. Implicit checkout/checkin of the item will be done.

request
DELETE /cm8app/cm8rest/v1/folders/95%203%20ICM8%20icmnlsdb15%20XYZ_ClaimFolder59%2026%20A1001001A20E21B04204E0001718%20A20E21B04204E000171%2014%201024/items/93%203%20ICM8%20icmnlsdb13%20XYZ_ClaimForm59%2026%20A1001001A20E21B04204D0001518%20A20E21B04204D000151%2014%201030 HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request path parameters
Parameter Description

pid

Identifier of the folder

itemPid

Identifier of the item
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 1afafc77-fa08-4074-b0c6-31b0374dfd69:icmadmin:icmnlsdb:67813045:null
Content-Type: application/json
Content-Length: 26
Date: Mon, 18 Nov 2024 20:10:49 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "success"
}
Path Type Description

status

String

Status of the request

Data API

Operations available for part data.

GET /data/icmforms/{name}

Retrieve byte data of an ICMFORM identified by name.

request
GET /cm8app/cm8rest/v1/data/icmforms/A655522. HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
request path parameters
Parameter Description

name

Name of ICMFORM
response
HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 7860db28-b338-482d-b2cc-d6ef54dcb188:icmadmin:icmnlsdb:-1661113791:null
Content-Type: application/octet-stream
Transfer-Encoding: chunked
Date: Mon, 18 Nov 2024 20:10:51 GMT
Keep-Alive: timeout=60
Connection: keep-alive
Content-Length: 21

<< IMAGE BODY HERE >>

Exceptions

Forbidden Authentication

request
POST /cm8app/cm8rest/v1/login HTTP/1.1
Content-Type: application/json
Host: cm8.unicom.com
Content-Length: 84

{
  "password" : "invalid",
  "servername" : "icmnlsdb",
  "username" : "icmadmin"
}
response
HTTP/1.1 403 Forbidden
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 84fa94d8-3acf-404f-9b69-c0511b20e67e
Content-Type: application/json
Content-Length: 184
Date: Mon, 18 Nov 2024 20:10:51 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "fail",
  "exception" : {
    "id" : 464,
    "message" : "com.ibm.mm.beans.CMBConnectFailedException: DGL0464A: Invalid password",
    "type" : "",
    "code" : 0
  }
}

Not Authorized

request
GET /cm8app/cm8rest/v1/itemtypes/NOINDEX HTTP/1.1
Host: cm8.unicom.com
response
HTTP/1.1 401 Unauthorized
WWW-Authenticate: Bearer realm="example"
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: ac9cb980-7f13-466a-8f75-077791e69f40
Content-Type: text/html;charset=utf-8
Content-Language: en
Content-Length: 437
Date: Mon, 18 Nov 2024 20:10:51 GMT
Keep-Alive: timeout=60
Connection: keep-alive

<!doctype html><html lang="en"><head><title>HTTP Status 401 – Unauthorized</title><style type="text/css">body {font-family:Tahoma,Arial,sans-serif;} h1, h2, h3, b {color:white;background-color:#525D76;} h1 {font-size:22px;} h2 {font-size:16px;} h3 {font-size:14px;} p {font-size:12px;} a {color:black;} .line {height:1px;background-color:#525D76;border:none;}</style></head><body><h1>HTTP Status 401 – Unauthorized</h1></body></html>

Expired Authentication

request
GET /cm8app/cm8rest/v1/itemtypes/NOINDEX HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJtYWNsc2RiOmljbWFkbWluOnNuMHdidW50IiwiZXhwIjoxNTc5MjEzNTM4fQ.RxK2ypWrUb6DuGX-Jh_g6zmWnf48JTgvj73pvHc3zmK2_OnJWmroja5mViSszj0BuyvpgmDAuj3fRPv2aIbx-g
Host: cm8.unicom.com
response
HTTP/1.1 401 Unauthorized
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 121b1124-7bcf-4955-ba91-58d2822310b5
Content-Type: application/json
Content-Length: 248
Date: Mon, 18 Nov 2024 20:10:51 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "status" : "fail",
  "exception" : {
    "id" : 0,
    "message" : "com.ibm.mm.beans.CMBException: Cannot verify JWS signature: unable to locate signature verification key for JWS with header: {alg=HS512}",
    "type" : "",
    "code" : 0
  }
}

Bad Request

request
POST /cm8app/cm8rest/v1/items/query?limit=2 HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Content-Type: text/plain; charset=ISO-8859-1
Host: cm8.unicom.com
Content-Length: 24

invalid string for query
response
HTTP/1.1 400 Bad Request
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: 3f624e8e-71f4-4314-aa1c-814bc20a4771:icmadmin:icmnlsdb:-1068742104:null
Content-Type: application/json
Content-Length: 187
Date: Mon, 18 Nov 2024 20:10:51 GMT
Connection: close

{
  "status" : "fail",
  "exception" : {
    "id" : 5020,
    "message" : "DGL5020A: Illegal token 'string' (9,14) encountered in the query string.",
    "type" : "",
    "code" : 0
  }
}

Invalid PID

request
PUT /cm8app/cm8rest/v1/items/93%203%20ICM8%20icmnlsdb13%20XYZ_InsPolicy59%2026%20A1001001A24K18B21050J0006918%20A24K18B21050J000691%2014%201032400/checkout HTTP/1.1
Authorization: Bearer eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..3j-u_-i9mCw1pwFP.eegpgd1tG6IZSPcv-5r8T__U4fMjZTcjNtnjlu_SZbTLGbdpGnIeeTVwSL7-N8qfamd3DKvB_Bq_.G2zZPYVkYmB4Yy5CqBH-gA
Host: cm8.unicom.com
response
HTTP/1.1 400 Bad Request
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Referrer-Policy: strict-origin-when-cross-origin
Correlation-Id: ca54a4e4-806c-404c-94ce-8c97d18bb354:icmadmin:icmnlsdb:-1432622430:null
Content-Type: application/json
Content-Length: 273
Date: Mon, 18 Nov 2024 20:10:51 GMT
Connection: close

{
  "status" : "fail",
  "exception" : {
    "id" : 303,
    "message" : "com.ibm.mm.beans.CMBException: DGL0303A: Invalid parameter[93 3 ICM8 icmnlsdb13 XYZ_InsPolicy59 26 A1001001A24K18B21050J0006918 A24K18B21050J000691 14 1032400]",
    "type" : "",
    "code" : 0
  }
}