{
"openapi": "3.0.1",
"info": {
"title": "MediaMarkup API",
"description": "API for managing approvals and users",
"version": "v2"
},
"paths": {
"/drafts": {
"post": {
"tags": [
"ApprovalDrafts"
],
"summary": "Create New Draft",
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApprovalDraft"
}
}
}
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/drafts/{id}": {
"get": {
"tags": [
"ApprovalDrafts"
],
"summary": "Get Draft By Id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApprovalDraft"
}
}
}
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
},
"delete": {
"tags": [
"ApprovalDrafts"
],
"summary": "DeleteAsync Draft By Id",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"202": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApprovalDraft"
}
}
}
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
},
"put": {
"tags": [
"ApprovalDrafts"
],
"summary": "UploadAsync new file to existing draft",
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"index"
],
"type": "object",
"properties": {
"index": {
"type": "integer",
"format": "int32"
},
"ContentType": {
"type": "string"
},
"ContentDisposition": {
"type": "string"
},
"Headers": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"Length": {
"type": "integer",
"format": "int64"
},
"Name": {
"type": "string"
},
"FileName": {
"type": "string"
}
}
},
"encoding": {
"index": {
"style": "form"
},
"ContentType": {
"style": "form"
},
"ContentDisposition": {
"style": "form"
},
"Headers": {
"style": "form"
},
"Length": {
"style": "form"
},
"Name": {
"style": "form"
},
"FileName": {
"style": "form"
}
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApprovalDraft"
}
}
}
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/drafts/batch/{id}": {
"put": {
"tags": [
"ApprovalDrafts"
],
"summary": "Uploads files to existing draft",
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"files"
],
"type": "object",
"properties": {
"files": {
"type": "array",
"items": {
"type": "string",
"format": "binary"
}
}
}
},
"encoding": {
"files": {
"style": "form"
}
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApprovalDraft"
}
}
}
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/drafts/{id}/files/{fileId}": {
"delete": {
"tags": [
"ApprovalDrafts"
],
"summary": "DeleteAsync File By Id From Draft",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "fileId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApprovalDraft"
}
}
}
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/drafts/{id}/publish": {
"post": {
"tags": [
"ApprovalDrafts"
],
"summary": "Publishes ApprovalDraft as Approval by combining all pages to PDF",
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateApprovalRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateApprovalRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateApprovalRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateApprovalRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Approval"
}
}
}
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/approvals/{id}/groups": {
"post": {
"tags": [
"ApprovalGroups"
],
"summary": "Creates New Approval Group",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Approval ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Payload",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateApprovalGroupRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateApprovalGroupRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateApprovalGroupRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateApprovalGroupRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApprovalGroup"
}
}
}
},
"201": {
"description": "Approval Version Details"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
},
"put": {
"tags": [
"ApprovalGroups"
],
"summary": "Updates Existing Approval Group",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Approval ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Payload",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateApprovalGroupRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateApprovalGroupRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateApprovalGroupRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateApprovalGroupRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApprovalGroup"
}
}
}
},
"202": {
"description": "Approval Version Details"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/approvals/{id}/groups/batch": {
"post": {
"tags": [
"ApprovalGroups"
],
"summary": "Creates New Approval Groups In Batch",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Approval ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Payload",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateApprovalGroupBatch"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateApprovalGroupBatch"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateApprovalGroupBatch"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateApprovalGroupBatch"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "Approval Details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Approval"
}
}
}
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/Approvals/SetApprovalGroupReadonly": {
"post": {
"tags": [
"ApprovalGroups"
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/ApprovalGroupSetReadOnlyParameters"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApprovalGroupSetReadOnlyParameters"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ApprovalGroupSetReadOnlyParameters"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/ApprovalGroupSetReadOnlyParameters"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApprovalGroup"
}
}
}
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"deprecated": true,
"security": [
{
"oauth2": [ ]
}
]
}
},
"/approvals/{id}/groups/{groupId}/decisions": {
"delete": {
"tags": [
"ApprovalGroups"
],
"summary": "Reset Decisions of All Users in a given Approval Group",
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "groupId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"202": {
"description": "Success"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/approvals/{id}/groups/{groupId}/users": {
"post": {
"tags": [
"ApprovalGroupUsers"
],
"summary": "Upserts Existing User to Approval Group",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Approval ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "groupId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Payload",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpsertApprovalGroupUserRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpsertApprovalGroupUserRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpsertApprovalGroupUserRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpsertApprovalGroupUserRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "Empty body"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/approvals/{id}/groups/{groupId}/users/{userId}": {
"delete": {
"tags": [
"ApprovalGroupUsers"
],
"summary": "Deletes an Existing User from an Approval Group",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Approval ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "groupId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"202": {
"description": "Empty body"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/approvals/{id}/groups/{groupId}/users/{userId}/decisions": {
"post": {
"tags": [
"ApprovalGroupUsers"
],
"summary": "Update Existing User Decision for an Approval Group",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Approval ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "groupId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Payload",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateUserDecisionRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateUserDecisionRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateUserDecisionRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateUserDecisionRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "Empty body"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
},
"delete": {
"tags": [
"ApprovalGroupUsers"
],
"summary": "Resets Existing User Decision for an Approval Group",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Approval ID",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "groupId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "userId",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "Success"
},
"202": {
"description": "Empty body"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/approvals": {
"get": {
"tags": [
"Approvals"
],
"summary": "Get Approvals",
"parameters": [
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "currentPage",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "total",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "searchTerm",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "ownerId",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "status",
"in": "query",
"schema": {
"$ref": "#/components/schemas/Status"
}
},
{
"name": "sortDirection",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortDirection"
}
},
{
"name": "sortBy",
"in": "query",
"schema": {
"$ref": "#/components/schemas/SortBy"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "Returns List of Approvals",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FilteredApprovalResult"
}
}
}
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
},
"post": {
"tags": [
"Approvals"
],
"summary": "Creates New Approval",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"Description",
"NumberOfDecisionsRequired",
"OwnerUserId"
],
"type": "object",
"properties": {
"ContentType": {
"type": "string"
},
"ContentDisposition": {
"type": "string"
},
"Headers": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"Length": {
"type": "integer",
"format": "int64"
},
"Name": {
"type": "string"
},
"FileName": {
"type": "string"
},
"OwnerUserId": {
"type": "string"
},
"Description": {
"type": "string"
},
"NumberOfDecisionsRequired": {
"type": "integer",
"format": "int32"
},
"Deadline": {
"type": "string",
"format": "date-time"
},
"AddOwnerToInitialApprovalGroup": {
"type": "boolean"
},
"Reviewers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApprovalReviewer"
}
}
}
},
"encoding": {
"ContentType": {
"style": "form"
},
"ContentDisposition": {
"style": "form"
},
"Headers": {
"style": "form"
},
"Length": {
"style": "form"
},
"Name": {
"style": "form"
},
"FileName": {
"style": "form"
},
"OwnerUserId": {
"style": "form"
},
"Description": {
"style": "form"
},
"NumberOfDecisionsRequired": {
"style": "form"
},
"Deadline": {
"style": "form"
},
"AddOwnerToInitialApprovalGroup": {
"style": "form"
},
"Reviewers": {
"style": "form"
}
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Approval"
}
}
}
},
"200": {
"description": "Approval Details"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/approvals/{id}": {
"get": {
"tags": [
"Approvals"
],
"summary": "Get Approval By ID",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Approval Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "Approval Details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Approval"
}
}
}
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
},
"put": {
"tags": [
"Approvals"
],
"summary": "Updates Existing Approval",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Approval Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateApprovalRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateApprovalRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateApprovalRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateApprovalRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"202": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Approval"
}
}
}
},
"200": {
"description": "Approval Details"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
},
"delete": {
"tags": [
"Approvals"
],
"summary": "Deletes Existing Approval",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Approval Id",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"202": {
"description": "Accepted"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/approvals/{id}/report": {
"get": {
"tags": [
"Approvals"
],
"summary": "Exports Image Report of a given Approval and Version of an Approval Group",
"parameters": [
{
"name": "id",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "groupId",
"in": "query",
"description": "",
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "query",
"description": "",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "Success"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/approvals/{id}/versions": {
"post": {
"tags": [
"ApprovalVersions"
],
"summary": "Creates New Approval Version",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"ContentType": {
"type": "string"
},
"ContentDisposition": {
"type": "string"
},
"Headers": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
},
"Length": {
"type": "integer",
"format": "int64"
},
"Name": {
"type": "string"
},
"FileName": {
"type": "string"
},
"TenantId": {
"type": "string"
},
"ApprovalId": {
"type": "string"
},
"FileNameAndExtension": {
"type": "string"
},
"File.CanRead": {
"type": "boolean"
},
"File.CanSeek": {
"type": "boolean"
},
"File.CanTimeout": {
"type": "boolean"
},
"File.CanWrite": {
"type": "boolean"
},
"File.Length": {
"type": "integer",
"format": "int64"
},
"File.Position": {
"type": "integer",
"format": "int64"
},
"File.ReadTimeout": {
"type": "integer",
"format": "int32"
},
"File.WriteTimeout": {
"type": "integer",
"format": "int32"
},
"CopyApprovalGroups": {
"type": "boolean"
},
"SendNotifications": {
"type": "boolean"
},
"LockPreviousVersion": {
"type": "boolean"
},
"InvitationMessage": {
"type": "string"
},
"ExistingUserIDs": {
"type": "array",
"items": {
"type": "string"
}
},
"Deadline": {
"type": "string",
"format": "date-time"
},
"AddOwnerToInitialApprovalGroup": {
"type": "boolean"
},
"NumberOfDecisionsRequired": {
"type": "integer",
"format": "int32"
}
}
},
"encoding": {
"ContentType": {
"style": "form"
},
"ContentDisposition": {
"style": "form"
},
"Headers": {
"style": "form"
},
"Length": {
"style": "form"
},
"Name": {
"style": "form"
},
"FileName": {
"style": "form"
},
"TenantId": {
"style": "form"
},
"ApprovalId": {
"style": "form"
},
"FileNameAndExtension": {
"style": "form"
},
"File.CanRead": {
"style": "form"
},
"File.CanSeek": {
"style": "form"
},
"File.CanTimeout": {
"style": "form"
},
"File.CanWrite": {
"style": "form"
},
"File.Length": {
"style": "form"
},
"File.Position": {
"style": "form"
},
"File.ReadTimeout": {
"style": "form"
},
"File.WriteTimeout": {
"style": "form"
},
"CopyApprovalGroups": {
"style": "form"
},
"SendNotifications": {
"style": "form"
},
"LockPreviousVersion": {
"style": "form"
},
"InvitationMessage": {
"style": "form"
},
"ExistingUserIDs": {
"style": "form"
},
"Deadline": {
"style": "form"
},
"AddOwnerToInitialApprovalGroup": {
"style": "form"
},
"NumberOfDecisionsRequired": {
"style": "form"
}
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateApprovalVersionResult"
}
}
}
},
"200": {
"description": "Approval Version Details"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
},
"put": {
"tags": [
"ApprovalVersions"
],
"summary": "Updates Approval Version",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateApprovalVersionRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateApprovalVersionRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateApprovalVersionRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateApprovalVersionRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"200": {
"description": "Approval Version Details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateApprovalVersionResult"
}
}
}
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/approvals/SetApprovalVersionLock": {
"post": {
"tags": [
"ApprovalVersions"
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateApprovalVersionRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateApprovalVersionRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateApprovalVersionRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateApprovalVersionRequest"
}
}
}
},
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"202": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateApprovalVersionResult"
}
}
}
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"deprecated": true,
"security": [
{
"oauth2": [ ]
}
]
}
},
"/approvals/{id}/versions/{version}": {
"delete": {
"tags": [
"ApprovalVersions"
],
"summary": "Deletes Existing Approval Version",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Approval Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "version",
"in": "path",
"description": "Approval Version Number",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"202": {
"description": ""
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/connect/token": {
"post": {
"tags": [
"Connect"
],
"summary": "Generates access token",
"requestBody": {
"description": "",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateTokenRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTokenRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateTokenRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateTokenRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTokenResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/purls": {
"post": {
"tags": [
"Purls"
],
"summary": "Create a Personal URL for given User",
"requestBody": {
"description": "MediaMarkup.Api.Identity.Contract.Response.CreatePurlResponse payload",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreatePurlRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePurlRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreatePurlRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreatePurlRequest"
}
}
}
},
"responses": {
"201": {
"description": "MediaMarkup.Api.Identity.Contract.Response.CreatePurlResponse URL for a short-lived token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePurlResponse"
}
}
}
},
"400": {
"description": "Error validating MediaMarkup.Api.Identity.Contract.Request.CreatePurlRequest payload"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/users": {
"post": {
"tags": [
"UserDetails"
],
"summary": "Creates New User",
"requestBody": {
"description": "MediaMarkup.Api.Identity.Contract.Request.CreateUserRequest payload",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/CreateUserRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateUserRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/CreateUserRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/CreateUserRequest"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponse"
}
}
}
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/users/{id}": {
"get": {
"tags": [
"UserDetails"
],
"summary": "Gets User by ID",
"parameters": [
{
"name": "id",
"in": "path",
"description": "User ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns MediaMarkup.Api.Identity.Contract.Response.UserResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponse"
}
}
}
},
"404": {
"description": "User is not found for given ID"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
},
"put": {
"tags": [
"UserDetails"
],
"summary": "Update User",
"parameters": [
{
"name": "id",
"in": "path",
"description": "User ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "MediaMarkup.Api.Identity.Contract.Request.UpdateUserRequest payload",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/UpdateUserRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateUserRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/UpdateUserRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/UpdateUserRequest"
}
}
}
},
"responses": {
"202": {
"description": "Success"
},
"204": {
"description": "No Content when update operation is succesful"
},
"400": {
"description": "Error updating user details or payload validation error(s)"
},
"404": {
"description": "User is not found for given ID"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
},
"delete": {
"tags": [
"UserDetails"
],
"summary": "Delete User",
"parameters": [
{
"name": "id",
"in": "path",
"description": "User ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"202": {
"description": "When delete operation is succesful"
},
"400": {
"description": "Error deleting user details or payload validation error(s)"
},
"404": {
"description": "User is not found for given ID"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/users/email/{email}": {
"get": {
"tags": [
"UserDetails"
],
"summary": "Gets User by Email",
"parameters": [
{
"name": "email",
"in": "path",
"description": "User Email",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns MediaMarkup.Api.Identity.Contract.Response.UserResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponse"
}
}
}
},
"404": {
"description": "User is not found for given Email"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/users/by_ids/{ids}": {
"get": {
"tags": [
"Users"
],
"summary": "Get Users By Ids",
"parameters": [
{
"name": "ids",
"in": "path",
"description": "Comma seperated list of user ids i.e. 3d7eb8db,3a64847,40ee2
",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns list of MediaMarkup.Api.Identity.Contract.Response.UserResponse",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResponse"
}
}
}
}
},
"429": {
"description": "Returns when list of ids are more than 50",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Users are not found for given IDs"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/users/by_emails/{emails}": {
"get": {
"tags": [
"Users"
],
"summary": "Get Users By Emails",
"parameters": [
{
"name": "emails",
"in": "path",
"description": "Comma seperated list of user emails i.e. userx@example.com,usery@example.com,userz@example.com
",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns list of MediaMarkup.Api.Identity.Contract.Response.UserResponse",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResponse"
}
}
}
}
},
"429": {
"description": "Returns when list of emails are more than 50",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Users are not found for given IDs"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/users/by_query/{query}": {
"get": {
"tags": [
"Users"
],
"summary": "Get Users By Search Query\r\nSearch is performed on Firstname, Lastname and Email",
"parameters": [
{
"name": "query",
"in": "path",
"description": "",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns list of MediaMarkup.Api.Identity.Contract.Response.UserResponse",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResponse"
}
}
}
}
},
"404": {
"description": "Users are not found for given IDs"
},
"429": {
"description": "Returns when list of emails are more than 50"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/users/by_roles/{roles}": {
"get": {
"tags": [
"Users"
],
"summary": "Get Users By Roles",
"parameters": [
{
"name": "roles",
"in": "path",
"description": "Comma seperated list of roles i.e. Admin,User,Guest
",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Returns list of MediaMarkup.Api.Identity.Contract.Response.UserResponse",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResponse"
}
}
}
}
},
"400": {
"description": "Returns when list of ids are more than 50",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"default": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"404": {
"description": "Users are not found for given IDs"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
},
"/users/invitations": {
"post": {
"tags": [
"Users"
],
"summary": "Invite User",
"requestBody": {
"description": "MediaMarkup.Api.Identity.Contract.Request.InviteUserRequest payload",
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/InviteUserRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/InviteUserRequest"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/InviteUserRequest"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/InviteUserRequest"
}
}
}
},
"responses": {
"201": {
"description": "When invitation send",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InviteUserResponse"
}
}
}
},
"400": {
"description": "Error validating MediaMarkup.Api.Identity.Contract.Request.CreateUserRequest payload"
},
"401": {
"description": "Bearer Token (JWT) is invalid"
},
"403": {
"description": "API doesn't have access to the resource"
},
"500": {
"description": "Infrastructure error"
}
},
"security": [
{
"oauth2": [ ]
}
]
}
}
},
"components": {
"schemas": {
"ProblemDetails": {
"type": "object",
"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
}
},
"additionalProperties": {
"type": "object",
"additionalProperties": false
}
},
"ApprovalDraftFileStatus": {
"enum": [
0,
1
],
"type": "integer",
"format": "int32"
},
"ApprovalDraftFile": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"url": {
"type": "string",
"nullable": true
},
"draftId": {
"type": "string",
"nullable": true
},
"tenantId": {
"type": "string",
"nullable": true
},
"index": {
"type": "number",
"format": "double"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/ApprovalDraftFileStatus"
}
]
},
"type": {
"type": "string",
"nullable": true,
"readOnly": true
},
"expirationTimeInSeconds": {
"type": "integer",
"format": "int32",
"nullable": true
}
},
"additionalProperties": false
},
"ApprovalDraftStatus": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"format": "int32"
},
"ApprovalDraft": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"tenantId": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true,
"readOnly": true
},
"pageCount": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"pages": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApprovalDraftFile"
}
},
"nullable": true
},
"expirationTimeInSeconds": {
"type": "integer",
"format": "int32",
"nullable": true
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/ApprovalDraftStatus"
}
]
},
"error": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ApprovalReviewer": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"nullable": true
},
"commentsEnabled": {
"type": "boolean"
},
"allowDecision": {
"type": "boolean"
},
"allowDownload": {
"type": "boolean"
}
},
"additionalProperties": false
},
"CreateApprovalRequest": {
"required": [
"description",
"numberOfDecisionsRequired",
"ownerUserId"
],
"type": "object",
"properties": {
"ownerUserId": {
"type": "string"
},
"description": {
"type": "string"
},
"numberOfDecisionsRequired": {
"type": "integer",
"format": "int32"
},
"deadline": {
"type": "string",
"format": "date-time",
"nullable": true
},
"addOwnerToInitialApprovalGroup": {
"type": "boolean",
"nullable": true
},
"reviewers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApprovalReviewer"
},
"nullable": true
}
},
"additionalProperties": false
},
"ApproverDecision": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"format": "int32"
},
"ApprovalUserInvitation": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ApprovalUserPermission": {
"type": "object",
"properties": {
"canComment": {
"type": "boolean"
},
"canDecide": {
"type": "boolean"
},
"canDownloadOriginalFile": {
"type": "boolean"
},
"canDownloadReport": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ApprovalUserNotification": {
"type": "object",
"properties": {
"statusUpdateNotificationEnabled": {
"type": "boolean"
},
"noteAndCommentUpdateNotificationEnabled": {
"type": "boolean"
},
"generalChatAndMessageUpdateNotificationEnabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"ApprovalUser": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"nullable": true
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"administrator": {
"type": "boolean"
},
"decision": {
"allOf": [
{
"$ref": "#/components/schemas/ApproverDecision"
}
]
},
"enabled": {
"type": "boolean"
},
"lastDecisionUpdatedDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"invitation": {
"allOf": [
{
"$ref": "#/components/schemas/ApprovalUserInvitation"
}
],
"nullable": true
},
"permission": {
"allOf": [
{
"$ref": "#/components/schemas/ApprovalUserPermission"
}
],
"nullable": true
},
"notification": {
"allOf": [
{
"$ref": "#/components/schemas/ApprovalUserNotification"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"ApprovalDecision": {
"enum": [
0,
1,
2,
3,
4
],
"type": "integer",
"format": "int32"
},
"ApprovalGroupStatus": {
"type": "object",
"properties": {
"groupId": {
"type": "string",
"nullable": true
},
"groupName": {
"type": "string",
"nullable": true
},
"decisionsRequired": {
"type": "integer",
"format": "int32"
},
"decisionMakers": {
"type": "integer",
"format": "int32"
},
"decisionsApproved": {
"type": "integer",
"format": "int32"
},
"decisionsNotAprroved": {
"type": "integer",
"format": "int32"
},
"approvalDecision": {
"allOf": [
{
"$ref": "#/components/schemas/ApprovalDecision"
}
]
},
"approvedByUserIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"noDecisionsByUserIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"notApprovedByUserIds": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
}
},
"additionalProperties": false
},
"ApprovalGroup": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"numberOfDecisionsRequired": {
"type": "integer",
"format": "int32"
},
"deadlineDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"brief": {
"type": "string",
"nullable": true
},
"invitationEmailSubject": {
"type": "string",
"nullable": true
},
"invitationEmailMessage": {
"type": "string",
"nullable": true
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApprovalUser"
},
"nullable": true
},
"approvalGroupStatusInfo": {
"allOf": [
{
"$ref": "#/components/schemas/ApprovalGroupStatus"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"ApprovalVersion": {
"type": "object",
"properties": {
"version": {
"type": "integer",
"format": "int32"
},
"filename": {
"type": "string",
"nullable": true
},
"width": {
"type": "number",
"format": "double"
},
"height": {
"type": "number",
"format": "double"
},
"dpi": {
"type": "integer",
"format": "int32"
},
"pageCount": {
"type": "integer",
"format": "int32"
},
"fileId": {
"type": "string",
"nullable": true
},
"fileUrl": {
"type": "string",
"nullable": true
},
"bytes": {
"type": "integer",
"format": "int64"
},
"processed": {
"type": "boolean"
},
"processingFailed": {
"type": "boolean"
},
"processingFailedReason": {
"type": "string",
"nullable": true
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"enabled": {
"type": "boolean"
},
"locked": {
"type": "boolean"
},
"approvalGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApprovalGroup"
},
"nullable": true
},
"duration": {
"type": "number",
"format": "double"
},
"quality": {
"type": "integer",
"format": "int32"
},
"createSize": {
"type": "integer",
"format": "int32"
},
"fileSize": {
"type": "string",
"nullable": true,
"readOnly": true
},
"updatedProperties": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": false
},
"nullable": true
},
"latestDeadlineDateFromApprovalGroups": {
"type": "string",
"format": "date-time",
"nullable": true,
"readOnly": true
}
},
"additionalProperties": false
},
"Approval": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"tenantId": {
"type": "string",
"nullable": true
},
"userId": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"lastUpdatedDate": {
"type": "string",
"format": "date-time"
},
"active": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"deleted": {
"type": "boolean"
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApprovalVersion"
},
"nullable": true
},
"lastVersion": {
"type": "integer",
"format": "int32"
},
"latestVersionFilename": {
"type": "string",
"nullable": true,
"readOnly": true
},
"latestVersionDeadlineDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"overallApprovalStatus": {
"allOf": [
{
"$ref": "#/components/schemas/ApprovalDecision"
}
]
},
"versionCount": {
"type": "integer",
"format": "int32"
},
"activeVersionCount": {
"type": "integer",
"format": "int32"
},
"latestVersion": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"searchString": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true,
"readOnly": true
},
"mostRecentVersion": {
"allOf": [
{
"$ref": "#/components/schemas/ApprovalVersion"
}
],
"nullable": true,
"readOnly": true
},
"activeVersions": {
"type": "string",
"nullable": true,
"readOnly": true
},
"mostRecentVersionUnits": {
"type": "string",
"nullable": true,
"readOnly": true
},
"mostRecentVersionFileDimensions": {
"type": "string",
"nullable": true,
"readOnly": true
},
"mostRecentVersionPageCount": {
"type": "string",
"nullable": true,
"readOnly": true
},
"thumbnailUrl": {
"type": "string",
"nullable": true
},
"processed": {
"type": "boolean"
},
"sendAdminStatusUpdateNotifications": {
"type": "boolean"
}
},
"additionalProperties": false
},
"CreateApprovalGroupRequest": {
"type": "object",
"properties": {
"approvalVersion": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"numberOfDecisionsRequired": {
"type": "integer",
"format": "int32"
},
"deadlineDate": {
"type": "string",
"format": "date-time",
"nullable": true
}
},
"additionalProperties": false
},
"UpdateApprovalGroupRequest": {
"type": "object",
"properties": {
"approvaGrouplId": {
"type": "string",
"nullable": true
},
"approvalVersion": {
"type": "integer",
"format": "int32"
},
"name": {
"type": "string",
"nullable": true
},
"numberOfDecisionsRequired": {
"type": "integer",
"format": "int32"
},
"deadlineDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"readonly": {
"type": "boolean"
}
},
"additionalProperties": false
},
"CreateApprovalGroupUserBatchItem": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"nullable": true
},
"administrator": {
"type": "boolean"
},
"commentsEnabled": {
"type": "boolean"
},
"allowDecision": {
"type": "boolean"
},
"allowDownload": {
"type": "boolean"
},
"allowReportDownload": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"CreateApprovalGroupBatchItem": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"numberOfDecisionsRequired": {
"type": "integer",
"format": "int32"
},
"deadlineDate": {
"type": "string",
"format": "date-time",
"nullable": true
},
"enabled": {
"type": "boolean"
},
"readonly": {
"type": "boolean"
},
"users": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateApprovalGroupUserBatchItem"
},
"nullable": true
}
},
"additionalProperties": false
},
"CreateApprovalGroupBatch": {
"required": [
"approvalGroups",
"approvalId",
"approvalVersion"
],
"type": "object",
"properties": {
"approvalId": {
"type": "string"
},
"approvalVersion": {
"type": "integer",
"format": "int32"
},
"approvalGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreateApprovalGroupBatchItem"
}
}
},
"additionalProperties": false
},
"ApprovalGroupSetReadOnlyParameters": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"version": {
"type": "integer",
"format": "int32"
},
"approvalGroupId": {
"type": "string",
"nullable": true
},
"readonly": {
"type": "boolean"
}
},
"additionalProperties": false
},
"UpsertApprovalGroupUserRequest": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"nullable": true
},
"approvalVersion": {
"type": "integer",
"format": "int32"
},
"approvalGroupId": {
"type": "string",
"nullable": true
},
"administrator": {
"type": "boolean"
},
"commentsEnabled": {
"type": "boolean"
},
"allowDecision": {
"type": "boolean"
},
"allowDownload": {
"type": "boolean"
},
"allowReportDownload": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"statusUpdateNotificationEnabled": {
"type": "boolean"
},
"noteAndCommentUpdateNotificationEnabled": {
"type": "boolean"
},
"generalChatAndMessageUpdateNotificationEnabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"UpdateUserDecisionRequest": {
"type": "object",
"properties": {
"version": {
"type": "integer",
"format": "int32"
},
"decision": {
"allOf": [
{
"$ref": "#/components/schemas/ApproverDecision"
}
]
},
"comment": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Status": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"format": "int32"
},
"SortDirection": {
"enum": [
0,
1
],
"type": "integer",
"format": "int32"
},
"SortBy": {
"enum": [
0,
1,
2,
3
],
"type": "integer",
"format": "int32"
},
"ApprovalFilter": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"format": "int32"
},
"currentPage": {
"type": "integer",
"format": "int32"
},
"totalPages": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"totalResult": {
"type": "integer",
"format": "int32"
},
"sortBy": {
"allOf": [
{
"$ref": "#/components/schemas/SortBy"
}
]
},
"sortDirection": {
"allOf": [
{
"$ref": "#/components/schemas/SortDirection"
}
]
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/Status"
}
]
},
"searchTerm": {
"type": "string",
"nullable": true
},
"ownerId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"FilteredApprovalResult": {
"type": "object",
"properties": {
"approvals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Approval"
},
"nullable": true
},
"filter": {
"allOf": [
{
"$ref": "#/components/schemas/ApprovalFilter"
}
],
"nullable": true
}
},
"additionalProperties": false
},
"UpdateApprovalRequest": {
"type": "object",
"properties": {
"ownerUserId": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"active": {
"type": "boolean"
}
},
"additionalProperties": false
},
"CreateApprovalVersionResult": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"version": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"UpdateApprovalVersionRequest": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"version": {
"type": "integer",
"format": "int32"
},
"locked": {
"type": "boolean"
}
},
"additionalProperties": false
},
"UpdateApprovalVersionResult": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"version": {
"type": "integer",
"format": "int32"
},
"locked": {
"type": "boolean"
}
},
"additionalProperties": false
},
"CreateTokenRequest": {
"required": [
"clientId",
"clientSecret"
],
"type": "object",
"properties": {
"clientId": {
"type": "string"
},
"clientSecret": {
"type": "string"
}
},
"additionalProperties": false
},
"CreateTokenResponse": {
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"nullable": true
},
"expiresIn": {
"type": "integer",
"format": "int32"
},
"tokenType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"CreatePurlRequest": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"nullable": true
},
"approvalId": {
"type": "string",
"nullable": true
},
"approvalGroupId": {
"type": "string",
"nullable": true
},
"version": {
"type": "integer",
"format": "int32"
},
"compareId": {
"type": "string",
"nullable": true
},
"compareVersion": {
"type": "integer",
"format": "int32"
},
"allowNoteModeration": {
"type": "boolean"
}
},
"additionalProperties": false
},
"CreatePurlResponse": {
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"nullable": true
}
},
"additionalProperties": false
},
"CreateUserRequest": {
"required": [
"email",
"firstName",
"lastName",
"password",
"role"
],
"type": "object",
"properties": {
"firstName": {
"maxLength": 256,
"type": "string"
},
"lastName": {
"maxLength": 256,
"type": "string"
},
"email": {
"maxLength": 256,
"type": "string",
"format": "email"
},
"role": {
"type": "string"
},
"password": {
"minLength": 6,
"type": "string"
},
"webLoginEnabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"AvatarType": {
"enum": [
0,
1
],
"type": "integer",
"format": "int32"
},
"UserResponse": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"firstName": {
"type": "string",
"nullable": true
},
"lastName": {
"type": "string",
"nullable": true
},
"fullName": {
"type": "string",
"nullable": true,
"readOnly": true
},
"initials": {
"type": "string",
"nullable": true,
"readOnly": true
},
"email": {
"type": "string",
"nullable": true
},
"role": {
"type": "string",
"nullable": true
},
"activated": {
"type": "boolean"
},
"loginEnabled": {
"type": "boolean"
},
"gravatarUrl": {
"type": "string",
"nullable": true
},
"annotationColor": {
"type": "string",
"nullable": true
},
"avatarBackgroundColor": {
"type": "string",
"nullable": true
},
"avatarType": {
"allOf": [
{
"$ref": "#/components/schemas/AvatarType"
}
]
}
},
"additionalProperties": false
},
"UpdateUserRequest": {
"type": "object",
"properties": {
"firstName": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"lastName": {
"maxLength": 256,
"type": "string",
"nullable": true
},
"password": {
"minLength": 6,
"type": "string",
"nullable": true
},
"webLoginEnabled": {
"type": "boolean"
}
},
"additionalProperties": false
},
"InviteUserRequest": {
"required": [
"email",
"firstName",
"lastName",
"role"
],
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"role": {
"type": "string"
},
"message": {
"type": "string",
"nullable": true
},
"approvalId": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"InviteUserResponse": {
"type": "object",
"properties": {
"invitationUrl": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
},
"securitySchemes": {
"oauth2": {
"type": "oauth2",
"description": "Get Token From Identity Web",
"flows": {
"clientCredentials": {
"authorizationUrl": "https://account.mediamarkup.com/connect/authorize",
"tokenUrl": "https://account.mediamarkup.com/connect/token",
"scopes": {
"user-api": "API Scope"
}
}
}
}
}
}
}