{ "x-generator": "NSwag v13.9.4.0 (NJsonSchema v10.3.1.0 (Newtonsoft.Json v12.0.0.0))", "openapi": "3.0.0", "info": { "title": "", "version": "1.0.0" }, "servers": [ { "url": "https://services.congamerge.com/api/v1/status" } ], "paths": { "/v1/Status/{id}": { "get": { "tags": [ "Status" ], "summary": "Get the status of the merge process", "description": "Checks the status of the current merge and returns 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. It is returned in the Merge API response.", "schema": { "type": "string", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusPersistanceRecord" } } } }, "204": { "description": "No Content" }, "400": { "description": "Invalid Data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "JWT": [] } ] } } }, "components": { "schemas": { "StatusPersistanceRecord": { "type": "object", "additionalProperties": false, "properties": { "correlationId": { "type": "string", "nullable": true }, "envelope": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/StatusPersistanceEnvelope" } }, "message": { "type": "string", "nullable": true }, "lastUpdateTimeStamp": { "type": "integer", "format": "int64" }, "createdDate": { "type": "integer", "format": "int64" } } }, "StatusPersistanceEnvelope": { "type": "object", "additionalProperties": false, "properties": { "version": { "type": "string", "nullable": true }, "correlationId": { "type": "string", "nullable": true }, "transactionId": { "type": "string", "nullable": true }, "topic": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Topic" } ] }, "request": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Request" } ] }, "status": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Status" } ] }, "lastUpdateTimeStamp": { "type": "integer", "format": "int64" }, "createdDate": { "type": "integer", "format": "int64" }, "messageId": { "type": "string", "nullable": true }, "expirationTime": { "type": "integer", "format": "int64" } } }, "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" } ] } } }, "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" } } }, "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 }, "extensions": { "type": "object", "nullable": true, "additionalProperties": {} } } } }, "securitySchemes": { "JWT": { "type": "http", "description": "Enter a bearer token as your authorization. In your requests, the headers will be set as the following <br><code>Authorization: Bearer YourTokenValue</code>", "scheme": "bearer", "bearerFormat": "JWT" } } }, "tags": [ { "name": "Status", "description": "Get the status of the merge process" } ], "security": [ { "JWT": [] } ] }