api-docs.json

{"swagger":"2.0","info":{"description":"This is the API for Blockchain Document Store. Please obtain a token from the onboarding service and enter it above after \"Bearer\" in order to use the service.","version":"local","title":"Blockchain Document Store API"},"host":"dev.pbsa-dev1.us-south.containers.mybluemix.net:443","basePath":"/docstore","tags":[{"name":"doc-store-controller","description":"Doc Store Controller"},{"name":"Health","description":"Blockchain Document Store service health"}],"paths":{"/health":{"get":{"tags":["Health"],"summary":"Check Service Health","description":"Check the health status of the Document Store service","operationId":"healthUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OverallStatus"}}}}},"/management/metrics":{"get":{"tags":["Health"],"summary":"Check Service Health Metrics","description":"Check the Prometheus Metrics of the Document Store service","operationId":"metricUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}}}}},"/v1/docstores/{channel_id}/documents":{"post":{"tags":["Upload"],"summary":"Upload Multiple Documents","description":"Upload documents or JSON content with the provided IDs and document types. This takes a multipart request where one part of the multipart request must be named types and contain a map of document ids to types.  For example: Content-Disposition: form-data; name=\"types\" {\"docId1\":\"drivers license\",\"docId2\":\"something else\",\"docId3\": \"json\"}.  The other parts of the multipart request must each have a name of the doc id (that matches with the map) and contain either a file or a JSON string. Swagger does not support a multipart request with an arbitrary number of fields so this method CANNOT be invoked via swagger.","operationId":"uploadDocumentsUsingPOST","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"documentTypes","in":"formData","description":"documentTypes","required":true,"type":"string"},{"name":"store_mode","in":"query","description":"store_mode","required":false,"type":"string","enum":["plain","hashed"]},{"name":"channel_id","in":"path","description":"channel_id","required":true,"type":"string"}],"responses":{"400":{"description":"Incorrect request format"},"202":{"description":"Successfully received request and processing underway","schema":{"$ref":"#/definitions/ObjectResponse«StatusPendingPayload»"}},"401":{"description":"Not authorized to upload documents"},"500":{"description":"Internal server error"}}}},"/v1/docstores/{channel_id}/documents/files":{"post":{"tags":["Download"],"summary":"Bulk download non-json documents","description":"Download non-json documents in bulk","operationId":"bulkDownloadNonJsonDocsUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"in":"body","name":"docIdsWithVersions","description":"docIdsWithVersions","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/DocIdVersionPair"}}},{"name":"channel_id","in":"path","description":"channel_id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}},"401":{"description":"Not authorized to access the documents"},"500":{"description":"Internal server error"},"403":{"description":"Accessing the document is forbidden"},"404":{"description":"Requested document not found"}}}},"/v1/docstores/{channel_id}/documents/files/consistency_verifications":{"post":{"tags":["Verification"],"summary":"Verify Document","description":"Verify a document in the blockchain has not been modified provided a document id and version.","operationId":"validateDocumentConsistencyUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"doc_id","in":"query","description":"doc_id","required":true,"type":"string"},{"name":"channel_id","in":"path","description":"channel_id","required":true,"type":"string"},{"name":"doc_version","in":"query","description":"doc_version","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ObjectResponse«ValidationPayload»"}},"400":{"description":"Incorrect request format"},"401":{"description":"Not authorized to access the document"},"403":{"description":"Accessing the document is forbidden"},"404":{"description":"Document not found"}}}},"/v1/docstores/{channel_id}/documents/files/id_verifications":{"post":{"tags":["Verification"],"summary":"Verify Document with ID","description":"Verify the document on blockchain for the provided Document ID, Document Version with the uploaded file.","operationId":"validateDocumentUsingPOST","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"doc_id","in":"query","description":"doc_id","required":true,"type":"string"},{"name":"doc_version","in":"query","description":"doc_version","required":true,"type":"integer","format":"int32"},{"name":"channel_id","in":"path","description":"Document to validate","required":true,"type":"string"},{"name":"file","in":"formData","description":"file","required":true,"type":"file"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ObjectResponse«ValidationPayload»"}},"400":{"description":"Incorrect request format"},"401":{"description":"Not authorized to access the document"},"403":{"description":"Accessing the document is forbidden"}}}},"/v1/docstores/{channel_id}/documents/files/receipt_verifications":{"post":{"tags":["Verification"],"summary":"Verify file with receipt","description":"Verify a document in the blockchain provided a document and a digital receipt.","operationId":"validateDocumentUsingPOST_1","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"receipt","in":"formData","description":"Digital receipt","required":true,"type":"string"},{"name":"channel_id","in":"path","description":"channel_id","required":true,"type":"string"},{"name":"file","in":"formData","description":"Document to validate","required":true,"type":"file"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ObjectResponse«ValidationPayload»"}},"400":{"description":"Incorrect request format"},"401":{"description":"Not authorized to access the document"},"403":{"description":"Accessing the document is forbidden"}}}},"/v1/docstores/{channel_id}/documents/files/{doc_id}":{"post":{"tags":["Upload"],"summary":"Upload Document","description":"Upload a document with the provided ID.","operationId":"uploadDocumentWithIdUsingPOST","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"doc_id","in":"path","description":"Unique document ID","required":true,"type":"string"},{"name":"channel_id","in":"path","description":"channel_id","required":true,"type":"string"},{"name":"file","in":"formData","description":"Document to upload","required":true,"type":"file"},{"name":"document_type","in":"query","description":"Document type","required":true,"type":"string"}],"responses":{"400":{"description":"Incorrect request format"},"202":{"description":"Processing document upload.","schema":{"$ref":"#/definitions/ObjectResponse«StatusPendingPayload»"}},"401":{"description":"Not authorized to upload a document"},"500":{"description":"Internal server error"}}},"put":{"tags":["Upload"],"summary":"Upload new version of Document","description":"Upload and replace a document with the provided ID.","operationId":"replaceDocumentWithIDUsingPUT","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"doc_id","in":"path","description":"Unique document ID","required":true,"type":"string"},{"name":"channel_id","in":"path","description":"channel_id","required":true,"type":"string"},{"name":"file","in":"formData","description":"Document to upload","required":true,"type":"file"}],"responses":{"400":{"description":"Incorrect request format"},"202":{"description":"Processing document upload.","schema":{"$ref":"#/definitions/ObjectResponse«StatusPendingPayload»"}},"401":{"description":"Not authorized to upload a document"},"500":{"description":"Internal server error"}}}},"/v1/docstores/{channel_id}/documents/ids":{"get":{"tags":["Download"],"summary":"Get a list of document ids available","operationId":"getDocumentIDsUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"channel_id","in":"path","description":"status","required":true,"type":"string"},{"name":"status","in":"query","description":"status","required":true,"type":"string","enum":["success","initiated"]}],"responses":{"200":{"description":"Successfully fetched the list of IDs","schema":{"$ref":"#/definitions/ObjectResponse"}},"401":{"description":"Not authorized to access"}}}},"/v1/docstores/{channel_id}/documents/json":{"post":{"tags":["Download"],"summary":"Bulk download JSON documents","description":"Download json documents in bulk","operationId":"bulkDownloadJsonDocsUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"in":"body","name":"docIdsWithVersions","description":"docIdsWithVersions","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/DocIdVersionPair"}}},{"name":"channel_id","in":"path","description":"channel_id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ObjectResponse«List«Document»»"}},"401":{"description":"Not authorized to access the documents"},"500":{"description":"Internal server error"},"403":{"description":"Accessing the document is forbidden"},"404":{"description":"Requested document not found"}}}},"/v1/docstores/{channel_id}/documents/json/id_verifications":{"post":{"tags":["Verification"],"summary":"Verify JSON with ID","description":"Verify JSON on blockchain for the provided Document ID, Document Version, and JSON content.","operationId":"validateJSONWithIDUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"doc_id","in":"query","description":"doc_id","required":true,"type":"string"},{"name":"doc_version","in":"query","description":"doc_version","required":true,"type":"integer","format":"int32"},{"name":"channel_id","in":"path","description":"channel_id","required":true,"type":"string"},{"in":"body","name":"jsonContent","description":"jsonContent","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ObjectResponse«ValidationPayload»"}},"400":{"description":"Incorrect request format"},"401":{"description":"Not authorized to access the document"},"403":{"description":"Accessing the document is forbidden"}}}},"/v1/docstores/{channel_id}/documents/json/receipt_verifications":{"post":{"tags":["Verification"],"summary":"Verify JSON with Receipt","description":"Verify JSON on blockchain  for the provided Receipt and JSON content.","operationId":"validateJSONUsingPOST","consumes":["multipart/form-data"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"receipt","in":"formData","description":"receipt","required":true,"type":"string"},{"name":"channel_id","in":"path","description":"channel_id","required":true,"type":"string"},{"name":"jsonContent","in":"formData","description":"jsonContent","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ObjectResponse«ValidationPayload»"}},"400":{"description":"Incorrect request format"},"401":{"description":"Not authorized to access the document"},"500":{"description":"Internal server error"},"403":{"description":"Accessing the document is forbidden"}}}},"/v1/docstores/{channel_id}/documents/json/{doc_id}":{"post":{"tags":["Upload"],"summary":"Upload JSON","description":"Upload JSON with the provided ID.","operationId":"uploadJsonWithIdUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"doc_id","in":"path","description":"Unique document ID","required":true,"type":"string"},{"name":"channel_id","in":"path","description":"channel_id","required":true,"type":"string"},{"in":"body","name":"jsonContent","description":"JSON to upload","required":true,"schema":{"type":"string"}},{"name":"document_type","in":"query","description":"Document type","required":true,"type":"string"},{"name":"store_mode","in":"query","description":"store_mode","required":false,"type":"string","enum":["plain","hashed"]}],"responses":{"400":{"description":"Incorrect request format"},"202":{"description":"Successfully received request and processing underway","schema":{"$ref":"#/definitions/ObjectResponse«StatusPendingPayload»"}},"401":{"description":"Not authorized to upload JSON"}}},"put":{"tags":["Upload"],"summary":"Upload new version of JSON","description":"Upload and Replace JSON with the provided ID.","operationId":"replaceJsonWithIdUsingPUT","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"doc_id","in":"path","description":"Unique document ID","required":true,"type":"string"},{"name":"channel_id","in":"path","description":"channel_id","required":true,"type":"string"},{"in":"body","name":"jsonContent","description":"JSON to upload","required":true,"schema":{"type":"string"}},{"name":"store_mode","in":"query","description":"store_mode","required":false,"type":"string","enum":["plain","hashed"]}],"responses":{"400":{"description":"Incorrect request format"},"202":{"description":"Successfully received request and processing underway","schema":{"$ref":"#/definitions/ObjectResponse«StatusPendingPayload»"}},"401":{"description":"Not authorized to upload JSON"}}}},"/v1/docstores/{channel_id}/documents/search":{"post":{"tags":["Documents"],"summary":"Search the documents","description":"Search based on the doc type,time range and json doc content\n1. format of doc type : `[\"doc-type-1\",\"doc-type-2\"]`.Returns the doc of type `doc-type-1` OR `doc-type-2`\n2. format of startTime and endTime: `\"YYYY-MM-DD HH:SS TIMEZONE_ABBREVATION\"` Examples: `\"2017-12-11 EST\" , \"2017-12-11 21:00 EST\"`\n3. format of docContentAttributes: `{\"condition-1-key\":\"condition-1-value\",\"condition-2-key\":\"condition-2-value\"}`.Returns the docs that satisfies condition1 AND condition2`Examples: `{\"x.y\":\"z\",\"a\":\"b\"}` ","operationId":"searchUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"in":"body","name":"searchRequestCriteria","description":"searchRequestCriteria","required":true,"schema":{"$ref":"#/definitions/SearchRequestCriteria"}},{"name":"channel_id","in":"path","description":"channel_id","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully fetched the search results","schema":{"$ref":"#/definitions/ObjectResponse«List»"}},"400":{"description":"Wrong request format"},"401":{"description":"Not authorized to search"}}}},"/v1/docstores/{channel_id}/documents/shared_documents":{"post":{"tags":["Sharing"],"summary":"Generate Shared Document URL","description":"Generate a shared document URL with a fixed expiration date.","operationId":"generateSharedUrlUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"doc_id","in":"query","description":"Unique document ID","required":true,"type":"string"},{"name":"channel_id","in":"path","description":"channel_id","required":true,"type":"string"},{"name":"version","in":"query","description":"version","required":true,"type":"integer","format":"int32"},{"in":"body","name":"urlRequest","description":"URL Request Description","required":true,"schema":{"$ref":"#/definitions/SharedUrlRequest"}}],"responses":{"200":{"description":"Successfully generated shared document URL.","schema":{"$ref":"#/definitions/ObjectResponse«SharedUrlPayload»"}},"400":{"description":"Incorrect request format"},"401":{"description":"Not authorized to access the document"},"403":{"description":"Accessing the document is forbidden"}}}},"/v1/docstores/{channel_id}/documents/{doc_id}":{"get":{"tags":["Download"],"summary":"Download Document","description":"Download (and view) the  document with the provided ID. The response Content-Type will be the content type of the original uploaded file.","operationId":"downloadUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"doc_id","in":"path","description":"Unique document ID","required":true,"type":"string"},{"name":"channel_id","in":"path","description":"channel_id","required":true,"type":"string"},{"name":"version","in":"query","description":"version","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Successfully fetched document","schema":{"type":"object"}},"401":{"description":"Not authorized to access the document"},"500":{"description":"Internal server error"},"403":{"description":"Accessing the document is forbidden"},"404":{"description":"Requested document not found"}}}},"/v1/docstores/{channel_id}/documents/{doc_id}/access_log":{"get":{"tags":["Access Log"],"summary":"View Document Access Log","description":"Get the document access log, in JSON format, for the provided document ID.","operationId":"getAccessLogsUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"doc_id","in":"path","description":"Document id","required":true,"type":"string"},{"name":"channel_id","in":"path","description":"channel_id","required":true,"type":"string"},{"name":"scope","in":"query","description":"Scope - read/any/validation","required":true,"type":"string","enum":["read","validation","any"]},{"name":"last_only","in":"query","description":"last_only","required":false,"type":"boolean"}],"responses":{"200":{"description":"Successfully fetched access log","schema":{"$ref":"#/definitions/ObjectResponse«AccessLogPayload»"}},"400":{"description":"Wrong request format"},"401":{"description":"Not authorized to access the log"},"403":{"description":"Accessing the log is forbidden"}}}},"/v1/docstores/{channel_id}/documents/{doc_id}/presence":{"get":{"tags":["Verification"],"summary":"Is document present","description":"Check for the presence of a document.","operationId":"isDocPresentUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"doc_id","in":"path","description":"Unique document ID","required":true,"type":"string"},{"name":"channel_id","in":"path","description":"channel_id","required":true,"type":"string"},{"name":"version","in":"query","description":"version","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ObjectResponse«DocumentPayload»"}},"400":{"description":"Incorrect request format"},"401":{"description":"Not authorized to access the document"},"500":{"description":"Internal server error"},"403":{"description":"Accessing the document is forbidden"}}}},"/v1/docstores/{channel_id}/documents/{doc_id}/receipts":{"get":{"tags":["Sharing"],"summary":"Generate Receipt","description":"Generate a receipt for the provided Document ID and version.","operationId":"generateReceiptUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"doc_id","in":"path","description":"Unique document ID","required":true,"type":"string"},{"name":"channel_id","in":"path","description":"channel_id","required":true,"type":"string"},{"name":"version","in":"query","description":"version","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"Successfully generated receipt","schema":{"$ref":"#/definitions/ObjectResponse«ReceiptGeneratedPayload»"}},"401":{"description":"Not authorized to access the document"},"403":{"description":"Accessing the document is forbidden"}}}},"/v1/docstores/{channel_id}/documents/{doc_id}/states":{"get":{"tags":["States"],"summary":"Get Document State","description":"View the state history of the document, by scope. To view only the latest state, specify lastOnly.","operationId":"getDocumentStateUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"doc_id","in":"path","description":"Unique document ID","required":true,"type":"string"},{"name":"channel_id","in":"path","description":"channel_id","required":true,"type":"string"},{"name":"scope","in":"query","description":"Scope - user/system/any","required":true,"type":"string","enum":["user","system","any"]},{"name":"last_only","in":"query","description":"last_only","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ObjectResponse«DocumentStatePayload»"}},"400":{"description":"Incorrect request format"},"401":{"description":"Not authorized to access the document state"},"500":{"description":"Internal server error"},"403":{"description":"Accessing the document is forbidden"}}},"post":{"tags":["States"],"summary":"Add Document State","description":"Add a document state. A document version and state string are required.","operationId":"addDocumentStateUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"doc_id","in":"path","description":"Unique document ID","required":true,"type":"string"},{"name":"channel_id","in":"path","description":"channel_id","required":true,"type":"string"},{"name":"version","in":"query","description":"version","required":true,"type":"integer","format":"int32"},{"in":"body","name":"docStateRequest","description":"Object containing new state string","required":true,"schema":{"$ref":"#/definitions/DocumentStateRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ObjectResponse«StatusPendingPayload»"}},"400":{"description":"Wrong request format"},"401":{"description":"Not authorized to access the document"},"403":{"description":"Accessing the document is forbidden"},"409":{"description":"Document has an outstanding transaction in progress"}}}},"/v1/docstores/{channel_id}/documents/{doc_id}/version_count":{"get":{"tags":["Version"],"summary":"Get version count","description":"Count the number of versions for the provided Document ID.","operationId":"getVersionCountUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"doc_id","in":"path","description":"Unique document ID","required":true,"type":"string"},{"name":"channel_id","in":"path","description":"channel_id","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully fetched document version count","schema":{"$ref":"#/definitions/ObjectResponse«DocumentCountPayload»"}},"400":{"description":"Wrong request format"},"401":{"description":"Not authorized to access the document"},"500":{"description":"Internal server error"},"403":{"description":"Accessing the document is forbidden"}}}},"/v1/docstores/{channel_id}/receipts/validation":{"post":{"tags":["Verification"],"summary":"Validate Receipt","description":"Validate the Receipt on blockchain for the provided Receipt.","operationId":"validateReceiptUsingPOST","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"channel_id","in":"path","description":"Digital receipt","required":true,"type":"string"},{"in":"body","name":"receipt","description":"receipt","required":true,"schema":{"$ref":"#/definitions/ValidateReceiptRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ObjectResponse«ValidationPayload»"}},"400":{"description":"Incorrect request format"},"401":{"description":"Not authorized to access the document"},"404":{"description":"Requested document not found"}}}},"/v1/docstores/{channel_id}/shared_documents/{share_id}":{"get":{"tags":["Sharing"],"summary":"Download Shared Document","description":"Download a document with the provided share ID. This API can only be called with a share URL created by the share.document API. The response Content-Type will be the content type of the original uploaded file","operationId":"downloadSharedDocUsingGET","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"channel_id","in":"path","description":"Unique share ID","required":true,"type":"string"},{"name":"share_id","in":"path","description":"share_id","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully fetched document","schema":{"type":"object"}},"401":{"description":"Not authorized to access the document"},"403":{"description":"Accessing the document is forbidden"},"404":{"description":"Requested document not found"}}}},"/v1/docstores/{channel_id}/transactions":{"get":{"tags":["States","Upload"],"summary":"Get Document Transactions Status","description":"Get the status of document transactions. The input body of this request is an array of correlation IDs, each of which must be associated with an outstanding document transaction.  The response will be an array with an entry for each of the requested transactions, including an error if the correlation ID is not found. If any transactions are not found, they will have a status of 'not found'. ","operationId":"getTransactionStatusActualGetRequestUsingGET","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"x-user-token","in":"header","required":false,"type":"string"},{"name":"channel_id","in":"path","description":"List of Correlation IDs","required":true,"type":"string"},{"name":"correlation_ids","in":"query","description":"correlation_ids","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"Successfully received transaction status","schema":{"$ref":"#/definitions/ArrayResponse«TransactionStatus»"}},"401":{"description":"Not authorized to access the transaction"},"403":{"description":"Accessing the transaction is forbidden"}}}}},"securityDefinitions":{"Authorization":{"type":"apiKey","name":"Authorization","in":"header"}},"definitions":{"SearchRequestCriteria":{"type":"object","required":["docContentAttributes","docTypes","endTime","startTime"],"properties":{"docTypes":{"type":"array","items":{"type":"string"}},"startTime":{"type":"string"},"endTime":{"type":"string"},"docContentAttributes":{"$ref":"#/definitions/JsonNode"}}},"AccessLogPayload":{"type":"object","required":["accessLog","docID","status"],"properties":{"status":{"type":"string","example":"found","description":"the document status","enum":["found","not found"]},"docID":{"type":"string","example":"doc-id","description":"document ID"},"accessLog":{"type":"array","description":"an array of access records","items":{"$ref":"#/definitions/AccessRecord"}}}},"AccessRecord":{"type":"object","required":["docID","docVersion","isValidationAccess","transactionTime","transactionUser"],"properties":{"isValidationAccess":{"type":"boolean","example":true,"description":"whether this access was for validation purposes"},"docVersion":{"type":"integer","format":"int32","example":1,"description":"document version"},"docID":{"type":"string","example":"doc-id","description":"document ID"},"transactionTime":{"type":"string","example":"2017-10-10T13:28:17-04:00","description":"transaction time"},"transactionUser":{"type":"string","example":"mmoUser","description":"transaction user"}}},"ObjectResponse«List«Document»»":{"type":"object","required":["status"],"properties":{"status":{"type":"integer","format":"int32","example":200,"description":"integer representing HTTP status code"},"error":{"type":"string","example":"error","description":"string error message when the status is not 200"},"response":{"type":"array","description":"response payload","items":{"$ref":"#/definitions/Document"}}}},"ObjectResponse«DocumentCountPayload»":{"type":"object","required":["status"],"properties":{"status":{"type":"integer","format":"int32","example":200,"description":"integer representing HTTP status code"},"error":{"type":"string","example":"error","description":"string error message when the status is not 200"},"response":{"description":"response payload","$ref":"#/definitions/DocumentCountPayload"}}},"ObjectResponse«DocumentStatePayload»":{"type":"object","required":["status"],"properties":{"status":{"type":"integer","format":"int32","example":200,"description":"integer representing HTTP status code"},"error":{"type":"string","example":"error","description":"string error message when the status is not 200"},"response":{"description":"response payload","$ref":"#/definitions/DocumentStatePayload"}}},"TransactionStatus":{"type":"object","required":["correlationId","status"],"properties":{"docIDs":{"type":"array","example":"doc-id","description":"Identifier of the document","items":{"type":"string"}},"correlationId":{"type":"string","example":"correlationId","description":"Correlation ID to the transaction"},"objectStoreStatus":{"type":"string","example":"initiated","description":"Status of storing the document in the object store"},"objectStoreStatusMessage":{"type":"string","example":"The requested action is in progress.","description":"Status message related to storing the document in the object store"},"objectStoreStartTime":{"type":"integer","format":"int64","example":1507906443,"description":"The time the object store transaction started (epoch time in milliseconds)"},"objectStoreEndTime":{"type":"integer","format":"int64","example":1507906468,"description":"The time the object store transaction ended (epoch time in milliseconds)"},"blockchainStatus":{"type":"string","example":"initiated","description":"Status of confirming the transaction on the blockchain"},"blockchainStatusMessage":{"type":"string","example":"The requested action is in progress.","description":"Status message related to confirming the transaction on the blockchain"},"blockchainStartTime":{"type":"integer","format":"int64","example":1507906443,"description":"The time the blockchain transaction started (epoch time in milliseconds)"},"blockchainEndTime":{"type":"integer","format":"int64","example":1507906468,"description":"The time the blockchain transaction ended (epoch time in milliseconds)"},"status":{"type":"string","example":"found","description":"Status of the transaction","enum":["found","not found"]}}},"ObjectResponse«ReceiptGeneratedPayload»":{"type":"object","required":["status"],"properties":{"status":{"type":"integer","format":"int32","example":200,"description":"integer representing HTTP status code"},"error":{"type":"string","example":"error","description":"string error message when the status is not 200"},"response":{"description":"response payload","$ref":"#/definitions/ReceiptGeneratedPayload"}}},"JsonNode":{"type":"object"},"Document":{"type":"object","required":["docContentType","docID","docType","docVersion","transactionDocURL"],"properties":{"docContent":{"type":"string"},"docID":{"type":"string","example":"abc1234567","description":"Document ID"},"docIDHash":{"type":"string"},"storeMode":{"type":"string"},"transactionBlockchainUser":{"type":"string"},"docType":{"type":"string","example":"urn:example:document:pdf","description":"Document type, URN"},"docContentType":{"type":"string","example":"json","description":"Document content type"},"transactionDocURL":{"type":"string","example":"http://host.domain/document.ext","description":"URL enabling access to a document, include an expiration"},"docVersion":{"type":"integer","format":"int32","example":1,"description":"Document version"}}},"ObjectResponse«UsagePayload»":{"type":"object","required":["status"],"properties":{"status":{"type":"integer","format":"int32","example":200,"description":"integer representing HTTP status code"},"error":{"type":"string","example":"error","description":"string error message when the status is not 200"},"response":{"description":"response payload","$ref":"#/definitions/UsagePayload"}}},"ArrayResponse«TransactionStatus»":{"type":"object","required":["status"],"properties":{"status":{"type":"integer","format":"int32","example":200,"description":"integer representing HTTP status code"},"error":{"type":"string","example":"error","description":"string error message when the status is not 200"},"response":{"type":"array","description":"response payload","items":{"$ref":"#/definitions/TransactionStatus"}}}},"SharedUrlRequest":{"type":"object","required":["expiration","userIds"],"properties":{"userIds":{"type":"array","description":"Array of user IDs that should have access to a document","items":{"type":"string"}},"expiration":{"type":"string","example":"35d","description":"Time until expiration of the shared URL.  Can either be in hours (ends in h) or days (ends in d)"}}},"ValidateReceiptRequest":{"type":"object","required":["receipt"],"properties":{"receipt":{"type":"string","description":"Digital receipt of a document"}}},"ReceiptGeneratedPayload":{"type":"object","required":["receipt","status"],"properties":{"status":{"type":"string","example":"found","description":"the document status","enum":["found","not found"]},"receipt":{"type":"string","example":"receiptstring","description":"a JWT token that serves as a document receipt"}}},"DocIdVersionPair":{"type":"object","properties":{"docId":{"type":"string"},"docVersion":{"type":"integer","format":"int32"}}},"ObjectResponse":{"type":"object","required":["status"],"properties":{"status":{"type":"integer","format":"int32","example":200,"description":"integer representing HTTP status code"},"error":{"type":"string","example":"error","description":"string error message when the status is not 200"},"response":{"type":"object","description":"response payload"}}},"ObjectResponse«List»":{"type":"object","required":["status"],"properties":{"status":{"type":"integer","format":"int32","example":200,"description":"integer representing HTTP status code"},"error":{"type":"string","example":"error","description":"string error message when the status is not 200"},"response":{"type":"array","description":"response payload","items":{"type":"object"}}}},"ObjectResponse«ValidationPayload»":{"type":"object","required":["status"],"properties":{"status":{"type":"integer","format":"int32","example":200,"description":"integer representing HTTP status code"},"error":{"type":"string","example":"error","description":"string error message when the status is not 200"},"response":{"description":"response payload","$ref":"#/definitions/ValidationPayload"}}},"DocumentState":{"type":"object","required":["state","transactionID","transactionTime","transactionUser"],"properties":{"transactionUser":{"type":"string","example":"mmoUser","description":"the transaction user"},"transactionID":{"type":"string","example":"transaction-id","description":"the transaction ID"},"transactionTime":{"type":"string","example":"2017-10-10T13:28:17-04:00","description":"the transaction time"},"state":{"type":"string","example":"created","description":"the state"}}},"DocumentStatePayload":{"type":"object","required":["docID","states","status"],"properties":{"status":{"type":"string","example":"found","description":"the document status","enum":["found","not found"]},"docID":{"type":"string","example":"doc-id","description":"document ID"},"states":{"type":"array","description":"the document states","items":{"$ref":"#/definitions/DocumentState"}}}},"DocumentCountPayload":{"type":"object","properties":{"docID":{"type":"string"},"status":{"type":"string"},"versionCount":{"type":"integer","format":"int32"}}},"ObjectResponse«SharedUrlPayload»":{"type":"object","required":["status"],"properties":{"status":{"type":"integer","format":"int32","example":200,"description":"integer representing HTTP status code"},"error":{"type":"string","example":"error","description":"string error message when the status is not 200"},"response":{"description":"response payload","$ref":"#/definitions/SharedUrlPayload"}}},"DocumentStateRequest":{"type":"object","required":["state"],"properties":{"state":{"type":"string","example":"Document was verified","description":"String representing new state associated with a document"}}},"ObjectResponse«AccessLogPayload»":{"type":"object","required":["status"],"properties":{"status":{"type":"integer","format":"int32","example":200,"description":"integer representing HTTP status code"},"error":{"type":"string","example":"error","description":"string error message when the status is not 200"},"response":{"description":"response payload","$ref":"#/definitions/AccessLogPayload"}}},"ValidationPayload":{"type":"object","required":["docID","docVersion","status"],"properties":{"status":{"type":"string","example":"valid","description":"status of the document","enum":["valid","invalid","not found"]},"docID":{"type":"string","example":"a-doc-id","description":"document ID"},"docVersion":{"type":"string","example":"1","description":"document version"}}},"ObjectResponse«StatusPendingPayload»":{"type":"object","required":["status"],"properties":{"status":{"type":"integer","format":"int32","example":200,"description":"integer representing HTTP status code"},"error":{"type":"string","example":"error","description":"string error message when the status is not 200"},"response":{"description":"response payload","$ref":"#/definitions/StatusPendingPayload"}}},"StatusPendingPayload":{"type":"object","required":["correlationId"],"properties":{"correlationId":{"type":"string","example":"a-correlation-id","description":"correlation id that can be used to track the transaction status"}}},"SharedUrlPayload":{"type":"object","required":["status","url"],"properties":{"status":{"type":"string","example":"found","description":"the document status","enum":["found","not found"]},"url":{"type":"string","example":"https://...","description":"the sharable URL"}}},"UsagePayload":{"type":"object","properties":{"fileHashCount":{"type":"integer","format":"int64"},"hashCount":{"type":"integer","format":"int64"},"jsonHashCount":{"type":"integer","format":"int64"}}},"ComponentStatus":{"type":"object","properties":{"message":{"type":"string"},"success":{"type":"boolean"}}},"ObjectResponse«DocumentPayload»":{"type":"object","required":["status"],"properties":{"status":{"type":"integer","format":"int32","example":200,"description":"integer representing HTTP status code"},"error":{"type":"string","example":"error","description":"string error message when the status is not 200"},"response":{"description":"response payload","$ref":"#/definitions/DocumentPayload"}}},"DocumentPayload":{"type":"object","properties":{"docID":{"type":"string"},"docVersion":{"type":"integer","format":"int32"},"document":{"$ref":"#/definitions/Document"},"status":{"type":"string"}}},"OverallStatus":{"type":"object","properties":{"app":{"$ref":"#/definitions/ComponentStatus"},"dependencies":{"type":"object","additionalProperties":{"$ref":"#/definitions/ComponentStatus"}}}}}}