Documents API documentation version v1
Application_URL/services/api/v1
About Documents
Documents are additional details that you can attach such as design documents, instructions, logos, images and tutorials.
Purpose
This API allows you to upload, update, download documents and assign/unassign documents to other objects.
/document({documentID})/associated
get
This endpoint get all the associated objects for a document.
get /document({documentID})/associated
This endpoint get all the associated objects for a document.
URI Parameters
- documentID: required (string)
HTTP status code 200
gets associated objects of a document.
Body
Type: application/json
Schema:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"assignedModels": {
"$id": "/properties/assignedModels",
"type": "array",
"items": {
"$id": "/properties/assignedModels/items",
"type": "object",
"properties": {
"modelID": {
"$id": "/properties/assignedModels/items/properties/modelID",
"type": "string",
"title": "The Modelid Schema",
"default": "",
"examples": [
"ABC4E4CED0E64B189CDB28003FB59D8D"
]
},
"templateID": {
"$id": "/properties/assignedModels/items/properties/templateID",
"type": "string",
"title": "The Templateid Schema",
"default": "",
"examples": [
"92D08B5AF7C93031E10000000A78416B"
]
},
"modelName": {
"$id": "/properties/assignedModels/items/properties/modelName",
"type": "string",
"title": "The Modelname Schema",
"default": "",
"examples": [
"Model_V1"
]
},
"modelVersion": {
"$id": "/properties/assignedModels/items/properties/modelVersion",
"type": "string",
"title": "The Modelversion Schema",
"default": "",
"examples": [
"1.0"
]
},
"modelClass": {
"$id": "/properties/assignedModels/items/properties/modelClass",
"type": "string",
"title": "The Modelclass Schema",
"default": "",
"examples": [
"AIN_TEST_1_tkNPadGdUn4wem"
]
},
"modelSubClass": {
"$id": "/properties/assignedModels/items/properties/modelSubClass",
"type": "string",
"title": "The Modelsubclass Schema",
"default": "",
"examples": [
"AIN_TEST_2_JsIytKeOPBvldR"
]
},
"status": {
"$id": "/properties/assignedModels/items/properties/status",
"type": "string",
"title": "The Status Schema",
"default": "",
"examples": [
"3"
]
}
}
}
},
"assignedSteps": {
"$id": "/properties/assignedSteps",
"type": "array",
"items": {
"$id": "/properties/assignedSteps/items",
"type": "object",
"properties": {
"instructionID": {
"$id": "/properties/assignedSteps/items/properties/instructionID",
"type": "string",
"title": "The Instructionid Schema",
"default": "",
"examples": [
"6949BE56D78C4E7A9E2CC2689E06C845"
]
},
"instructionVersion": {
"$id": "/properties/assignedSteps/items/properties/instructionVersion",
"type": "string",
"title": "The Instructionversion Schema",
"default": "",
"examples": [
"2.0"
]
},
"instructionName": {
"$id": "/properties/assignedSteps/items/properties/instructionName",
"type": "string",
"title": "The Instructionname Schema",
"default": "",
"examples": [
"ErrorInstruction2"
]
},
"stepID": {
"$id": "/properties/assignedSteps/items/properties/stepID",
"type": "string",
"title": "The Stepid Schema",
"default": "",
"examples": [
"E3854835B408482A8F6C67F66AA2844E"
]
},
"stepName": {
"$id": "/properties/assignedSteps/items/properties/stepName",
"type": "string",
"title": "The Stepname Schema",
"default": "",
"examples": [
"Remove the tyrre"
]
}
}
}
},
"assignedEquipments": {
"$id": "/properties/assignedEquipments",
"type": "array",
"items": {
"$id": "/properties/assignedEquipments/items",
"type": "object",
"properties": {
"equipmentID": {
"$id": "/properties/assignedEquipments/items/properties/equipmentID",
"type": "string",
"title": "The Equipmentid Schema",
"default": "",
"examples": [
"516965F65D634FB48B6B8DF38FB99641"
]
},
"equipmentName": {
"$id": "/properties/assignedEquipments/items/properties/equipmentName",
"type": "string",
"title": "The Equipmentname Schema",
"default": "",
"examples": [
"Equipment Testing 10034"
]
},
"equipmentVersion": {
"$id": "/properties/assignedEquipments/items/properties/equipmentVersion",
"type": "string",
"title": "The Equipmentversion Schema",
"default": "",
"examples": [
"7.0"
]
},
"status": {
"$id": "/properties/assignedEquipments/items/properties/status",
"type": "string",
"title": "The Status Schema",
"default": "",
"examples": [
"3"
]
},
"modelID": {
"$id": "/properties/assignedEquipments/items/properties/modelID",
"type": "string",
"title": "The Modelid Schema",
"default": "",
"examples": [
"F75791D9BD2347AAABE2909098762553"
]
},
"modelStatus": {
"$id": "/properties/assignedEquipments/items/properties/modelStatus",
"type": "string",
"title": "The Modelstatus Schema",
"default": "",
"examples": [
"2"
]
}
}
}
},
"assignedFunctionalLocations": {
"$id": "/properties/assignedFunctionalLocations",
"type": "array",
"items": {
"$id": "/properties/assignedFunctionalLocations/items",
"type": "object",
"properties": {
"functionalLocationID": {
"$id": "/properties/assignedFunctionalLocations/items/properties/functionalLocationID",
"type": "string",
"title": "The Functionallocationid Schema",
"default": "",
"examples": [
"DCEC66FF53B1473AB00977786D820435"
]
},
"hasInrevision": {
"$id": "/properties/assignedFunctionalLocations/items/properties/hasInrevision",
"type": "null",
"title": "The Hasinrevision Schema",
"default": null,
"examples": [
null
]
},
"functionalLocationVersion": {
"$id": "/properties/assignedFunctionalLocations/items/properties/functionalLocationVersion",
"type": "integer",
"title": "The Functionallocationversion Schema",
"default": 0,
"examples": [
1
]
},
"completeness": {
"$id": "/properties/assignedFunctionalLocations/items/properties/completeness",
"type": "null",
"title": "The Completeness Schema",
"default": null,
"examples": [
null
]
},
"sectionCompleteness": {
"$id": "/properties/assignedFunctionalLocations/items/properties/sectionCompleteness",
"type": "null",
"title": "The Sectioncompleteness Schema",
"default": null,
"examples": [
null
]
},
"imageUrl": {
"$id": "/properties/assignedFunctionalLocations/items/properties/imageUrl",
"type": "null",
"title": "The Imageurl Schema",
"default": null,
"examples": [
null
]
},
"status": {
"$id": "/properties/assignedFunctionalLocations/items/properties/status",
"type": "null",
"title": "The Status Schema",
"default": null,
"examples": [
null
]
},
"name": {
"$id": "/properties/assignedFunctionalLocations/items/properties/name",
"type": "string",
"title": "The Name Schema",
"default": "",
"examples": [
"Location Test"
]
},
"internalID": {
"$id": "/properties/assignedFunctionalLocations/items/properties/internalID",
"type": "null",
"title": "The Internalid Schema",
"default": null,
"examples": [
null
]
},
"templates": {
"$id": "/properties/assignedFunctionalLocations/items/properties/templates",
"type": "null",
"title": "The Templates Schema",
"default": null,
"examples": [
null
]
},
"criticalityCode": {
"$id": "/properties/assignedFunctionalLocations/items/properties/criticalityCode",
"type": "null",
"title": "The Criticalitycode Schema",
"default": null,
"examples": [
null
]
},
"safetyRiskCode": {
"$id": "/properties/assignedFunctionalLocations/items/properties/safetyRiskCode",
"type": "null",
"title": "The Safetyriskcode Schema",
"default": null,
"examples": [
null
]
},
"functionalLocationStatusCode": {
"$id": "/properties/assignedFunctionalLocations/items/properties/functionalLocationStatusCode",
"type": "string",
"title": "The Functionallocationstatuscode Schema",
"default": "",
"examples": [
"3"
]
},
"tagNumber": {
"$id": "/properties/assignedFunctionalLocations/items/properties/tagNumber",
"type": "null",
"title": "The Tagnumber Schema",
"default": null,
"examples": [
null
]
},
"source": {
"$id": "/properties/assignedFunctionalLocations/items/properties/source",
"type": "null",
"title": "The Source Schema",
"default": null,
"examples": [
null
]
},
"description": {
"$id": "/properties/assignedFunctionalLocations/items/properties/description",
"type": "null",
"title": "The Description Schema",
"default": null,
"examples": [
null
]
},
"isRoot": {
"$id": "/properties/assignedFunctionalLocations/items/properties/isRoot",
"type": "null",
"title": "The Isroot Schema",
"default": null,
"examples": [
null
]
},
"parentId": {
"$id": "/properties/assignedFunctionalLocations/items/properties/parentId",
"type": "null",
"title": "The Parentid Schema",
"default": null,
"examples": [
null
]
},
"publishedOn": {
"$id": "/properties/assignedFunctionalLocations/items/properties/publishedOn",
"type": "null",
"title": "The Publishedon Schema",
"default": null,
"examples": [
null
]
},
"adminData": {
"$id": "/properties/assignedFunctionalLocations/items/properties/adminData",
"type": "null",
"title": "The Admindata Schema",
"default": null,
"examples": [
null
]
},
"subclassId": {
"$id": "/properties/assignedFunctionalLocations/items/properties/subclassId",
"type": "null",
"title": "The Subclassid Schema",
"default": null,
"examples": [
null
]
},
"subclass": {
"$id": "/properties/assignedFunctionalLocations/items/properties/subclass",
"type": "null",
"title": "The Subclass Schema",
"default": null,
"examples": [
null
]
},
"classId": {
"$id": "/properties/assignedFunctionalLocations/items/properties/classId",
"type": "null",
"title": "The Classid Schema",
"default": null,
"examples": [
null
]
},
"class": {
"$id": "/properties/assignedFunctionalLocations/items/properties/class",
"type": "null",
"title": "The Class Schema",
"default": null,
"examples": [
null
]
}
}
}
},
"assignedSpareparts": {
"$id": "/properties/assignedSpareparts",
"type": "array",
"items": {
"$id": "/properties/assignedSpareparts/items",
"type": "object",
"properties": {
"sparepartID": {
"$id": "/properties/assignedSpareparts/items/properties/sparepartID",
"type": "string",
"title": "The Sparepartid Schema",
"default": "",
"examples": [
"38914B06544F4BE1BB2B5755C73D5B2C"
]
},
"sparepartName": {
"$id": "/properties/assignedSpareparts/items/properties/sparepartName",
"type": "string",
"title": "The Sparepartname Schema",
"default": "",
"examples": [
"SP4321"
]
}
}
}
},
"assignedSystems": {
"$id": "/properties/assignedSystems",
"type": "array",
"items": {
"$id": "/properties/assignedSystems/items",
"type": "object",
"properties": {
"systemID": {
"$id": "/properties/assignedSystems/items/properties/systemID",
"type": "string",
"title": "The Systemid Schema",
"default": "",
"examples": [
"F652D53AD8A2447780B11F71625AEE51"
]
},
"systemInternalId": {
"$id": "/properties/assignedSystems/items/properties/systemInternalId",
"type": "string",
"title": "The Systeminternalid Schema",
"default": "",
"examples": [
"cvbntyuighj"
]
},
"systemVersion": {
"$id": "/properties/assignedSystems/items/properties/systemVersion",
"type": "string",
"title": "The Systemversion Schema",
"default": "",
"examples": [
"2.0"
]
},
"status": {
"$id": "/properties/assignedSystems/items/properties/status",
"type": "string",
"title": "The Status Schema",
"default": "",
"examples": [
"3"
]
},
"modelStatus": {
"$id": "/properties/assignedSystems/items/properties/modelStatus",
"type": "string",
"title": "The Modelstatus Schema",
"default": "",
"examples": [
"2"
]
}
}
}
}
}
}Example:
{
"assignedModels": [{
"modelID": "ABC4E4CED0E64B189CDB28003FB59D8D",
"templateID": "92D08B5AF7C93031E10000000A78416B",
"modelName": "Model_V1",
"modelVersion": "1.0",
"modelClass": "AIN_TEST_1_tkNPadGdUn4wem",
"modelSubClass": "AIN_TEST_2_JsIytKeOPBvldR",
"status": "3"
}],
"assignedSteps": [{
"instructionID": "6949BE56D78C4E7A9E2CC2689E06C845",
"instructionVersion": "2.0",
"instructionName": "ErrorInstruction2",
"stepID": "E3854835B408482A8F6C67F66AA2844E",
"stepName": "Remove the tyrre"
}],
"assignedEquipments": [{
"equipmentID": "516965F65D634FB48B6B8DF38FB99641",
"equipmentName": "Equipment Testing 10034",
"equipmentVersion": "7.0",
"status": "3",
"modelID": "F75791D9BD2347AAABE2909098762553",
"modelStatus": "2"
}],
"assignedFunctionalLocations": [{
"functionalLocationID": "DCEC66FF53B1473AB00977786D820435",
"hasInrevision": null,
"functionalLocationVersion": 1,
"completeness": null,
"sectionCompleteness": null,
"imageUrl": null,
"status": null,
"name": "Location Test",
"internalID": null,
"templates": null,
"criticalityCode": null,
"safetyRiskCode": null,
"functionalLocationStatusCode": "3",
"tagNumber": null,
"source": null,
"description": null,
"isRoot": null,
"parentId": null,
"publishedOn": null,
"adminData": null,
"subclassId": null,
"subclass": null,
"classId": null,
"class": null
}],
"assignedSpareparts": [{
"sparepartID": "38914B06544F4BE1BB2B5755C73D5B2C",
"sparepartName": "SP4321"
}],
"assignedSystems": [{
"systemID": "F652D53AD8A2447780B11F71625AEE51",
"systemInternalId": "cvbntyuighj",
"systemVersion": "2.0",
"status": "3",
"modelStatus": "2"
}]
}HTTP status code 400
Bad request, document doesn't exists.
HTTP status code 403
User is not authorized to download the document.
HTTP status code 500
Internal Server Error.
/documents
get
This endpoint allows you to search for document based on filter query parameter.
get /documents
This endpoint allows you to search for document based on filter query parameter.
Secured by basic
REST API supports Basic Authentication
Query Parameters
- $filter: (string)
Retrieves documents based on the value provided. This parameter follows ODATA URL covention. For eg $filter=(substringof('CombustionEngine', name) eq true)
- $top: (string)
Top 'n' documents in the list. This parameter follows ODATA URL convention. You must use this query parameter with $skip, $top alone will not work. For eg $top=10.
- $skip: (string)
Number of documents to be skipped in the list. This parameter follows ODATA URL convention. You must use this query parameter with $top, $skip alone will not work. For eg $skip=20
- $orderby: (string)
Order the list of documents based on the fields. This parameter follows ODATA URL covention. For eg $orderby=internalId asc
HTTP status code 200
Search result based on query parameters
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"internalId": {
"type": "string"
},
"documentId": {
"type": "string"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"phaseCode": {
"type": "string"
},
"categoryCode": {
"type": "string"
},
"phaseCodeDescription": {
"type": "string"
},
"categoryCodeDescription": {
"type": "string"
},
"source": {
"type": "string"
},
"fileSize": {
"type": "string"
},
"mimeGroup": {
"type": "string"
},
"languageCode": {
"type": "string"
},
"languageDescription": {
"type": "string"
},
"associatedLanguage": {
"type": "string"
},
"canHotSpot": {
"type": "string"
},
"createdOn": {
"type": "string"
},
"changedOn": {
"type": "string"
}
}
}
}Example:
[
{
"internalId": "D.TEDX.6728",
"documentId": "2D2B9F3814414A0A9E544969A1674083",
"title": "AINDocument",
"description": "AINDocument",
"phaseCode": "2",
"categoryCode": "1",
"phaseCodeDescription": "Acquisition",
"categoryCodeDescription": "Identification",
"source": "SAP Operator 1",
"fileSize": "53 KB",
"mimeGroup": "Text Document",
"languageCode": "de",
"languageDescription": "German",
"associatedLanguage": "de",
"canHotSpot": "0",
"createdOn": "2017-01-31",
"changedOn": "2017-01-31"
}
]HTTP status code 400
The request could not be understood by the server due to malformed syntax.You SHOULD NOT repeat the request without modifications
Secured by basic
/document
get
This method get all the valid phase and category.
get /document/getPhaseCategory
This method get all the valid phase and category.
HTTP status code 200
gets valid phase and category mapping.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"phaseCode": [{
"Type": {
"type": "string",
"maxLength": 100
},
"Code": {
"type": "string",
"maxLength": 1
},
"LanguageISOCode": {
"type": "string",
"maxLength": 2
},
"Description": {
"type": "string"
}
}],
"categoryCode": [{
"Type": {
"type": "string",
"maxLength": 100
},
"Code": {
"type": "string",
"maxLength": 1
},
"LanguageISOCode": {
"type": "string",
"maxLength": 2
},
"Description": {
"type": "string"
}
}]
}
}
Example:
{
"phaseCode": [{
"type": "DocumentPhaseCode",
"code": "2",
"languageISOCode": "en",
"description": "Acquisition"
}, {
"type": "DocumentPhaseCode",
"code": "6",
"languageISOCode": "en",
"description": "Decommissioning"
}, {
"type": "DocumentPhaseCode",
"code": "1",
"languageISOCode": "en",
"description": "Design"
}, {
"type": "DocumentPhaseCode",
"code": "7",
"languageISOCode": "en",
"description": "Dismantle"
}, {
"type": "DocumentPhaseCode",
"code": "8",
"languageISOCode": "en",
"description": "Disposal"
}, {
"type": "DocumentPhaseCode",
"code": "3",
"languageISOCode": "en",
"description": "Installation"
}, {
"type": "DocumentPhaseCode",
"code": "5",
"languageISOCode": "en",
"description": "Maintenance"
}, {
"type": "DocumentPhaseCode",
"code": "4",
"languageISOCode": "en",
"description": "Operation"
}],
"categoryCode": [{
"type": "DocumentCategory",
"code": "4",
"languageISOCode": "en",
"description": "Bills of Materials"
}, {
"type": "DocumentCategory",
"code": "5",
"languageISOCode": "en",
"description": "Certificates"
}, {
"type": "DocumentCategory",
"code": "11",
"languageISOCode": "en",
"description": "Commercial Documents"
}, {
"type": "DocumentCategory",
"code": "10",
"languageISOCode": "en",
"description": "Corrective Maintenance / Repair"
}, {
"type": "DocumentCategory",
"code": "3",
"languageISOCode": "en",
"description": "Drawings / Schemes"
}, {
"type": "DocumentCategory",
"code": "1",
"languageISOCode": "en",
"description": "Identification"
}, {
"type": "DocumentCategory",
"code": "9",
"languageISOCode": "en",
"description": "Inspection / Preventive Maintenance / Testing / Calibration"
}, {
"type": "DocumentCategory",
"code": "6",
"languageISOCode": "en",
"description": "Installation / Dismantling"
}, {
"type": "DocumentCategory",
"code": "7",
"languageISOCode": "en",
"description": "Operation"
}, {
"type": "DocumentCategory",
"code": "12",
"languageISOCode": "en",
"description": "Others"
}, {
"type": "DocumentCategory",
"code": "8",
"languageISOCode": "en",
"description": "Safety"
}, {
"type": "DocumentCategory",
"code": "2",
"languageISOCode": "en",
"description": "Technical Specification"
}]
}HTTP status code 400
Bad request.
HTTP status code 500
Internal Server Error.
post
This endpoint allows you to upload document links by setting content-type to application/json in request header.
post /document/upload
This endpoint allows you to upload document links by setting content-type to application/json in request header.
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"categoryCode": {
"id": "/properties/categoryCode",
"type": "string"
},
"description": {
"id": "/properties/description",
"type": "string"
},
"link": {
"id": "/properties/link",
"type": "string"
},
"phaseCode": {
"id": "/properties/phaseCode",
"type": "string"
},
"title": {
"id": "/properties/title",
"type": "string"
},
"languageCode": {
"id": "/properties/languageCode",
"type": "string"
}
},
"type": "object"
}Example:
{
"link": "https://facebook.com",
"title": "Facebook",
"phaseCode": "2/3/4",
"categoryCode": "1",
"description": "A wedsite to connect to friends",
"languageCode": "en"
}HTTP status code 200
The document was uploaded.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"categoryCode": {
"id": "/properties/categoryCode",
"type": "string"
},
"categoryCodeDesc": {
"id": "/properties/categoryCodeDesc",
"type": "string"
},
"client": {
"id": "/properties/client",
"type": "null"
},
"description": {
"id": "/properties/description",
"type": "string"
},
"extension": {
"id": "/properties/extension",
"type": "string"
},
"externalDocumentlink": {
"id": "/properties/externalDocumentlink",
"type": "string"
},
"fileSize": {
"id": "/properties/fileSize",
"type": "integer"
},
"fileSizeUnit": {
"id": "/properties/fileSizeUnit",
"type": "null"
},
"hashKey": {
"id": "/properties/hashKey",
"type": "null"
},
"id": {
"id": "/properties/id",
"type": "string"
},
"internalID": {
"id": "/properties/internalID",
"type": "string"
},
"isMarkedForDeletion": {
"id": "/properties/isMarkedForDeletion",
"type": "string"
},
"languageCode": {
"id": "/properties/languageCode",
"type": "string"
},
"languageCodeDescription": {
"id": "/properties/languageCodeDescription",
"type": "string"
},
"mimeType": {
"id": "/properties/mimeType",
"type": "string"
},
"phaseCode": {
"id": "/properties/phaseCode",
"type": "string"
},
"phaseCodeDesc": {
"id": "/properties/phaseCodeDesc",
"type": "string"
},
"repositoryDocumentID": {
"id": "/properties/repositoryDocumentID",
"type": "null"
},
"resolution": {
"id": "/properties/resolution",
"type": "null"
},
"source": {
"id": "/properties/source",
"type": "string"
},
"tenantID": {
"id": "/properties/tenantID",
"type": "null"
},
"title": {
"id": "/properties/title",
"type": "string"
},
"url": {
"id": "/properties/url",
"type": "null"
},
"confidentiality": {
"id": "/properties/confidentiality",
"type": "null"
}
},
"type": "object"
}Example:
{
"client": null,
"internalID": "DOC.TEDX.3900",
"id": "29A7354F8CA844C58C898DCE1BF59421",
"tenantID": null,
"phaseCode": "3/2/4",
"categoryCode": "6",
"phaseCodeDesc": "Maintenance",
"categoryCodeDesc": "Inspection / Preventive Maintenance / Testing / Calibration",
"isMarkedForDeletion": "0",
"url": null,
"extension": "ELINK",
"resolution": null,
"languageCode": "en",
"languageCodeDescription": "English",
"repositoryDocumentID": null,
"description": "connecting frnds",
"title": "facebook",
"hashKey": null,
"mimeType": "ELINK",
"fileSize": 0.0,
"fileSizeUnit": null,
"externalDocumentlink": "https://facebook.com",
"source": "Operator"
}HTTP status code 400
Bad request, Some error while uploading the file.
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
post
This endpoint allows you to upload document links in other languages against a main document link, by setting content-type to application/json in request header.
post /document/upload/otherlang
This endpoint allows you to upload document links in other languages against a main document link, by setting content-type to application/json in request header.
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"description": {
"id": "/properties/description",
"type": "string"
},
"documentId": {
"id": "/properties/documentId",
"type": "string"
},
"languageCode": {
"id": "/properties/languageCode",
"type": "string"
},
"link": {
"id": "/properties/link",
"type": "string"
},
"title": {
"id": "/properties/title",
"type": "string"
}
},
"type": "object"
}Example:
{
"documentId": "E83643A4707B489BB9B8D08FB619207C",
"link": "http://abcd.com",
"title": "abcd",
"languageCode": "fr",
"description": ""
}HTTP status code 200
The document was uploaded.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"categoryCode": {
"id": "/properties/categoryCode",
"type": "string"
},
"categoryCodeDesc": {
"id": "/properties/categoryCodeDesc",
"type": "string"
},
"client": {
"id": "/properties/client",
"type": "null"
},
"description": {
"id": "/properties/description",
"type": "string"
},
"extension": {
"id": "/properties/extension",
"type": "string"
},
"externalDocumentlink": {
"id": "/properties/externalDocumentlink",
"type": "string"
},
"fileSize": {
"id": "/properties/fileSize",
"type": "integer"
},
"fileSizeUnit": {
"id": "/properties/fileSizeUnit",
"type": "null"
},
"hashKey": {
"id": "/properties/hashKey",
"type": "null"
},
"id": {
"id": "/properties/id",
"type": "string"
},
"internalID": {
"id": "/properties/internalID",
"type": "string"
},
"isMarkedForDeletion": {
"id": "/properties/isMarkedForDeletion",
"type": "string"
},
"languageCode": {
"id": "/properties/languageCode",
"type": "string"
},
"languageCodeDescription": {
"id": "/properties/languageCodeDescription",
"type": "string"
},
"mimeType": {
"id": "/properties/mimeType",
"type": "string"
},
"phaseCode": {
"id": "/properties/phaseCode",
"type": "string"
},
"phaseCodeDesc": {
"id": "/properties/phaseCodeDesc",
"type": "string"
},
"repositoryDocumentID": {
"id": "/properties/repositoryDocumentID",
"type": "null"
},
"resolution": {
"id": "/properties/resolution",
"type": "null"
},
"source": {
"id": "/properties/source",
"type": "string"
},
"tenantID": {
"id": "/properties/tenantID",
"type": "null"
},
"title": {
"id": "/properties/title",
"type": "string"
},
"url": {
"id": "/properties/url",
"type": "null"
},
"confidentiality": {
"id": "/properties/confidentiality",
"type": "null"
}
},
"type": "object"
}Example:
{
"documentId": "07DAB28666F34A74A0F22BADBFC6196B",
"title": "gmail",
"mimeType": "ELINK",
"description": "gmail",
"languageCode": "ar"
}HTTP status code 400
Bad request, Some error while uploading the file.
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
put
This endpoint allows you to update phase code, category code and description properties associated with a document.
put /document/update
This endpoint allows you to update phase code, category code and description properties associated with a document.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"documentId": {
"type": "string",
"maxLength": 100
},
"phaseCode": {
"type": "string",
"maxLength": 10
},
"categoryCode": {
"type": "string",
"maxLength": 10
},
"description": {
"type": "string",
"maxLength": 5000
}
}
}Example:
[{
"documentId": "2986CA2368A34527BB760F7597936634",
"phaseCode": "8/2/4",
"categoryCode": "18"
}]
HTTP status code 200
Successfully updates the document.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"documentId": {
"type": "string",
"maxLength": 100
},
"phaseCode": {
"type": "string",
"maxLength": 10
},
"categoryCode": {
"type": "string",
"maxLength": 10
},
"description": {
"type": "string",
"maxLength": 5000
}
}
}Example:
[{
"documentId": "2986CA2368A34527BB760F7597936634",
"phaseCode": "8/2/4",
"categoryCode": "18"
}]
HTTP status code 400
Bad request, when document or equipment doesn't exists.
HTTP status code 403
User is not authorized to update the document.
HTTP status code 500
Internal Server Error, something unexpected happened.
put
This endpoint allows you to update language dependent documents document links by setting content-type to application/json in request header.
put /document/update/otherlang
This endpoint allows you to update language dependent documents document links by setting content-type to application/json in request header.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"description": {
"id": "/properties/description",
"type": "string"
},
"link": {
"id": "/properties/link",
"type": "string"
},
"title": {
"id": "/properties/title",
"type": "string"
}
},
"type": "object"
}
Example:
{
"description": "please change the link",
"title": "facebook",
"link": "https://facebook.com"
}HTTP status code 200
The document was uploaded.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"categoryCode": {
"id": "/properties/categoryCode",
"type": "string"
},
"categoryCodeDesc": {
"id": "/properties/categoryCodeDesc",
"type": "string"
},
"client": {
"id": "/properties/client",
"type": "null"
},
"description": {
"id": "/properties/description",
"type": "string"
},
"extension": {
"id": "/properties/extension",
"type": "string"
},
"externalDocumentlink": {
"id": "/properties/externalDocumentlink",
"type": "string"
},
"fileSize": {
"id": "/properties/fileSize",
"type": "integer"
},
"fileSizeUnit": {
"id": "/properties/fileSizeUnit",
"type": "null"
},
"hashKey": {
"id": "/properties/hashKey",
"type": "null"
},
"id": {
"id": "/properties/id",
"type": "string"
},
"internalID": {
"id": "/properties/internalID",
"type": "string"
},
"isMarkedForDeletion": {
"id": "/properties/isMarkedForDeletion",
"type": "string"
},
"languageCode": {
"id": "/properties/languageCode",
"type": "string"
},
"languageCodeDescription": {
"id": "/properties/languageCodeDescription",
"type": "string"
},
"mimeType": {
"id": "/properties/mimeType",
"type": "string"
},
"phaseCode": {
"id": "/properties/phaseCode",
"type": "string"
},
"phaseCodeDesc": {
"id": "/properties/phaseCodeDesc",
"type": "string"
},
"repositoryDocumentID": {
"id": "/properties/repositoryDocumentID",
"type": "null"
},
"resolution": {
"id": "/properties/resolution",
"type": "null"
},
"source": {
"id": "/properties/source",
"type": "string"
},
"tenantID": {
"id": "/properties/tenantID",
"type": "null"
},
"title": {
"id": "/properties/title",
"type": "string"
},
"url": {
"id": "/properties/url",
"type": "null"
},
"confidentiality": {
"id": "/properties/confidentiality",
"type": "null"
}
},
"type": "object"
}Example:
{
"canHotSpot": null,
"docId": "01923DF3820447848A2A9A00CDBC1BF6",
"name": "attachmentList.txt",
"type": "text/plain",
"size": "34630.0",
"fileSizeUnit": "1",
"description": "updateAttachment1"
}HTTP status code 400
Bad request, Some error while uploading the file.
HTTP status code 500
Internal Server Error, something unexpected happened.
delete
This endpoint is used to delete documents with all its language dependent link documents.
delete /document/delete
This endpoint is used to delete documents with all its language dependent link documents.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"ID": {
"id": "/properties/ID",
"type": "string"
},
"elink": {
"id": "/properties/elink",
"type": "boolean"
},
"lang": {
"id": "/properties/lang",
"items": {
"id": "/properties/lang/items",
"type": "string"
},
"type": "array"
}
},
"type": "object"
}Example:
[{
"ID": "CB9D8D11C64C453FBCBDF19C40B3A9AC",
"elink":true
},
{
"ID": "9C67F85CAFC34179B0C8B00C1F347B1A",
"elink":true
}]
delete
This endpoint is used to delete language related documents.
delete /document/delete/otherlang
This endpoint is used to delete language related documents.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"ID": {
"id": "/properties/ID",
"type": "string"
},
"elink": {
"id": "/properties/elink",
"type": "boolean"
},
"lang": {
"id": "/properties/lang",
"items": {
"id": "/properties/lang/items",
"type": "string"
},
"type": "array"
}
},
"type": "object"
}Example:
{
"ID": "7711F2FFCC76408CA15079D7577482E6",
"lang": ["en","hr","de"],
"elink":false
}
post
This method is used to assign model(s) to document(s).
post /document/assign/model
This method is used to assign model(s) to document(s).
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"documentIDMapping": {
"items": {
"additionalProperties": false,
"properties": {
"documentID": {
"type": "string",
"maxLength": 100
},
"assigneeID": {
"type": "string",
"maxLength": 32
},
"version": {
"type": "number"
}
}
}
}
}
}Example:
{
"documentIDMapping":[
{
"documentID":"Ou0hibM2xkZ1tTD6pvTsEYH2kinRsGMpeK_yHcfZ1F8",
"assigneeID":"DA725A38663748D78F2EDF6861DC80B9",
"version":"0.0"
}
]
}HTTP status code 204
No Content.
HTTP status code 400
Bad request, Some error while uploading the file.
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
post
This method is used to assign announcement(s) to document(s).
post /document/assign/announcement
This method is used to assign announcement(s) to document(s).
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"documentIDMapping": {
"items": {
"additionalProperties": false,
"properties": {
"documentID": {
"type": "string",
"maxLength": 100
},
"assigneeID": {
"type": "string",
"maxLength": 32
},
"version": {
"type": "number"
}
}
}
}
}
}Example:
{
"documentIDMapping":[
{
"documentID":"Ou0hibM2xkZ1tTD6pvTsEYH2kinRsGMpeK_yHcfZ1F8",
"assigneeID":"DA725A38663748D78F2EDF6861DC80B9",
"version":"0.0"
}
]
}HTTP status code 204
No Content.
HTTP status code 400
Bad request, Some error while uploading the file.
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
post
This method is used to assign step(s) to document(s).
post /document/assign/steps
This method is used to assign step(s) to document(s).
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"documentIDMapping": {
"items": {
"additionalProperties": false,
"properties": {
"documentID": {
"type": "string",
"maxLength": 100
},
"assigneeID": {
"type": "string",
"maxLength": 32
},
"version": {
"type": "number"
}
}
}
}
}
}Example:
{
"documentIDMapping":[
{
"documentID":"Ou0hibM2xkZ1tTD6pvTsEYH2kinRsGMpeK_yHcfZ1F8",
"assigneeID":"DA725A38663748D78F2EDF6861DC80B9",
"version":"0.0"
}
]
}HTTP status code 204
No Content.
HTTP status code 400
Bad request, Some error while uploading the file.
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
post
This method is used to assign equipment(s) to document(s).
post /document/assign/equipment
This method is used to assign equipment(s) to document(s).
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"documentIDMapping": {
"items": {
"additionalProperties": false,
"properties": {
"documentID": {
"type": "string",
"maxLength": 100
},
"assigneeID": {
"type": "string",
"maxLength": 32
},
"version": {
"type": "number"
}
}
}
}
}
}Example:
{
"documentIDMapping":[
{
"documentID":"Ou0hibM2xkZ1tTD6pvTsEYH2kinRsGMpeK_yHcfZ1F8",
"assigneeID":"DA725A38663748D78F2EDF6861DC80B9",
"version":"0.0"
}
]
}HTTP status code 204
No Content.
HTTP status code 400
Bad request, Some error while uploading the file.
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
post
This method is used to assign functional location(s) to document(s).
post /document/assign/functionallocation
This method is used to assign functional location(s) to document(s).
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"documentIDMapping": {
"items": {
"additionalProperties": false,
"properties": {
"documentID": {
"type": "string",
"maxLength": 100
},
"assigneeID": {
"type": "string",
"maxLength": 32
},
"version": {
"type": "number"
}
}
}
}
}
}Example:
{
"documentIDMapping":[
{
"documentID":"Ou0hibM2xkZ1tTD6pvTsEYH2kinRsGMpeK_yHcfZ1F8",
"assigneeID":"DA725A38663748D78F2EDF6861DC80B9",
"version":"0.0"
}
]
}HTTP status code 204
No Content.
HTTP status code 400
Bad request, Some error while uploading the file.
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
post
This method is used to assign Performace Improvement Case(s) to document(s).
post /document/assign/improvementcase
This method is used to assign Performace Improvement Case(s) to document(s).
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"documentIDMapping": {
"items": {
"additionalProperties": false,
"properties": {
"documentID": {
"type": "string",
"maxLength": 100
},
"assigneeID": {
"type": "string",
"maxLength": 32
},
"assigneeType": {
"type": "String",
"maxLength": 2
}
}
}
}
}
}Example:
{
"documentIDMapping":[
{
"documentID":"85109AD5453C45B0A3A302820FB6B85C",
"assigneeID":"067A405ED9ED423296DD010523D0DC99",
"assigneeType":"10"
},
{
"documentID":"85109AD5453C45B0A3A302820FB6B85C",
"assigneeID":"067A405ED9ED423296DD010523D0DC99",
"assigneeType":"11"
}
]
}HTTP status code 204
No Content.
HTTP status code 400
Bad request, Some error while uploading the file.
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
post
This method is used to assign Model(s) to document(s).
post /document/assign/modelrequest
This method is used to assign Model(s) to document(s).
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"documentIDMapping": {
"id": "/properties/documentIDMapping",
"items": {
"id": "/properties/documentIDMapping/items",
"properties": {
"assigneeID": {
"id": "/properties/documentIDMapping/items/properties/assigneeID",
"type": "string"
},
"documentID": {
"id": "/properties/documentIDMapping/items/properties/documentID",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}Example:
{
"documentIDMapping":[
{
"documentID":"85109AD5453C45B0A3A302820FB6B85C",
"assigneeID":"067A405ED9ED423296DD010523D0DC99"
}
]
}HTTP status code 204
No Content.
HTTP status code 400
Bad request, Some error while uploading the file.
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
post
This method is used to assign Spare Parts(s) to document(s).
post /document/assign/sparepart
This method is used to assign Spare Parts(s) to document(s).
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"documentIDMapping": {
"items": {
"additionalProperties": false,
"properties": {
"documentID": {
"type": "string",
"maxLength": 100
},
"assigneeID": {
"type": "string",
"maxLength": 32
},
"version": {
"type": "number"
}
}
}
}
}
}Example:
{
"documentIDMapping":[
{
"documentID":"Ou0hibM2xkZ1tTD6pvTsEYH2kinRsGMpeK_yHcfZ1F8",
"assigneeID":"DA725A38663748D78F2EDF6861DC80B9",
"version":"0.0"
}
]
}HTTP status code 204
No Content.
HTTP status code 400
Bad request, Some error while uploading the file.
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
post
This method is used to unassign model(s) to document(s).
post /document/unassign/model
This method is used to unassign model(s) to document(s).
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"documentIDMapping": {
"items": {
"additionalProperties": false,
"properties": {
"documentID": {
"type": "string",
"maxLength": 100
},
"assigneeID": {
"type": "string",
"maxLength": 32
},
"version": {
"type": "number"
}
}
}
}
}
}Example:
{
"documentIDMapping":[
{
"documentID":"Ou0hibM2xkZ1tTD6pvTsEYH2kinRsGMpeK_yHcfZ1F8",
"assigneeID":"DA725A38663748D78F2EDF6861DC80B9",
"version":"0.0"
}
]
}HTTP status code 204
No Content.
HTTP status code 400
Bad request, Some error while uploading the file.
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
post
This method is used to unassign announcement(s) to document(s).
post /document/unassign/announcement
This method is used to unassign announcement(s) to document(s).
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"documentIDMapping": {
"items": {
"additionalProperties": false,
"properties": {
"documentID": {
"type": "string",
"maxLength": 100
},
"assigneeID": {
"type": "string",
"maxLength": 32
},
"version": {
"type": "number"
}
}
}
}
}
}Example:
{
"documentIDMapping":[
{
"documentID":"Ou0hibM2xkZ1tTD6pvTsEYH2kinRsGMpeK_yHcfZ1F8",
"assigneeID":"DA725A38663748D78F2EDF6861DC80B9",
"version":"0.0"
}
]
}HTTP status code 204
No Content.
HTTP status code 400
Bad request, Some error while uploading the file.
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
post
This method is used to unassign step(s) to document(s).
post /document/unassign/steps
This method is used to unassign step(s) to document(s).
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"documentIDMapping": {
"items": {
"additionalProperties": false,
"properties": {
"documentID": {
"type": "string",
"maxLength": 100
},
"assigneeID": {
"type": "string",
"maxLength": 32
},
"version": {
"type": "number"
}
}
}
}
}
}Example:
{
"documentIDMapping":[
{
"documentID":"Ou0hibM2xkZ1tTD6pvTsEYH2kinRsGMpeK_yHcfZ1F8",
"assigneeID":"DA725A38663748D78F2EDF6861DC80B9",
"version":"0.0"
}
]
}HTTP status code 204
No Content.
HTTP status code 400
Bad request, Some error while uploading the file.
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
post
This method is used to unassign equipment(s) to document(s).
post /document/unassign/equipment
This method is used to unassign equipment(s) to document(s).
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"documentIDMapping": {
"items": {
"additionalProperties": false,
"properties": {
"documentID": {
"type": "string",
"maxLength": 100
},
"assigneeID": {
"type": "string",
"maxLength": 32
},
"version": {
"type": "number"
}
}
}
}
}
}Example:
{
"documentIDMapping":[
{
"documentID":"Ou0hibM2xkZ1tTD6pvTsEYH2kinRsGMpeK_yHcfZ1F8",
"assigneeID":"DA725A38663748D78F2EDF6861DC80B9",
"version":"0.0"
}
]
}HTTP status code 204
No Content.
HTTP status code 400
Bad request, Some error while uploading the file.
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
post
This method is used to unassign functional location(s) to document(s).
post /document/unassign/functionallocation
This method is used to unassign functional location(s) to document(s).
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"documentIDMapping": {
"items": {
"additionalProperties": false,
"properties": {
"documentID": {
"type": "string",
"maxLength": 100
},
"assigneeID": {
"type": "string",
"maxLength": 32
},
"version": {
"type": "number"
}
}
}
}
}
}Example:
{
"documentIDMapping":[
{
"documentID":"Ou0hibM2xkZ1tTD6pvTsEYH2kinRsGMpeK_yHcfZ1F8",
"assigneeID":"DA725A38663748D78F2EDF6861DC80B9",
"version":"0.0"
}
]
}HTTP status code 204
No Content.
HTTP status code 400
Bad request, Some error while uploading the file.
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
post
This method is used to unassign Performace Improvement Case(s) to document(s).
post /document/unassign/improvementcase
This method is used to unassign Performace Improvement Case(s) to document(s).
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"documentIDMapping": {
"items": {
"additionalProperties": false,
"properties": {
"documentID": {
"type": "string",
"maxLength": 100
},
"assigneeID": {
"type": "string",
"maxLength": 32
},
"assigneeType": {
"type": "String",
"maxLength": 2
}
}
}
}
}
}Example:
{
"documentIDMapping":[
{
"documentID":"85109AD5453C45B0A3A302820FB6B85C",
"assigneeID":"067A405ED9ED423296DD010523D0DC99",
"assigneeType":"10"
},
{
"documentID":"85109AD5453C45B0A3A302820FB6B85C",
"assigneeID":"067A405ED9ED423296DD010523D0DC99",
"assigneeType":"11"
}
]
}HTTP status code 204
No Content.
HTTP status code 400
Bad request, Some error while uploading the file.
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
post
This method is used to unassign SparePart(s) to document(s).
post /document/unassign/sparepart
This method is used to unassign SparePart(s) to document(s).
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"documentIDMapping": {
"items": {
"additionalProperties": false,
"properties": {
"documentID": {
"type": "string",
"maxLength": 100
},
"assigneeID": {
"type": "string",
"maxLength": 32
},
"version": {
"type": "number"
}
}
}
}
}
}Example:
{
"documentIDMapping":[
{
"documentID":"Ou0hibM2xkZ1tTD6pvTsEYH2kinRsGMpeK_yHcfZ1F8",
"assigneeID":"DA725A38663748D78F2EDF6861DC80B9",
"version":"0.0"
}
]
}HTTP status code 204
No Content.
HTTP status code 400
Bad request, Some error while uploading the file.
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
post
This method is used to unassign model request(s) to document(s).
post /document/unassign/modelrequest
This method is used to unassign model request(s) to document(s).
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"documentIDMapping": {
"id": "/properties/documentIDMapping",
"items": {
"id": "/properties/documentIDMapping/items",
"properties": {
"assigneeID": {
"id": "/properties/documentIDMapping/items/properties/assigneeID",
"type": "string"
},
"documentID": {
"id": "/properties/documentIDMapping/items/properties/documentID",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}Example:
{
"documentIDMapping":[
{
"documentID":"85109AD5453C45B0A3A302820FB6B85C",
"assigneeID":"067A405ED9ED423296DD010523D0DC99"
}
]
}HTTP status code 204
No Content.
HTTP status code 400
Bad request, Some error while uploading the file.
HTTP status code 500
Internal Server Error, something unexpected happened.