Overview

Gets the document containing all fields and additional system information	`GET /api/content/docs/{documentReference`}
Creates a document	`POST /api/content/docs`
Updates an existing document	`PUT /api/content/docs/{documentReference`}
Updates an existing document	`PATCH /api/content/docs/{documentReference`}
Deletes an existing document	`DELETE /api/content/docs/{documentReference`}
Create a new note	`POST /api/content/docs/{documentReference}/notes`
Gets the list of specified document notes	`GET /api/content/docs/{documentReference}/notes`
Gets an attachment as stream	`GET /api/content/docs/{documentReference}/attachments/{id`

The previously used x-use.shortreferences header is deprecated, but is still supported for backward compatibility.
Please use
x-use-shortreferences
instead.

Descriptions

Gets the document containing all fields and additional system information.

GET /api/content/docs/{documentReference}

Reads a single document from the system which is specified by its URL encoded reference.

documentReference has to be the full qualified and url encoded document reference.

I.e. Unit%3DDefault%2FPool%3DAdaptive%2FPool%3DAdaptive01%2FDocument%3DADAPTIVE.BECC4E5D6E1C11E898EF204747C0B066)

The full qualified and url encoded document reference can be obtained via the header parameter

"x-use-shortreferences" : false

Request

Query Parameters

Parameter Name	Type	Required	Description
types	Boolean	false	Determines whether the field types should also be returned or not.
versions	Boolean	false	Determines whether the document versions should also be returned or not.
notes	Boolean	false	Determines whether the document notes should also be returned or not.
logout	Boolean	false	Logs out the user and ends the session.

Response

Returns

http 200 - OK, call successful.
http 401 - Unauthorized if the authentication process has been failed.
http 404 - Will be returned if the document (specified by its reference) does not exist.

Data structure

Property	Type	Description
store	String	The document's store name or unique store ID.
schema	String	The document's schema name.
status	String	This property indicates whether the document has been archived or saved as a living document.
fields	Object	The fields of a document.
......//	String \| Number \| Boolean \| String[] \| Number[]\| Boolean[] \| Mixed[]	The field's name and value pair. '//' stands for "any field name". Mixed example: "fields" : { "mixedField": ["a String", true, 14.5] } Therefore, types must be set to the following: "types" : { "mixedField": ["text", "boolean", "number"] }
types	Object	The types of the document fields.
......//	String \| String[]	Field name and field type as a key/value pair. '//' stands for "any field name".
version	String	The document's version number.
id	String	The document's unique ID.
createUsername	String	The name of the user who created the document.
modifyUsername	String	The name of the last user who modified the document.
createDate	DateTime	Document creation date.
modifyDate	DateTime	Document modification date.
versions	Array	An array of document version information.
......createUsername	String	The user name of the document version creator.
......createDate	DateTime	The date of creation of the document version.
......version	String	The version number.
......id	String	The ID of the document version.
attachments	Array	An array of attachments containing each attachment's meta information.
......uploadId	String	The attachment's ID, which is returned by binary stream upload via /files/upload.
......name	String	The attachment's name.
......length	number	The attachment's size.
......contentType	String	The attachment's content type.
......category	String	The name of the BLOB attribute.
......id	String	The attachment's ID.
......fields	Object	The attachment's fields.
............//	String \| Number \| Boolean	The field's name and value pair. '//' stands for "any field name".
......types	Object	The data types of the specified attachment fields.
............//	String	Field name and field type als key/value pair. '//' stands for "any field name". Allowed values are: text datetime boolean number
textMarker	Object	Describes the position(s) of the found search term per field.
......//	Array	An array of text markers for a single field. '//' stands for "any field name".

Example of a document structure (GET RESPONSE body)

{
    "_links": {
        "schema": {
            "rel": "related",
            "href": "http://localhost:9090/api/content/schemas/ADAPTIVE"
        },
        "notes": {
            "rel": "related",
            "href": "http://localhost:9090/api/content/docs/Y0SxLKO0nKMyY0SxLKO0nKMyZQRiDHEOHSEWIxHhDmN4DxESBGR2ExDkZGSSBQx1DwLlZQD3AQqQZRVjAwL1/notes"
        },
        "self": {
            "rel": "self",
            "href": "http://localhost:9090/api/content/docs/Y0SxLKO0nKMyY0SxLKO0nKMyZQRiDHEOHSEWIxHhDmN4DxESBGR2ExDkZGSSBQx1DwLlZQD3AQqQZRVjAwL1"
        }
    },
    "id": "Y0SxLKO0nKMyY0SxLKO0nKMyZQRiDHEOHSEWIxHhDmN4DxESBGR2ExDkZGSSBQx1DwLlZQD3AQqQZRVjAwL1",
    "schema": "ADAPTIVE",
    "version": "0",
    "createUsername": "superadmin",
    "createDate": "2018-06-14T14:52:11+02:00",
    "fields": {
        "index_text": "Installation\r\nEASY Documents automatically provides all required functionalities to the EASY Documents provider.",
        "index_dec": 23.09,
        "content_text": "Installation\r\nEASY Documents automatically provides all required functionalities to the EASY Documents provider.\r\nConnection parameter\r\nBecause multiple user sessions must be performed via an instance of the EASY Documents Soap proxy server, the value SequenceSessionId=0 may not be set in the docsoapproxy.ini file of the EASY Documents installation, because otherwise the user session cannot be disconnected.",
        "index_boolean": true,
        "index_date": "2017-05-03T17:00:00+02:00",
        "index_num": 332,
        "lastname": "imGlück"
    },
    "types": {
        "index_text": "text",
        "index_dec": "number",
        "content_text": "text",
        "index_boolean": "boolean",
        "index_date": "datetime",
        "index_num": "number",
        "lastname": "text"
    },
    "attachments": [
        {
            "_links": {
                "self": {
                    "rel": "self",
                    "href": "http://localhost:9090/api/content/docs/Y0SxLKO0nKMyY0SxLKO0nKMyZQRiDHEOHSEWIxHhDmN4DxESBGR2ExDkZGSSBQx1DwLlZQD3AQqQZRVjAwL1/attachments/C0B1B6276FD111E895B6204747C0B066"
                }
            },
            "fields": {
                "index": 0
            },
            "name": "invoice.pdf",
            "length": 1965472,
            "category": "Invoice",
            "id": "C0B1B6276FD111E895B6204747C0B066",
            "contentType": "application/x-www-form-urlencoded",
            "reference": "U4fVNNNNNNNNNAA3GRxfXZxfF9JUZDjZ9E1qUNAPCZAp9MjAYWkpKP0AmqkpQN0AKF0fGM3ZwNkZmR3ZaD2pQZmZ9VTHVIQVUWpPNVUiItAsNNNN0"
        },
        {
            "_links": {
                "self": {
                    "rel": "self",
                    "href": "http://localhost:9090/api/content/docs/Y0SxLKO0nKMyY0SxLKO0nKMyZQRiDHEOHSEWIxHhDmN4DxESBGR2ExDkZGSSBQx1DwLlZQD3AQqQZRVjAwL1/attachments/C0B8E21C6FD111E895B6204747C0B066"
                }
            },
            "fields": {
                "index": 1
            },
            "name": "invoice2.pdf",
            "length": 519437,
            "category": "Invoice",
            "id": "C0B8E21C6FD111E895B6204747C0B066",
            "contentType": "application/x-www-form-urlencoded",
            "reference": "U4fVNNNNNNNNNAA3GRxfXZxfF9JUZDjZ9E1qUNAPCZAp9MjAYWkpKP0AmqkpQN0AKF0fGM3ZwNkZmR3ZaD2pQZmZ9VTHunhEbGZhODOMCwikKjNNNN2"
        }
    ],
    "_response": {
        "code": 200,
        "message": "OK",
        "warnings": []
    },
    "modifyDate": "2018-06-14T15:44:06+02:00",
    "modifyUsername": "superadmin",
    "versions": [
        {
            "_links": {
                "self": {
                    "rel": "self",
                    "href": "http://localhost:9090/api/content/docs/Y0SxLKO0nKMyY0SxLKO0nKMyZQRiDHEOHSEWIxHhDmN4DxESBGR2ExDkZGSSBQx1DwLlZQD3AQqQZRVjAwL1"
                }
            },
            "createUsername": "superadmin",
            "createDate": "2018-06-14T14:52:11.000+02:00",
            "comment": "",
            "version": "0",
            "id": "Y0SxLKO0nKMyY0SxLKO0nKMyZQRiDHEOHSEWIxHhDmN4DxESBGR2ExDkZGSSBQx1DwLlZQD3AQqQZRVjAwL1"
        }
    ],
    "notes": [
        {
            "createDate": "2018-06-14T15:44:05.000+02:00",
            "createUsername": "superadmin",
            "comment": "Amount of 'Wlan cable' checked and changed"
        },
        {
            "createDate": "2018-06-14T15:43:56.000+02:00",
            "createUsername": "superadmin",
            "comment": "Please check the total amount of item 'Wlan cable'"
        }
    ]
}

Creates a document.

POST /api/content/docs

Creates a single document.

The full qualified document reference of the created document can be obtained by adding the header parameter

"x-use-shortreferences" with value 'false'

to this request. If no such header parameter is sent or if this header parameter value is 'true', a short document reference is returned as self link in the response body.

Request

Input

Property	Type	Required	Description
store	String	false	The document's store name or unique store ID.
schema	String	false	The document's schema name.
status	String	false	This property indicates whether the document has been archived or saved as a living document. This property can only contain the value "archived"; this allows archiving the document. If it is completely missing, the document will be saved as a living document. If a document has already been archived but should be updated (document update), a new document version will be generated instead and that version will also be archived.
fields	Object	false	The fields of a document.
......//	String \| Number \| Boolean \| String[] \| Number[]\| Boolean[] \| Mixed[]	true	The field's name and value pair. '//' stands for "any field name". Mixed example: "fields" : { "mixedField": ["a String", true, 14.5] } Therefore, types must be set to the following: "types" : { "mixedField": ["text", "boolean", "number"] }
types	Object	false	The types of the document fields. It must be set if a field has type array
......//	String \| String[]	true	Field name and field type as a key/value pair. '//' stands for "any field name". Allowed values are: text datetime boolean number
version	String	false	The document's version number.
id	String	false	The document's unique ID.
createUsername	String	false	The name of the user who created the document.
modifyUsername	String	false	The name of the last user who modified the document.
createDate	DateTime	false	Document creation date.
modifyDate	DateTime	false	Document modification date.
versions	Array	false	An array of document version information.
......createUsername	String	true	The user name of the document version creator.
......createDate	DateTime	true	The date of creation of the document version.
......version	String	true	The version number.
......id	String	true	The id of the document version.
attachments	Array	false	An array of attachments containing meta information of each attachment.
......uploadId	String	false	The attachment's ID, which is returned by binary stream upload via /files/upload.
......name	String	false	The attachment's name.
......length	number	false	The attachment's size.
......contentType	String	false	The attachment's content type.
......category	String	false	The name of the blob attribute.
......id	String	false	The attachment's id.
......fields	Object	false	The attachment's fields.
............//	String \| Number \| Boolean	true	The field's name and value pair. '//' stands for "any field name".
......types	Object	false	The data types of the specified attachment fields.
............//	String	true	Field name and field type als key/value pair. Allowed values are: text datetime boolean number
textMarker	Object	false	Describes the position(s) of the found search term per field.
......//	Array	true	An array of text markers for a single field. '//' stands for "any field name".
associations	Array	false	An array of associations ("links") to other documents. Associations cannot be used with the ADAPTIVE document schema.
......name	String	true	The name of the field to store the association into. This field must be of type "Document reference (link)".
......reference	String	true	The document reference of the document to link to. This must be a full qualified document reference. A short reference cannot be used, therefore the header "x-use-shortreferences" must be set to "false" when using associations.

Example of a document structure (POST REQUEST body)

{
    "store": ".OCDMDYt9tGtctQNEvN0",
    "schema": "ADAPTIVE",
    "status": "archived",
    "fields": {
        "index_text": "Installation\r\nEASY Documents automatically provides all required functionalities to the EASY Documents provider.",
        "DOCUMENT_CLASS": "ADAPTIVE",
        "index_dec": 23.09,
        "content_text": "Multiple user sessions must be performed via an instance of the EASY Documents Soap proxy server.",
        "index_boolean": true,
        "index_date": "2017-05-03T10:00:00-05:00",
        "index_num": 332,
        "multiple": [ "one", 2 ]
    },
    "types": {
        "index_date": "datetime",
        "multiple": [ "text", "number" ]
    },
    "attachments": [
        {
            "uploadId": "d9de5e88b27948b4ad8b33abf584353f",
            "category": "Invoice",
            "name": "invoice.pdf",
            "fields": {
                "name": "invoice",
                "num": 32
            },
            "types": {
                "name": "text",
                "num": "number"
            }
        },
        {
            "uploadId": "c8e7b1b3f0784095a581e3235e0fefa7",
            "category": "Invoice",
            "name": "invoice2.pdf"
        }
    ]
}

Example of a document structure with associations (POST REQUEST body)

{
    "store": "CWS_StoreWithAssociations",
    "schema": "MyMainDocumentSchema",
    "fields": {
        "fld01": "lorem ipsum"
    },
    "associations": [
        {
            "name": "link01",
            "reference": "Unit=Default\/Instance=Default\/Pool=CWS\/Document=MySubDocumentSchema.A7C224F2E27611EDBA93005056B92822"
        },
        {
            "name": "link02",
            "reference": "Unit=Default\/Instance=Default\/Pool=CWS\/Document=MySubDocumentSchema.A08706FCE27811EDBA93005056B92822" 
        }
    ]
}

Response

Returns

Data structure

Property	Type	Description
store	String	The document's store location.
schema	String	The document's schema name.
status	String	This property indicates whether the document has been archived or saved as a living document.
fields	Object	The fields of a document.
......//	String \| Number \| Boolean \| String[] \| Number[]\| Boolean[] \| Mixed[]	The field's name and value pair. '//' stands for "any field name". Mixed example: "fields" : { "mixedField": ["a String", true, 14.5] } Therefore, types must be set to the following: "types" : { "mixedField": ["text", "boolean", "number"] }
types	Object	The types of the document fields.
......//	String \| String[]	The field name and field type as a key/value pair. '//' stands for "any field name".
version	String	The document's version number.
id	String	The document's unique ID.
createUsername	String	The name of the user who created the document.
modifyUsername	String	The name of the last user who modified the document.
createDate	DateTime	The date of the document creation.
modifyDate	DateTime	The date of the document modification.
versions	Array	An array of document version information.
......createUsername	String	The user name of the document version creator.
......createDate	DateTime	Document version creation date.
......version	String	The version number.
......id	String	The ID of the document version.
attachments	Array	An array of attachments containing each attachment's meta information.
......uploadId	String	The attachment's ID, which is returned by binary stream upload via /files/upload.
......name	String	The attachment's name.
......length	number	The attachment's size.
......contentType	String	The attachment's content type.
......category	String	The name of the blob attribute.
......id	String	The attachment's id.
......fields	Object	The attachment's fields.
............//	String \| Number \| Boolean	The field's name and value pair. '//' stands for "any field name".
......types	Object	The data types of the specified attachment fields.
............//	String	Field name and field type as a key/value pair. '//' stands for "any field name". Allowed values are: text datetime boolean number
textMarker	Object	Describes the position(s) of the found search term per field.
......//	Array	An array of text markers for a single field. '//' stands for "any field name".
associations	Array	An array of associations ("links") to other documents. Associations cannot be used with the ADAPTIVE document schema.
......name	String	The name of the field to store the association into. This field must be of type "Document reference (link)".
......displayName	String	An optional display name for the field. Is in most cases equal to the the "name" property.
......reference	String	The full qualified document reference of the linked document.

Updates an existing document.

PUT /api/content/docs/{documentReference}

Updates an existing document, specified by its document reference. Document parts which are not listed in the request body will be removed from the existing document.

documentReference has to be the full qualified and url encoded document reference.

I.e. Unit%3DDefault%2FPool%3DAdaptive%2FPool%3DAdaptive01%2FDocument%3DADAPTIVE.BECC4E5D6E1C11E898EF204747C0B066)

The full qualified document reference of the document can be obtained by adding the header parameter

"x-use-shortreferences" with value 'false'

to this request. If no such header parameter is sent or if this header parameter value is 'true', a short document reference is returned as self link in the response body.

Request

Input

Property	Type	Required	Description
schema	String	false	The document's schema name.
status	String	false	This property indicates whether the document has been archived or saved as a living document. This property can only contain the value "archived"; this allows archiving the document. If it is completely missing, the document will be saved as a living document. If a document has already been archived but should be updated (document update), a new document version will be generated instead and that version will also be archived.
fields	Object	false	The fields of a document.
......//	String \| Number \| Boolean \| String[] \| Number[]\| Boolean[] \| Mixed[]	true	The field's name and value pair. '//' stands for "any field name". Mixed example: "fields" : { "mixedField": ["a String", true, 14.5] } Therefore, types must be set to the following: "types" : { "mixedField": ["text", "boolean", "number"] }
types	Object	false	The types of the document fields.
......//	String \| String[]	true	The field name and field type as a key/value pair. '//' stands for "any field name". Allowed values are: text datetime boolean number
version	String	false	The document's version number.
id	String	false	The document's unique ID.
createUsername	String	false	The name of the user who created the document.
modifyUsername	String	false	The name of the last user who modified the document.
createDate	DateTime	false	Document creation date.
modifyDate	DateTime	false	Document modification date.
versions	Array	false	An array of document version information.
......createUsername	String	true	The user name of the document version creator.
......createDate	DateTime	true	The date of creation of the document version.
......version	String	true	The version number.
......id	String	true	The ID of the document version.
attachments	Array	false	An array of attachments, containing meta information of each attachment.
......uploadId	String	false	The attachment's id, which is returned by binary stream upload via /files/upload.
......name	String	false	The attachment's name.
......length	number	false	The attachment's size.
......contentType	String	false	The attachment's content type.
......category	String	false	The name of the BLOB attribute.
......id	String	false	The attachment's ID.
......fields	Object	false	The attachment's fields.
............//	String \| Number \| Boolean	true	The field's name and value pair. '//' stands for "any field name".
......types	Object	false	The data types of the specified attachment fields.
............//	String	true	Field name and field type as a key/value pair. '//' stands for "any field name". Allowed values are: text datetime boolean number
textMarker	Object	false	Describes the position(s) of the found search term per field.
......//	Array	true	An array of text markers for a single field. '//' stands for "any field name".

Example of a document structure (PUT REQUEST body)

{
    "fields": {
        "firstname" : "Hans",
        "lastname": "im Glück",
        "age" : 18
    },
    "types":{
        "age" : "number"
    },
    "attachments": [
        {
            "id": "2A75E8BE566711E78A3AECF4BB4BF5EE",
            "name": "jpeg"
        },
        {
            "uploadId": "a142cb220ab444d8a602431cdf6ef645",
            "contentType": "image/gif",
            "name": "gif"
        },
        {
            "uploadId": "f85249276082429aaf121b6874595d3a",
            "contentType": "image/gif",
            "name": "gif",
            "category": "abc"
        }
    ]
}

Example for removing an existing attachment (PUT REQUEST)

==============================================================================================
GET: /api/content/docs/Y1A0o3WuM2IsZF9OERSDIRyJEF44AQWTZwL5EGSOBQNkZHIOBRV1Zmp0EGITBHISZQt2ED2
RESPONSE: 
{
            .
            .
    "id": "Y1A0o3WuM2IsZF9OERSDIRyJEF44AQWTZwL5EGSOBQNkZHIOBRV1Zmp0EGITBHISZQt2ED2",
    .
    .
    "attachments": [
        {
            .
            "name": "billing.tiff",
            "id": "84325B021A8011EA8B5374E5F9EE086E",
            .
        },
        {
            .
            "name": "order1.jpg",
            "id": "12325B021DE441EA8B5374E5FREA08ZZ",
            .
        }
    ]
    .
    .
}
 
================================================================================================
to remove the attachment with the id '12325B021DE441EA8B5374E5FREA08ZZ' named 'order1.jpg'
 
PUT:   /api/content/docs/Y1A0o3WuM2IsZF9OERSDIRyJEF44AQWTZwL5EGSOBQNkZHIOBRV1Zmp0EGITBHISZQt2ED2 
BODY:
{
    .
    .
    "attachments": [
        {
            "id": "84325B021A8011EA8B5374E5F9EE086E",
            "name": "billing.tiff"
        }
    ]
}
 
RESPONSE:
 
 
{
            .
            .
            .
    "id": "Y1A0o3WuM2IsZF9OERSDIRyJEF44AQWTZwL5EGSOBQNkZHIOBRV1Zmp0EGITBHISZQt2ED2",
    .
    .
    .
    "attachments": [
        {
            .
            "name": "billing.tiff",
            "id": "84325B021A8011EA8B5374E5F9EE086E",
            .
        }
    ],
    "_response": {
        "code": 201,
        "message": "Created",
        "warnings": []
    }
}

Response

Returns

http 200 - OK,created.
http 401 - Unauthorized if the authentication process has failed.

Data structure

Property	Type	Description
schema	String	The document's schema name.
status	String	This property indicates whether the document has been archived or saved as a living document.
fields	Object	The fields of a document.
......//	String \| Number \| Boolean \| String[] \| Number[]\| Boolean[] \| Mixed[]	The field's name and value pair. '//' stands for "any field name". Mixed example: "fields" : { "mixedField": ["a String", true, 14.5] } Therefore, types must be set to the following: "types" : { "mixedField": ["text", "boolean", "number"] }
types	Object	The types of the document fields.
......//	String \| String[]	field name and field type as a key/value pair. '//' stands for "any field name". Allowed values are: text datetime boolean number
version	String	The document's version number.
id	String	The document's unique ID.
createUsername	String	The name of the user, who created the document.
modifyUsername	String	The name of the last user, who modified the document.
createDate	DateTime	Document creation date.
modifyDate	DateTime	Document modification date.
versions	Array	An array of document version information.
......createUsername	String	The user name of the document version creator.
......createDate	DateTime	The date of creation of the document version.
......version	String	The version number.
......id	String	The ID of the document version.
attachments	Array	An array of attachments containing meta information of each attachment.
......uploadId	String	The attachment's ID, which is returned by binary stream upload via /files/upload.
......name	String	The attachment's name.
......length	number	The attachment's size.
......contentType	String	The attachment's content type.
......category	String	The name of the BLOB attribute.
......id	String	The attachment's ID.
......fields	Object	The attachment's fields.
............//	String \| Number \| Boolean	The field's name and value pair. '//' stands for "any field name".
......types	Object	The data types of the specified attachment fields.
............//	String	Field name and field type as a key/value pair. '//' stands for "any field name". Allowed values are: text datetime boolean number
textMarker	Object	Describes the position(s) of the found search term per field.
......//	Array	An array of text markers for a single field. '//' stands for "any field name".

Updates an existing document.

PATCH /api/content/docs/{documentReference}

Updates an existing document, specified by its ID. Document parts which are not listed in the request body will not be removed from the existing document.

documentReference has to be the full qualified and url encoded document reference.

I.e. Unit%3DDefault%2FPool%3DAdaptive%2FPool%3DAdaptive01%2FDocument%3DADAPTIVE.BECC4E5D6E1C11E898EF204747C0B066)

The full qualified document reference of the document can be obtained by adding the header parameter

"x-use-shortreferences" with value 'false'

to this request. If no such header parameter is sent or if this header parameter value is 'true', a short document reference is returned as self link in the response body.

Request

Input

Property	Type	Required	Description
store	String	false	The document's store name or unique store ID.
schema	String	false	The document's schema name.
status	String	false	This property indicates whether the document has been archived or saved as a living document. This property can only contain the value "archived"; this allows archiving the document. If it is completely missing, the document will be saved as a living document. If a document has already been archived but should be updated (document update), a new document version will be generated instead and that version will also be archived.
fields	Object	false	The fields of a document.
......//	String \| Number \| Boolean \| String[] \| Number[]\| Boolean[] \| Mixed[]	true	The field's name and value pair. '//' stands for "any field name". Mixed example: "fields" : { "mixedField": ["a String", true, 14.5] } Therefore, types must be set to the following: "types" : { "mixedField": ["text", "boolean", "number"] }
types	Object	false	The types of the document fields.
......//	String \| String[]	true	The field name and field type as a key/value pair. '//' stands for "any field name". Allowed values are: string datetime boolean number
version	String	false	The document's version number.
id	String	false	The document's unique ID.
createUsername	String	false	The name of the user who created the document.
modifyUsername	String	false	The name of the last user who modified the document.
createDate	DateTime	false	Document creation date.
modifyDate	DateTime	false	Document modification date.
versions	Array	false	An array of document version information.
......createUsername	String	true	The user name of the document version creator.
......createDate	DateTime	true	The date of creation of the document version.
......version	String	true	The version number.
......id	String	true	The ID of the document version.
attachments	Array	false	An array of attachments containing each attachment's meta information.
......uploadId	String	false	The attachment's ID, which is returned by binary stream upload via /files/upload.
......name	String	false	The attachment's name.
......length	number	false	The attachment's size.
......contentType	String	false	The attachment's content type.
......category	String	false	The name of the BLOB attribute.
......id	String	false	The attachment's ID.
......fields	Object	false	The attachment's fields.
............//	String \| Number \| Boolean	true	The field's name and value pair. '//' stands for "any field name".
......types	Object	false	The data types of the specified attachment fields.
............//	String	true	Field name and field type as a key/value pair. '//' stands for "any field name". Allowed values are: text datetime boolean number
textMarker	Object	false	Describes the position(s) of the found search term per field.
......//	Array	true	An array of text markers for a single field. '//' stands for "any field name".

Example of a document structure (PATCH REQUEST body)

{
    "fields": {
        "last name": "Lucky"
    },
    "attachments": [
        {
            "id": "2A75E8BE566711E78A3AECF4BB4BF5EE",
            "name": "jpeg"
        },
        {
            "uploadId": "a142cb220ab444d8a602431cdf6ef645",
            "contentType": "image/gif",
            "name": "gif"
        },
        {
            "uploadId": "f85249276082429aaf121b6874595d3a",
            "contentType": "image/gif",
            "name": "gif",
            "category": "abc"
        }
    ]
}

Response

Returns

http 201 - OK,created.
http 401 - Unauthorized if the authentication process has failed.

Data structure

Property	Type	Description
store	String	The document's store location.
schema	String	The document's schema name.
status	String	This property indicates whether the document has been archived or saved as a living document.
fields	Object	The fields of a document.
......//	String \| Number \| Boolean \| String[] \| Number[]\| Boolean[] \| MIxed[]	The field's name and value pair. '//' stands for "any field name". Mixed example: "fields" : { "mixedField": ["a String", true, 14.5] } Therefore, types must be set to the following: "types" : { "mixedField": ["text", "boolean", "number"] }
types	Object	The types of the document fields.
......//	String \| String[]	Field name and field type as a key/value pair. '//' stands for "any field name". Allowed values are: text datetime boolean number
version	String	The document's version number
id	String	The document's unique ID
createUsername	String	The name of the user who created the document.
modifyUsername	String	The name of the last user who modified the document.
createDate	DateTime	Document creation date.
modifyDate	DateTime	Document modification date.
versions	Array	An array of document version information.
......createUsername	String	The user name of the document version creator.
......createDate	DateTime	The date of creation of the document version.
......version	String	The version number.
......id	String	The ID of the document version.
attachments	Array	An array of attachments containing meta information of each attachment.
......uploadId	String	The attachment's ID, which is returned by binary stream upload via /files/upload.
......name	String	The attachment's name.
......length	number	The attachment's size.
......contentType	String	The attachment's content type.
......category	String	The name of the BLOB attribute.
......id	String	The attachment's ID.
......fields	Object	The attachment's fields.
............//	String \| Number \| Boolean	The field's name and value pair. '//' stands for "any field name".
......types	Object	The data types of the specified attachment fields.
............//	String \| String[]	Field name and field type as a key/value pair. '//' stands for "any field name". Allowed values are: text datetime boolean number
textMarker	Object	Describes the position(s) of the found search term per field.
......//	Array	An array of text markers for a single field. '//' stands for "any field name".

Deletes an existing document.

DELETE /api/content/docs/{documentReference}

Deletes a single document which is specified by its URL encoded reference.

documentReference has to be the full qualified and url encoded document reference.

I.e. Unit%3DDefault%2FPool%3DAdaptive%2FPool%3DAdaptive01%2FDocument%3DADAPTIVE.BECC4E5D6E1C11E898EF204747C0B066)

Request

Query Parameters

Parameter Name	Type	Required	Default	Description
logout	Boolean	false		Logs out the user and closes the session.

Response

Returns

http 200 - OK, call successful.
http 401 - Unauthorized if the authentication process has been failed.
http 404 - Will be returned if the document (specified by its reference) does not exist.

Create a new note.

POST /api/content/docs/{documentReference}/notes

Create a new note for the document.

documentReference has to be the full qualified and url encoded document reference.

I.e. Unit%3DDefault%2FPool%3DAdaptive%2FPool%3DAdaptive01%2FDocument%3DADAPTIVE.BECC4E5D6E1C11E898EF204747C0B066)

Request

Query Parameters

Parameter Name	Type	Required	Description
logout	Boolean	false	Logs out the user and closes the session.

Input

Property	Type	Required	Description
comment	String	true	The note content

Example of a document note creation (POST Request body)

{
    "comment": "Amount of 'Wlan cable' checked and changed"
}

Response

Returns

http 201 - OK,created.
http 401 - Unauthorized if the authentication process has failed.

Data structure

Property	Type	Description
items	Array
......comment	String	The note content
......createUsername	String	The name of the user who created the note.
......createDate	DateTime	Note creation date.

Example of document notes (POST Response body)

{
   "items": [
        {
            "createDate": "2017-08-04T13:34:00.00Z",
            "createUsername": "h.smith",
            "comment": "Please check the total amount of item 'Wlan cable'"
        },
        {
            "createDate": "2017-08-14T08:23:00.00Z",
            "createUsername": "p.muster",
            "comment": "Amount of 'Wlan cable' checked and changed"
        }
    ]
}

Get the list of specified document notes.

GET /api/content/docs/{documentReference}/notes

Lists all the notes of the specified document.

documentReference has to be the full qualified and url encoded document reference.

I.e. Unit%3DDefault%2FPool%3DAdaptive%2FPool%3DAdaptive01%2FDocument%3DADAPTIVE.BECC4E5D6E1C11E898EF204747C0B066)

Request

Query Parameters

Parameter Name	Type	Required	Description
logout	Boolean	false	Logs out the user and closes the session.

Response

Returns

http 200 - OK, call successful.
http 401 - Unauthorized if the authentication process has failed.

Data structure

Property	Type	Description
items	Array
......comment	String	The note content
......createUsername	String	The name of the user who created the note.
......createDate	DateTime	Note creation date.

Example of a list of notes (GET Response body)

{
    "items": [
        {
            "createDate": "2017-08-04T13:34:00.00Z",
            "createUsername": "h.smith",
            "comment": "Please check the total amount of item 'Wlan cable'"
        },
        {
            "createDate": "2017-08-12T15:22:00.00Z",
            "createUsername": "h.smith",
            "comment": "Still waiting for response.."
        }
    ]
}

Gets an attachment as stream.

GET /api/content/docs/{documentReference}/attachments/{id}

Reads a single document from the system, which is specified by its URL encoded reference.

documentReference has to be the full qualified and url encoded document reference.

I.e. Unit%3DDefault%2FPool%3DAdaptive%2FPool%3DAdaptive01%2FDocument%3DADAPTIVE.BECC4E5D6E1C11E898EF204747C0B066)

Request

Query Parameters

Parameter Name	Type	Required	Description
logout	Boolean	false	logs out the user end ends the session.

Response

Returns

http 200 - OK, call successful.
http 401 - Unauthorized if the authentication process has failed.
http 404 - Will be returned if the attachment (specified by its ID) does not exist.