| Back | Main view

Product:	IMiS/StorageConnector Services REST
Release:	9.5.1910
Date:	03/06/2020

Case:

IMiS/Storage Connector Services REST - Object staging

Description:

This example demonstrates operations which create, read, change and delete content object in unstructured object storage on the IMiS/ARChive Server.
Requests and responses are in JSON format.
Below is a description of operations for the Object staging.

Content object create

Operation creates the content object in unstructured object storage.

Request
POST archives/{archiveId}/objects

Query parameters:
- external_id: External content object identifier (optional).
- reason: The reason for object creation (optional).
- stage: Defines the storage profile (optional).

Headers:
- Authorization: Bearer [session token]
- Content-Type: [object content type]

Body:
-  [content]

Response

Body:
{
  "object" : {
    "id" : "jMDmA5CDBBMJX58j__oq9OQrWcXl2jSS",
    "size" : 346432,
    "content_type" : "application/pdf",
    "extension" : ".pdf"
  }
}

object.id	String	Unique identifier of the content object.
object.size	Integer	The content object size (in bytes).
object.content_type	String	Content object type
object.extension	String	Extension of the content object file.

Response status:
- 200: Object created successfully.
- 401: Invalid session.
- 500: Server error.


Content object read

Operation reads content object in unstructured object storage.

Request
GET archives/{archiveId}/objects/{id}
and
GET archives/{archiveId}/objects/{idType}:{id}
The set of idType values: E, I.

Query parameters:
- reason: The reason to read object (optional).

Headers:
- Authorization: Bearer [session token]

Response

Headers:
- Content-Type: [object content type]
- Content-Length: [The content object size (in bytes)]

Body:
[content]

Response status:
- 200: Content object read successfully.
- 401: Invalid session.
- 500: Server error.


Content object properties read

Operation reads a content object properties in unstructured object storage.

Request
GET archives/{archiveId}/objects/{id}.json
and
GET archives/{archiveId}/objects/{idType}:{id}.json
The set of idType values: E, I.

Query parameters:
- reason: The reason to read object (optional).

Headers:
- Authorization: Bearer [session token]

Response

Body:
{
  "object" : {
    "id" : "jMDmA5CDBBMJX58j__oq9OQrWcXl2jSS",
    "size" : 346432,
    "content_type" : "application/pdf",
    "extension" : ".pdf"
  }
}

object.id	String	Unique identifier of the content object.
object.size	Integer	The content object size (in bytes).
object.content_type	String	Content object type
object.extension	String	Extension of the content object file.

Response status:
- 200: Content object properties read successfully.
- 401: Invalid session.
- 500: Server error.


Content object change

Operation changes a content object in unstructured object storage.

Request
PUT archives/{archiveId}/objects/{id}.json
and
PUT archives/{archiveId}/objects/{idType}:{id}.json
The set of idType values: E, I.

Query parameters:
- external_id: External identifier (optional).
- reason: The reason to change content object (optional).

Headers:
- Authorization: Bearer [session token]
- Content-Type: [object content type]

Body:
-  [content]

Response

Body:
{
  "object" : {
    "id" : "jMDmA5CDBBMJX58j__oq9OQrWcXl2jSS",
    "size" : 346432,
    "content_type" : "application/pdf",
    "extension" : ".pdf"
  }
}

object.id	String	Unique identifier of the content object.
object.size	Integer	The content object size (in bytes).
object.content_type	String	Content object type
object.extension	String	Extension of the content object file.

Response status:
- 200: Content object changed successfully.
- 401: Invalid session.
- 500: Server error.


Content object delete

Operation deletes a content object in unstructured object storage.

Request
DELETE archives/{archiveId}/objects/{id}.json
and
DELETE archives/{archiveId}/objects/{idType}:{id}.json
The set of idType values: E, I.

Query parameters:
- reason: The reason to delete content object.

Headers:
- Authorization: Bearer [session token]

Response

Response status:
- 200: Content object deleted successfully.
- 401: Invalid session.
- 500: Server error.


Related Documents:

IMiS/Storage Connector Services REST - Session

| Back | Main view