{ "openapi" : "3.0.0", "info" : { "title" : "Guidewire Connect Smart Communications", "version" : "1.6.0" }, "servers" : [ { "url" : "/api" } ], "security" : [ { "global" : [ "groups" ] } ], "tags" : [ { "name" : "digitalcomms" }, { "name" : "document/retry" }, { "name" : "/dps", "description" : "REST API for BC to request the production of documents" }, { "name" : "document" }, { "name" : "template" } ], "paths" : { "/digitalcomms/createDigitalComm" : { "post" : { "tags" : [ "digitalcomms" ], "summary" : "Create a new digital comm", "operationId" : "Rest_createDigitalComm", "requestBody" : { "description" : "", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DigitalCommsRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DigitalCommsResponse" } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "408" : { "description" : "Request Timeout", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } } } } }, "/document/retry/failureWrapperRetry" : { "post" : { "tags" : [ "document/retry" ], "summary" : "FailureWrapper retry endpoint with body as FailureWrapper", "operationId" : "failureWrapperRetry", "requestBody" : { "description" : "", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FailureWrapper" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FailureRetryResponse" } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "408" : { "description" : "Request Timeout", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } } } } }, "/document/retry/failureWrapperRetryFromId" : { "get" : { "tags" : [ "document/retry" ], "summary" : "Failure Wrapper Retry from Failure Identifier endpoint", "operationId" : "failureWrapperRetryFromId", "parameters" : [ { "name" : "FAILURE_IDENTIFIER", "in" : "header", "description" : "Required string header that should match the entire the S3 Object key", "required" : true, "schema" : { "type" : "string" } }, { "name" : "DONT_PURGE_OBJECT", "in" : "header", "description" : "Boolean header that when set to true will stop the purging of the S3 Object", "required" : false, "schema" : { "type" : "string", "enum" : [ "true", "false" ] } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FailureRetryResponse" } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "408" : { "description" : "Request Timeout", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } } } } }, "/dps/produce" : { "post" : { "tags" : [ "/dps" ], "summary" : "Request the production of a document based on an event", "operationId" : "produce", "requestBody" : { "description" : "", "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ProduceDocumentRequest" } } }, "required" : true }, "responses" : { "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "408" : { "description" : "Request Timeout", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } } } } }, "/document/createDocumentSynchronously" : { "post" : { "tags" : [ "document" ], "summary" : "Create a document synchronously.", "operationId" : "Rest_createDocumentSynchronously", "parameters" : [ { "name" : "environment", "in" : "header", "required" : false, "schema" : { "type" : "string" } }, { "name" : "ig-is-app-code", "in" : "header", "required" : true, "schema" : { "type" : "string", "enum" : [ "ContactManager", "BillingCenter", "ClaimCenter", "PolicyCenter" ] } } ], "requestBody" : { "description" : "", "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CreateDocumentRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDocumentResponse" } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "408" : { "description" : "Request Timeout", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } } } } }, "/document/createDocumentAsynchronously" : { "post" : { "tags" : [ "document" ], "summary" : "Create a document asynchronously.", "operationId" : "Rest_createDocumentAsynchronously", "parameters" : [ { "name" : "environment", "in" : "header", "required" : false, "schema" : { "type" : "string" } }, { "name" : "ig-is-app-code", "in" : "header", "required" : true, "schema" : { "type" : "string", "enum" : [ "ContactManager", "BillingCenter", "ClaimCenter", "PolicyCenter" ] } } ], "requestBody" : { "description" : "", "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CreateDocumentRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDocumentResponse" } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "408" : { "description" : "Request Timeout", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } } } } }, "/document/completeDraftDocument" : { "post" : { "tags" : [ "document" ], "summary" : "Complete a draft document.", "operationId" : "Rest_completeDraftDocument", "parameters" : [ { "name" : "environment", "in" : "header", "required" : false, "schema" : { "type" : "string" } }, { "name" : "ig-is-app-code", "in" : "header", "required" : true, "schema" : { "type" : "string", "enum" : [ "ContactManager", "BillingCenter", "ClaimCenter", "PolicyCenter" ] } } ], "requestBody" : { "description" : "", "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CompleteDraftDocumentRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDocumentResponse" } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "408" : { "description" : "Request Timeout", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } } } } }, "/document/createDraftDocument" : { "post" : { "tags" : [ "document" ], "summary" : "Create a draft document.", "operationId" : "Rest_createDraftDocument", "parameters" : [ { "name" : "environment", "in" : "header", "required" : false, "schema" : { "type" : "string" } }, { "name" : "ig-is-app-code", "in" : "header", "required" : true, "schema" : { "type" : "string", "enum" : [ "ContactManager", "BillingCenter", "ClaimCenter", "PolicyCenter" ] } } ], "requestBody" : { "description" : "", "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CreateDocumentRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDocumentResponse" } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "408" : { "description" : "Request Timeout", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } } } } }, "/document/getSampleData" : { "get" : { "tags" : [ "document" ], "summary" : "Request the xml form of a previously stored event", "operationId" : "Rest_getSampleData", "parameters" : [ { "name" : "environment", "in" : "header", "required" : false, "schema" : { "type" : "string" } }, { "name" : "ig-is-app-code", "in" : "header", "required" : true, "schema" : { "type" : "string", "enum" : [ "ContactManager", "BillingCenter", "ClaimCenter", "PolicyCenter" ] } }, { "name" : "gc-manual-event-identifier", "in" : "header", "description" : "The Identifier used to retrieve the Sample data", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SampleDataResponse" } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "408" : { "description" : "Request Timeout", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } } } } }, "/document/manualEventExists" : { "get" : { "tags" : [ "document" ], "summary" : "Return boolean string indicating whether the provided identifier is present.", "operationId" : "Rest_manualEventExists", "parameters" : [ { "name" : "environment", "in" : "header", "required" : false, "schema" : { "type" : "string" } }, { "name" : "ig-is-app-code", "in" : "header", "required" : true, "schema" : { "type" : "string", "enum" : [ "ContactManager", "BillingCenter", "ClaimCenter", "PolicyCenter" ] } }, { "name" : "gc-manual-event-identifier", "in" : "header", "description" : "The Identifier for the manual event", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "string" } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "408" : { "description" : "Request Timeout", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } } } } }, "/document/getManualEvent" : { "get" : { "tags" : [ "document" ], "summary" : "Return the manual event found with the provided identifier", "operationId" : "Rest_getManualEvent", "parameters" : [ { "name" : "environment", "in" : "header", "required" : false, "schema" : { "type" : "string" } }, { "name" : "ig-is-app-code", "in" : "header", "required" : true, "schema" : { "type" : "string", "enum" : [ "ContactManager", "BillingCenter", "ClaimCenter", "PolicyCenter" ] } }, { "name" : "gc-manual-event-identifier", "in" : "header", "description" : "The Identifier for the manual event", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "string" } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "408" : { "description" : "Request Timeout", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } } } } }, "/document/purgeManualEvent" : { "get" : { "tags" : [ "document" ], "summary" : "Purge the manual event found with the provided identifier", "operationId" : "Rest_purgeManualEvent", "parameters" : [ { "name" : "environment", "in" : "header", "required" : false, "schema" : { "type" : "string" } }, { "name" : "ig-is-app-code", "in" : "header", "required" : true, "schema" : { "type" : "string", "enum" : [ "ContactManager", "BillingCenter", "ClaimCenter", "PolicyCenter" ] } }, { "name" : "gc-manual-event-identifier", "in" : "header", "description" : "The Identifier for the manual event", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "string" } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "408" : { "description" : "Request Timeout", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } } } } }, "/template/getTemplate" : { "get" : { "tags" : [ "template" ], "summary" : "Retrieve a single template.", "operationId" : "Rest_getTemplate", "parameters" : [ { "name" : "environment", "in" : "header", "required" : false, "schema" : { "type" : "string" } }, { "name" : "ig-is-app-code", "in" : "header", "required" : true, "schema" : { "type" : "string", "enum" : [ "ContactManager", "BillingCenter", "ClaimCenter", "PolicyCenter" ] } }, { "name" : "gc-templateID", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DocumentTemplate" } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "408" : { "description" : "Request Timeout", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } } } } }, "/template/searchTemplates" : { "post" : { "tags" : [ "template" ], "summary" : "Search for templates matching provided criteria.", "operationId" : "Rest_searchTemplates", "parameters" : [ { "name" : "environment", "in" : "header", "required" : false, "schema" : { "type" : "string" } }, { "name" : "ig-is-app-code", "in" : "header", "required" : true, "schema" : { "type" : "string", "enum" : [ "ContactManager", "BillingCenter", "ClaimCenter", "PolicyCenter" ] } } ], "requestBody" : { "description" : "", "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/TemplateSearchCriteria" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DocumentTemplate" } } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "408" : { "description" : "Request Timeout", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } } } } }, "/template/getTemplateFolders" : { "post" : { "tags" : [ "template" ], "summary" : "Retrieves template folders.", "operationId" : "Rest_getTemplateFolders", "parameters" : [ { "name" : "environment", "in" : "header", "required" : false, "schema" : { "type" : "string" } }, { "name" : "ig-is-app-code", "in" : "header", "required" : true, "schema" : { "type" : "string", "enum" : [ "ContactManager", "BillingCenter", "ClaimCenter", "PolicyCenter" ] } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json; charset=UTF-8" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TemplateFolder" } } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "408" : { "description" : "Request Timeout", "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } } } } }, "/document/getProductionStatus" : { "get" : { "tags" : [ "document" ], "summary" : "Retrieve the production status of a single document", "operationId" : "Rest_getProductionStatus", "parameters" : [ { "name" : "environment", "in" : "header", "required" : false, "schema" : { "type" : "string" } }, { "name" : "ig-is-app-code", "in" : "header", "required" : true, "schema" : { "type" : "string", "enum" : [ "ContactManager", "BillingCenter", "ClaimCenter", "PolicyCenter" ] } }, { "name" : "gc-document-identifier", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DocumentProductionInfo" } } } }, "400" : { "description" : "Bad Request", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "401" : { "description" : "Unauthorized", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "404" : { "description" : "Not Found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "408" : { "description" : "Request Timeout", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } }, "500" : { "description" : "Internal Server Error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ResponseMessage" } } } } } } } }, "components" : { "schemas" : { "DocumentProductionInfo" : { "type" : "object", "properties" : { "identifier" : { "type" : "string" }, "suiteApplication" : { "type" : "string", "enum" : [ "ContactManager", "BillingCenter", "ClaimCenter", "PolicyCenter" ] }, "document" : { "$ref" : "#/components/schemas/Document" }, "creationDataExists" : { "type" : "boolean" }, "inputPayloadExists" : { "type" : "boolean" }, "contentsCreated" : { "type" : "boolean" }, "contentsAvailable" : { "type" : "boolean" }, "jobStatus" : { "type" : "string" } } }, "CreateDocumentRequest" : { "type" : "object", "properties" : { "document" : { "$ref" : "#/components/schemas/Document" }, "selectedEntities" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "CreateDocumentResponse" : { "type" : "object", "properties" : { "document" : { "$ref" : "#/components/schemas/Document" }, "responseIndicator" : { "type" : "string" } } }, "FailureRetryResponse" : { "type" : "object", "properties" : { "messageUUID" : { "type" : "string" }, "failureIdentifier" : { "type" : "string" }, "failureWrapperDeleted" : { "type" : "boolean" } } }, "SignatureRecipient" : { "type" : "object", "properties" : { "contact" : { "$ref" : "#/components/schemas/Contact" }, "recipientType" : { "type" : "string", "enum" : [ "AGENT", "CARBON_COPY", "CERTIFIED_DELIVERY", "EDITOR", "INTERMEDIARY", "SIGNER" ] }, "signatureOrder" : { "type" : "integer", "format" : "int32" }, "recipientSignatureStatus" : { "type" : "string", "enum" : [ "PENDING", "SIGNED", "DECLINED", "EXPIRED" ] }, "authenticationType" : { "type" : "string", "enum" : [ "ACCESS_CODE", "KBA", "PHONE", "SMS" ] }, "authenticationData" : { "type" : "string" }, "signatureTabList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SignatureTab" } }, "person" : { "$ref" : "#/components/schemas/Person" }, "company" : { "$ref" : "#/components/schemas/Company" } } }, "SampleDataResponse" : { "type" : "object", "properties" : { "xmlData" : { "type" : "string" } } }, "DigitalCommsResponse" : { "type" : "object", "properties" : { "jobId" : { "type" : "string" }, "queue" : { "type" : "string" }, "input" : { "type" : "string" }, "jobName" : { "type" : "string" }, "type" : { "type" : "string" }, "config" : { "type" : "integer", "format" : "int64" } } }, "ObjectNode" : { "type" : "object" }, "FailureWrapper" : { "type" : "object", "properties" : { "retryEndpointURI" : { "type" : "string" }, "base64EncodedBody" : { "type" : "string" }, "headers" : { "type" : "object", "additionalProperties" : { "type" : "object", "x-className" : { "format" : "java.lang.Object", "type" : "string" } } }, "messageUUID" : { "type" : "string" }, "errorMessage" : { "type" : "string" } } }, "DocumentTemplate" : { "type" : "object", "properties" : { "templateID" : { "type" : "string" }, "description" : { "type" : "string" }, "templateName" : { "type" : "string" }, "documentType" : { "type" : "string" }, "lob" : { "type" : "string" }, "jurisdiction" : { "type" : "string" }, "section" : { "type" : "string" }, "requiresApproval" : { "type" : "boolean" }, "additionalProperties" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "DigitalCommsRequest" : { "type" : "object", "properties" : { "suiteApplication" : { "type" : "string", "enum" : [ "ContactManager", "BillingCenter", "ClaimCenter", "PolicyCenter" ] }, "transactionType" : { "type" : "string" }, "s3Path" : { "type" : "string" }, "configId" : { "type" : "string" } } }, "DocumentRecipient" : { "type" : "object", "properties" : { "contact" : { "$ref" : "#/components/schemas/Contact" }, "deliveryChannel" : { "$ref" : "#/components/schemas/DeliveryChannel" }, "person" : { "$ref" : "#/components/schemas/Person" }, "company" : { "$ref" : "#/components/schemas/Company" } } }, "SignatureTab" : { "type" : "object", "properties" : { "tabType" : { "type" : "string", "enum" : [ "APPROVE", "CHECKBOX", "DATE_SIGNED", "EMAIL_ADDRESS", "FIRST_NAME", "FULL_NAME", "LAST_NAME", "SIGN_HERE", "TEXT" ] }, "anchorString" : { "type" : "string" }, "height" : { "type" : "integer", "format" : "int32" }, "width" : { "type" : "integer", "format" : "int32" }, "xOffset" : { "type" : "integer", "format" : "int32" }, "yOffset" : { "type" : "integer", "format" : "int32" } } }, "CompleteDraftDocumentRequest" : { "type" : "object", "properties" : { "document" : { "$ref" : "#/components/schemas/Document" }, "selectedEntities" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "primaryDocumentIdentifier" : { "type" : "string" } } }, "Contact" : { "type" : "object", "properties" : { "address" : { "$ref" : "#/components/schemas/Address" }, "emailAddress" : { "type" : "string" }, "phoneNumber" : { "type" : "string" }, "mobileNumber" : { "type" : "string" }, "faxNumber" : { "type" : "string" }, "taxId" : { "type" : "string" }, "roles" : { "type" : "array", "items" : { "type" : "string" } }, "channelPreferences" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DeliveryChannel" } }, "publicId" : { "type" : "string" } } }, "Address" : { "type" : "object", "properties" : { "addressLine1" : { "type" : "string" }, "addressLine2" : { "type" : "string" }, "addressLine3" : { "type" : "string" }, "city" : { "type" : "string" }, "county" : { "type" : "string" }, "state" : { "type" : "string" }, "postalCode" : { "type" : "string" }, "country" : { "type" : "string" } } }, "Person" : { "type" : "object", "properties" : { "address" : { "$ref" : "#/components/schemas/Address" }, "emailAddress" : { "type" : "string" }, "phoneNumber" : { "type" : "string" }, "mobileNumber" : { "type" : "string" }, "faxNumber" : { "type" : "string" }, "taxId" : { "type" : "string" }, "roles" : { "type" : "array", "items" : { "type" : "string" } }, "channelPreferences" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DeliveryChannel" } }, "publicId" : { "type" : "string" }, "prefix" : { "type" : "string" }, "firstName" : { "type" : "string" }, "middleName" : { "type" : "string" }, "lastName" : { "type" : "string" }, "suffix" : { "type" : "string" }, "dob" : { "type" : "string", "format" : "date" }, "gender" : { "type" : "string" }, "licenseNumber" : { "type" : "string" }, "licenseState" : { "type" : "string" } } }, "SignatureInformation" : { "type" : "object", "properties" : { "recipients" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SignatureRecipient" } }, "signatureEmailSubject" : { "type" : "string" }, "signatureStatus" : { "type" : "string", "enum" : [ "PENDING", "IN_PROGRESS", "DECLINED", "VOID", "SIGNED" ] }, "signatureIdentifier" : { "type" : "string" }, "additionalProperties" : { "$ref" : "#/components/schemas/ObjectNode" }, "errorStatus" : { "type" : "boolean" } } }, "Company" : { "type" : "object", "properties" : { "address" : { "$ref" : "#/components/schemas/Address" }, "emailAddress" : { "type" : "string" }, "phoneNumber" : { "type" : "string" }, "mobileNumber" : { "type" : "string" }, "faxNumber" : { "type" : "string" }, "taxId" : { "type" : "string" }, "roles" : { "type" : "array", "items" : { "type" : "string" } }, "channelPreferences" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DeliveryChannel" } }, "publicId" : { "type" : "string" }, "name" : { "type" : "string" } } }, "Document" : { "type" : "object", "properties" : { "documentIdentifier" : { "type" : "string" }, "publicID" : { "type" : "string" }, "docUID" : { "type" : "string" }, "templateID" : { "type" : "string" }, "creationDataIdentifier" : { "type" : "string" }, "suiteApplication" : { "type" : "string", "enum" : [ "ContactManager", "BillingCenter", "ClaimCenter", "PolicyCenter" ] }, "originatingSystem" : { "type" : "string", "enum" : [ "DMS", "DPS", "INSURANCE_SUITE", "DIGITAL", "ESIGNATURE", "OTHER" ] }, "creationType" : { "type" : "string", "enum" : [ "AUTOMATED", "INTERACTIVE", "ON_DEMAND" ] }, "accountNumber" : { "type" : "string" }, "accountPublicId" : { "type" : "string" }, "claimNumber" : { "type" : "string" }, "claimPublicId" : { "type" : "string" }, "jobNumber" : { "type" : "string" }, "jobPublicId" : { "type" : "string" }, "policyNumber" : { "type" : "string" }, "policyPublicId" : { "type" : "string" }, "producerCode" : { "type" : "string" }, "producerPublicId" : { "type" : "string" }, "contactName" : { "type" : "string" }, "contactPublicId" : { "type" : "string" }, "contingencyTitle" : { "type" : "string" }, "contingencyPublicId" : { "type" : "string" }, "exposureNumber" : { "type" : "string" }, "exposurePublicId" : { "type" : "string" }, "matterName" : { "type" : "string" }, "matterPublicId" : { "type" : "string" }, "serviceRequestNumber" : { "type" : "string" }, "serviceRequestPublicId" : { "type" : "string" }, "underwritingCompanyCode" : { "type" : "string" }, "author" : { "type" : "string" }, "description" : { "type" : "string" }, "language" : { "type" : "string" }, "mimeType" : { "type" : "string" }, "name" : { "type" : "string" }, "section" : { "type" : "string" }, "securityType" : { "type" : "string" }, "status" : { "type" : "string" }, "type" : { "type" : "string" }, "originalFileName" : { "type" : "string" }, "pendingDocUID" : { "type" : "string" }, "schemaVersion" : { "type" : "string" }, "primaryRecipient" : { "$ref" : "#/components/schemas/DocumentRecipient" }, "gwS3Key" : { "type" : "string" }, "signatureInformation" : { "$ref" : "#/components/schemas/SignatureInformation" }, "folderId" : { "type" : "string" }, "folderPath" : { "type" : "string" }, "additionalMetadataProperties" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "additionalProductionProperties" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "additionalManagementProperties" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "mediaType" : { "type" : "string", "writeOnly" : true }, "s3Uri" : { "type" : "string", "writeOnly" : true } } }, "TemplateFolder" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "folderId" : { "type" : "string" }, "path" : { "type" : "string" } } }, "ProduceDocumentRequest" : { "type" : "object", "properties" : { "accountJson" : { "type" : "string" }, "invoiceJson" : { "type" : "string" }, "policyJson" : { "type" : "string" }, "producerJson" : { "type" : "string" }, "additionalProperties" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "eventName" : { "type" : "string" }, "subject" : { "type" : "string" } } }, "TemplateSearchCriteria" : { "type" : "object", "properties" : { "lob" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "jurisdiction" : { "type" : "string" }, "section" : { "type" : "string" }, "type" : { "type" : "string" }, "additionalProperties" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "DeliveryChannel" : { "type" : "object", "properties" : { "channelName" : { "type" : "string" } } }, "ResponseMessage" : { "type" : "object", "properties" : { "timestamp" : { "type" : "integer", "format" : "int64" }, "endpoint" : { "type" : "string" }, "routeId" : { "type" : "string" }, "message" : { "type" : "string" }, "responseBody" : { "type" : "string" }, "responseCode" : { "type" : "integer", "format" : "int32" }, "responseKey" : { "type" : "string" } } } }, "securitySchemes" : { "global" : { "type" : "oauth2", "flows" : { "authorizationCode" : { "authorizationUrl" : "https://guidewire-hub.okta.com/oauth2/aus11vix3uKEpIfSI357/v1/authorize", "tokenUrl" : "https://guidewire-hub.okta.com/oauth2/aus11vix3uKEpIfSI357/v1/token", "scopes" : { "groups" : "Required scopes for Camel REST APIs" } } } } } } }