{ "x-generator": "NSwag v13.15.0.0 (NJsonSchema v10.6.2.0 (Newtonsoft.Json v13.0.0.0))", "openapi": "3.0.0", "info": { "title": "", "version": "1.0.0" }, "servers": [ { "url": "https://coreapps-rlsstg.congacloud.io/api/status" } ], "paths": { "/v1/Status/{id}": { "get": { "tags": [ "Status" ], "summary": "Get the status of the merge process", "description": "Gets the status of all completed and ongoing merge steps. For more information, see [Conga Composer API Use Cases.](https://documentation.conga.com/composer/latest/conga-composer-api-use-cases-203496246.html)", "operationId": "Status_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Correlation Id", "schema": { "type": "string", "nullable": true }, "x-position": 1 }, { "name": "showDetails", "in": "query", "description": "Determines whether or not to display the envelope details", "schema": { "type": "boolean", "default": false }, "x-position": 2 } ], "responses": { "400": { "description": "Invalid Data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" }, "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusPersistanceRecord" } } } }, "204": { "description": "No Content" } }, "security": [ { "JWT": [] } ] } } }, "components": { "schemas": { "ProblemDetails": { "type": "object", "additionalProperties": { "nullable": true }, "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } } }, "StatusPersistanceRecord": { "type": "object", "description": "Status persistence record", "additionalProperties": false, "properties": { "correlationId": { "type": "string", "description": "Correlation Id" }, "details": { "type": "array", "description": "Details", "nullable": true, "items": { "$ref": "#/components/schemas/ResponseEnvelope" } }, "message": { "type": "string", "description": "Message" }, "messageId": { "type": "string", "description": "MessageId" }, "lastUpdateTimeStamp": { "type": "integer", "description": "LastUpdateTimeStamp", "format": "int64" }, "expirationTime": { "type": "integer", "description": "ExpirationTime", "format": "int64" }, "createdDate": { "type": "string", "description": "LastUpdateTimeStamp", "format": "date-time" }, "errors": { "type": "array", "description": "Object to hold errors", "items": { "$ref": "#/components/schemas/ErrorDetail" } } } }, "ResponseEnvelope": { "type": "object", "description": "Envelope", "additionalProperties": false, "properties": { "version": { "type": "string", "description": "Status persistence envelope version", "nullable": true }, "correlationId": { "type": "string", "description": "ID correlating the event across services", "nullable": true }, "transactionId": { "type": "string", "description": "ID of the transaction", "nullable": true }, "topic": { "description": "Event Topic", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Topic" } ] }, "request": { "description": "Event Request", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Request" } ] }, "status": { "description": "Event Status", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Status" } ] }, "lastUpdateTimeStamp": { "type": "string", "description": "Last Update Date", "format": "date-time" }, "messageId": { "type": "string", "description": "Message id" }, "expirationTime": { "type": "string", "description": "Expiration time", "format": "date-time" }, "errorDetails": { "type": "array", "description": "List of Error Details", "nullable": true, "items": { "$ref": "#/components/schemas/ErrorDetail" } } } }, "Topic": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "audience": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Audience" } ] } } }, "Audience": { "type": "object", "additionalProperties": false, "properties": { "version": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "handler": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Handler" } ] } } }, "Handler": { "type": "object", "additionalProperties": false, "properties": { "key": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true } } }, "Request": { "type": "object", "additionalProperties": false, "properties": { "version": { "type": "string", "nullable": true }, "payload": { "type": "string", "nullable": true }, "package": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Package" } ] }, "packageUri": { "type": "string", "nullable": true } } }, "Package": { "type": "object", "additionalProperties": false, "properties": { "version": { "type": "string", "nullable": true }, "uri": { "type": "string", "nullable": true } } }, "Status": { "type": "object", "additionalProperties": false, "properties": { "version": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "startDateTime": { "type": "string", "nullable": true }, "endDateTime": { "type": "string", "nullable": true }, "statusCode": { "type": "integer", "format": "int32" } } }, "ErrorDetail": { "type": "object", "description": "ErrorDetail", "additionalProperties": false, "properties": { "category": { "type": "string", "description": "ErrorCategory" }, "message": { "type": "string", "description": "Message" } } } }, "securitySchemes": { "JWT": { "type": "apiKey", "description": "Provide oauth authentication", "name": "Authorization", "in": "header" } } }, "security": [ { "JWT": [] } ] }