From a76f84417a6b64d7d3ac5ba147e74148da643c62 Mon Sep 17 00:00:00 2001 From: ddemeyer Date: Fri, 12 Dec 2025 19:58:19 +0100 Subject: [PATCH 1/3] #223 Added Pester tests based on 2024040 members. Refreshed OpenApiISH30Client, changed 3 enums and Id property to LogicalId to compile but got several errors. Refreshed OpenAPIAM10Client, no code changes but all OperationIds changed.... Probably not many scripts use OpenAPI proxies so could be resolved with breaking change documentation. --- .../OpenApiAM10.json | 7099 ++-- .../OpenApiISH30.json | 31528 ++++++++++++---- .../Cmdlets/Session/NewIshSession.Tests.ps1 | 36 +- .../ExtensionMethods/IshFieldsExtensions.cs | 6 +- .../OpenApiISH30EnumerationsExtensions.cs | 6 +- 5 files changed, 28479 insertions(+), 10196 deletions(-) diff --git a/Source/ISHRemote/Trisoft.ISHRemote.OpenApiAM10/OpenApiAM10.json b/Source/ISHRemote/Trisoft.ISHRemote.OpenApiAM10/OpenApiAM10.json index 99c17d7e..bb0734ea 100644 --- a/Source/ISHRemote/Trisoft.ISHRemote.OpenApiAM10/OpenApiAM10.json +++ b/Source/ISHRemote/Trisoft.ISHRemote.OpenApiAM10/OpenApiAM10.json @@ -1,3662 +1,3667 @@ { "openapi": "3.0.1", "info": { - "title": "Access Management API v1.0.0 (20240404)", - "description": "Access Management provides implementers with a simplified approach to identity management and gives administrators a central location for ongoing management of access to applications. ", - "version": "v1" + "title": "Access Management API v1.0.0 (20251210)", + "description": "Access Management provides implementers with a simplified approach to identity management and gives administrators a central location for ongoing management of access to applications. ", + "version": "v1" }, "servers": [ - { - "url": "/ISHAM" - } + { + "url": "/ISHAM" + } ], "paths": { - "/api/v1/ApiResources": { - "get": { - "tags": [ - "ApiResources" - ], - "summary": "Gets a list of all API resources in the system.", - "operationId": "ApiResourcesGet", - "responses": { - "200": { - "description": "Returns a list of API resources.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApiResource" - } - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + "/api/v1/ApiResources": { + "get": { + "tags": [ + "ApiResources" + ], + "summary": "Gets a list of all API resources in the system.", + "operationId": "ApiResources_Get", + "responses": { + "200": { + "description": "Returns a list of API resources.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiResource" + } + } } - } - }, - "/api/v1/ApiResources/{id}": { - "get": { - "tags": [ - "ApiResources" - ], - "summary": "Gets the API resource with the given ID.", - "operationId": "ApiResourcesGetById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ID of the API resource to retrieve.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Returns the requested API resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ApiResource" - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "The API resource does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } + } } - }, - "/api/v1/Applications": { - "get": { - "tags": [ - "Applications" - ], - "summary": "Gets a list of all applications in the system.", - "operationId": "ApplicationsGet", - "responses": { - "200": { - "description": "Returns a list of applications.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Application" - } - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + } + } + }, + "/api/v1/ApiResources/{id}": { + "get": { + "tags": [ + "ApiResources" + ], + "summary": "Gets the API resource with the given ID.", + "operationId": "ApiResources_GetById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The ID of the API resource to retrieve.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Returns the requested API resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResource" + } } + } }, - "post": { - "tags": [ - "Applications" - ], - "summary": "Creates a new application.", - "operationId": "ApplicationsCreate", - "requestBody": { - "description": "The application to create.", - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/Application" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Application" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/Application" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/Application" - } - } - } - }, - "responses": { - "201": { - "description": "The application was created successfully. The Location header contains the URL to the new item.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Application" - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + "404": { + "description": "The API resource does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } } - }, - "/api/v1/Applications/{id}": { - "get": { - "tags": [ - "Applications" - ], - "summary": "Gets the application with the given ID.", - "operationId": "ApplicationsGetById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ID of the application to retrieve.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Returns the requested application.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Application" - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "The application does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + } + } + }, + "/api/v1/Applications": { + "get": { + "tags": [ + "Applications" + ], + "summary": "Gets a list of all applications in the system.", + "operationId": "Applications_Get", + "responses": { + "200": { + "description": "Returns a list of applications.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Application" + } + } } + } }, - "put": { - "tags": [ - "Applications" - ], - "summary": "Updates an existing application.", - "operationId": "ApplicationsUpdate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ID of the application to update.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "requestBody": { - "description": "The new data of the application.", - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/Application" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/Application" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/Application" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/Application" - } - } - } - }, - "responses": { - "200": { - "description": "Returns the updated application.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Application" - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "The application does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } + } }, - "delete": { - "tags": [ - "Applications" - ], - "summary": "Permanently deletes an existing application.", - "operationId": "ApplicationsDelete", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ID of the application to delete.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "204": { - "description": "The application was successfully deleted." - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "The application does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } + } } + } }, - "/api/v1/AuditLogs": { - "get": { - "tags": [ - "AuditLogs" - ], - "summary": "Gets a list of audit log entries matching the given filter.", - "operationId": "AuditLogsGetByFilter", - "parameters": [ - { - "name": "UserName", - "in": "query", - "schema": { - "maxLength": 256, - "type": "string" - } - }, - { - "name": "FromDate", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "example": "2024-01-17 00:00:00.000" - }, - { - "name": "ToDate", - "in": "query", - "schema": { - "type": "string", - "format": "date-time" - }, - "example": "2024-01-17 23:59:59.999" - }, - { - "name": "EntityType", - "in": "query", - "schema": { - "maxItems": 10, - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "EntityName", - "in": "query", - "schema": { - "maxLength": 256, - "type": "string" - } - }, - { - "name": "Action", - "in": "query", - "schema": { - "maxItems": 5, - "type": "array", - "items": { - "$ref": "#/components/schemas/EntityActionType" - } - } - }, - { - "name": "Limit", - "in": "query", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Returns a list of audit log entries.", - "content": { - "text/plain": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AuditLog" - } - } - }, - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AuditLog" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AuditLog" - } - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + "post": { + "tags": [ + "Applications" + ], + "summary": "Creates a new application.", + "operationId": "Applications_Create", + "requestBody": { + "description": "The application to create.", + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/Application" } - } - }, - "/api/v1/AuditLogs/{id}": { - "get": { - "tags": [ - "AuditLogs" - ], - "summary": "Gets the audit log entry with the given ID.", - "operationId": "AuditLogsGetById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ID of the audit log entry to retrieve.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Returns the requested audit log entry.", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/AuditLogEntry" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/AuditLogEntry" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/AuditLogEntry" - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "The audit log entry does not exist.", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Application" } - } - }, - "/api/v1/IdentityProviders/availableIdpTypes": { - "get": { - "tags": [ - "IdentityProviders" - ], - "summary": "Gets a list of available identity provider types.", - "operationId": "IdentityProvidersGetAvailableIdpTypes", - "responses": { - "200": { - "description": "Returns the list of available identity provider types.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IdentityProviderTypeOption" - } - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Application" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/Application" } + } } - }, - "/api/v1/IdentityProviders": { - "get": { - "tags": [ - "IdentityProviders" - ], - "summary": "Gets a list of all identity providers in the system.", - "operationId": "IdentityProvidersGet", - "responses": { - "200": { - "description": "Returns a list of identity providers.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/IdentityProvider" - } - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + }, + "responses": { + "201": { + "description": "The application was created successfully. The Location header contains the URL to the new item.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Application" + } } + } }, - "post": { - "tags": [ - "IdentityProviders" - ], - "summary": "Creates a new identity provider.", - "operationId": "IdentityProvidersCreate", - "requestBody": { - "description": "The identity provider to create.", - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/IdentityProvider" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentityProvider" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/IdentityProvider" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/IdentityProvider" - } - } - } - }, - "responses": { - "201": { - "description": "The identity provider was created successfully. The Location header contains the URL to the new item.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentityProvider" - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } + } } - }, - "/api/v1/IdentityProviders/{id}": { - "get": { - "tags": [ - "IdentityProviders" - ], - "summary": "Gets the identity provider with the given ID.", - "operationId": "IdentityProvidersGetById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ID of the identity provider to retrieve.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Returns the requested identity provider.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentityProvider" - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "The identity provider does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + } + } + }, + "/api/v1/Applications/{id}": { + "get": { + "tags": [ + "Applications" + ], + "summary": "Gets the application with the given ID.", + "operationId": "Applications_GetById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The ID of the application to retrieve.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Returns the requested application.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Application" + } } + } }, - "put": { - "tags": [ - "IdentityProviders" - ], - "summary": "Updates an existing identity provider.", - "operationId": "IdentityProvidersUpdate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ID of the identity provider to update.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "requestBody": { - "description": "The new data of the identity provider.", - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/IdentityProvider" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentityProvider" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/IdentityProvider" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/IdentityProvider" - } - } - } - }, - "responses": { - "200": { - "description": "Returns the updated identity provider.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentityProvider" - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "The identity provider does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + "404": { + "description": "The application does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } + } }, - "delete": { - "tags": [ - "IdentityProviders" - ], - "summary": "Permanently deletes an existing identity provider.", - "operationId": "IdentityProvidersDelete", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ID of the identity provider to delete.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "204": { - "description": "The identity provider was successfully deleted." - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "The identity provider does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } + } } + } }, - "/api/v1/IdentityProviders/icon/{name}": { - "get": { - "tags": [ - "IdentityProviders" - ], - "summary": "Gets the icon for a given identity provider.", - "description": "If no icon has been specified for the identity provider, a default icon is returned.", - "operationId": "IdentityProvidersGetIcon", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "The name of the identity provider to get an icon for.", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Returns the icon as an image." - }, - "302": { - "description": "Redirects to a local image." - }, - "500": { - "description": "An unexpected error occurred." - } + "put": { + "tags": [ + "Applications" + ], + "summary": "Updates an existing application.", + "operationId": "Applications_Update", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The ID of the application to update.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "requestBody": { + "description": "The new data of the application.", + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/Application" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Application" } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Application" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/Application" + } + } } - }, - "/api/v1/IdentityProviders/loginOptions": { - "get": { - "tags": [ - "IdentityProviders" - ], - "summary": "Gets a list of all login possibilities currently available.", - "operationId": "IdentityProvidersGetLoginOptions", - "responses": { - "200": { - "description": "Returns the list of login options.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LoginOption" - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + }, + "responses": { + "200": { + "description": "Returns the updated application.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Application" + } + } + } + }, + "404": { + "description": "The application does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } } + } }, - "/api/v1/IdentityProviders/getParametersForIdentityProviderType/{providerType}": { - "get": { - "tags": [ - "IdentityProviders" - ], - "summary": "Gets a list of parameters specific to a given type of identity provider.", - "operationId": "IdentityProvidersGetParametersForIdentityProviderType", - "parameters": [ - { - "name": "providerType", - "in": "path", - "description": "The type of identity provider to retrieve the parameters for.", - "required": true, - "schema": { - "$ref": "#/components/schemas/IdentityProviderType" - } - } - ], - "responses": { - "200": { - "description": "Returns the list of parameters for the given type.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/IdentityProviderParameters" - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + "delete": { + "tags": [ + "Applications" + ], + "summary": "Permanently deletes an existing application.", + "operationId": "Applications_Delete", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The ID of the application to delete.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "204": { + "description": "The application was successfully deleted." + }, + "404": { + "description": "The application does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } } - }, - "/api/v1/ServiceAccounts": { - "get": { - "tags": [ - "ServiceAccounts" - ], - "summary": "Gets a list of all service accounts in the system.", - "operationId": "ServiceAccountsGet", - "responses": { - "200": { - "description": "Returns a list of service accounts.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ServiceAccount" - } - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + } + } + }, + "/api/v1/AuditLogs": { + "get": { + "tags": [ + "AuditLogs" + ], + "summary": "Gets a list of audit log entries matching the given filter.", + "operationId": "AuditLogs_GetByFilter", + "parameters": [ + { + "name": "UserName", + "in": "query", + "schema": { + "maxLength": 256, + "type": "string" + } + }, + { + "name": "FromDate", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "example": "2025-12-12 00:00:00.000" + }, + { + "name": "ToDate", + "in": "query", + "schema": { + "type": "string", + "format": "date-time" + }, + "example": "2025-12-12 23:59:59.999" + }, + { + "name": "EntityType", + "in": "query", + "schema": { + "maxItems": 10, + "type": "array", + "items": { + "type": "string" } + } }, - "post": { - "tags": [ - "ServiceAccounts" - ], - "summary": "Creates a new service account.", - "operationId": "ServiceAccountsCreate", - "requestBody": { - "description": "The data of the service account to create.", - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/ServiceAccount" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceAccount" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ServiceAccount" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ServiceAccount" - } - } - } - }, - "responses": { - "201": { - "description": "The service account was created successfully. The Location header contains the URL to the new item.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceAccount" - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + { + "name": "EntityName", + "in": "query", + "schema": { + "maxLength": 256, + "type": "string" + } + }, + { + "name": "Action", + "in": "query", + "schema": { + "maxItems": 5, + "type": "array", + "items": { + "$ref": "#/components/schemas/EntityActionType" } + } + }, + { + "name": "Limit", + "in": "query", + "schema": { + "type": "integer", + "format": "int32" + } } - }, - "/api/v1/ServiceAccounts/{id}": { - "get": { - "tags": [ - "ServiceAccounts" - ], - "summary": "Gets the service account with the given ID.", - "operationId": "ServiceAccountsGetById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ID of the service account to retrieve.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } + ], + "responses": { + "200": { + "description": "Returns a list of audit log entries.", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AuditLog" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AuditLog" } - ], - "responses": { - "200": { - "description": "Returns the requested service account.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceAccount" - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "The service account does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AuditLog" } + } } + } }, - "put": { - "tags": [ - "ServiceAccounts" - ], - "summary": "Updates an existing service account.", - "operationId": "ServiceAccountsUpdate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ID of the service account to update.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "requestBody": { - "description": "The new data of the service account.", - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/ServiceAccount" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceAccount" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ServiceAccount" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/ServiceAccount" - } - } - } + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } }, - "responses": { - "200": { - "description": "Returns the updated service account.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ServiceAccount" - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "The service account does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } + } }, - "delete": { - "tags": [ - "ServiceAccounts" - ], - "summary": "Permanently deletes an existing service account.", - "operationId": "ServiceAccountsDelete", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ID of the service account to delete.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "204": { - "description": "The service account was successfully deleted." - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "The service account does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + "400": { + "description": "A validation error occurred.", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } - } - }, - "/api/v1/ServiceAccounts/{serviceAccountId}/generateClientSecret": { - "post": { - "tags": [ - "ServiceAccounts" - ], - "summary": "Generates a new client secret that can be used to log in as a given service account.", - "operationId": "ServiceAccountsGenerateClientSecret", - "parameters": [ - { - "name": "serviceAccountId", - "in": "path", - "description": "The ID of the service account.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Returns the new client secret.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserClientSecret" - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "The service account does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } + } } - }, - "/api/v1/ServiceAccounts/{serviceAccountId}/clientSecrets/{secretId}": { - "put": { - "tags": [ - "ServiceAccounts" - ], - "summary": "Updates an existing client secret.", - "operationId": "ServiceAccountsUpdateClientSecret", - "parameters": [ - { - "name": "serviceAccountId", - "in": "path", - "description": "The ID of the service account.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "secretId", - "in": "path", - "description": "The ID of the secret to update.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "requestBody": { - "description": "The new data of the client secret.", - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/UserClientSecret" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserClientSecret" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/UserClientSecret" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/UserClientSecret" - } - } - } + } + } + }, + "/api/v1/AuditLogs/{id}": { + "get": { + "tags": [ + "AuditLogs" + ], + "summary": "Gets the audit log entry with the given ID.", + "operationId": "AuditLogs_GetById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The ID of the audit log entry to retrieve.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Returns the requested audit log entry.", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/AuditLogEntry" + } }, - "responses": { - "200": { - "description": "Returns the updated client secret.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserClientSecret" - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "The service account or client secret does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/AuditLogEntry" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/AuditLogEntry" + } } + } }, - "delete": { - "tags": [ - "ServiceAccounts" - ], - "summary": "Permanently deletes an existing client secret from a service account.", - "operationId": "ServiceAccountsDeleteClientSecret", - "parameters": [ - { - "name": "serviceAccountId", - "in": "path", - "description": "The ID of the service account.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "secretId", - "in": "path", - "description": "The ID of the secret to delete.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "204": { - "description": "The client secret was successfully deleted." - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "The service account or client secret does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + "404": { + "description": "The audit log entry does not exist.", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } + } } - }, - "/api/v1/System/getLoginStatus": { - "get": { - "tags": [ - "System" - ], - "summary": "Gets the login status of the current user.", - "operationId": "SystemGetLoginStatus", - "responses": { - "200": { - "description": "Returns either None, LoggedIn, or Anonymous (if there are no IDPs yet or the configuration forces an anonymous state).", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/LoginStatus" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/LoginStatus" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/LoginStatus" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + } + } + }, + "/api/v1/IdentityProviders/availableIdpTypes": { + "get": { + "tags": [ + "IdentityProviders" + ], + "summary": "Gets a list of available identity provider types.", + "operationId": "IdentityProviders_GetAvailableIdpTypes", + "responses": { + "200": { + "description": "Returns the list of available identity provider types.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IdentityProviderTypeOption" + } + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } + } } - }, - "/api/v1/System/userInfo": { - "get": { - "tags": [ - "System" - ], - "summary": "Gets information about the current user.", - "operationId": "SystemGetUserInfo", - "responses": { - "200": { - "description": "Returns information about the current user.", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/UserInfo" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserInfo" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/UserInfo" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + } + } + }, + "/api/v1/IdentityProviders": { + "get": { + "tags": [ + "IdentityProviders" + ], + "summary": "Gets a list of all identity providers in the system.", + "operationId": "IdentityProviders_Get", + "responses": { + "200": { + "description": "Returns a list of identity providers.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IdentityProvider" + } + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } } + } }, - "/api/v1/System/supportedCultures": { - "get": { - "tags": [ - "System" - ], - "summary": "Gets a list of all supported languages and a list of all supported regions.", - "operationId": "SystemGetSupportedCultures", - "responses": { - "200": { - "description": "Returns an object with a list of all supported languages and a separate list of supported regions.", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/SupportedCultures" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/SupportedCultures" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/SupportedCultures" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "text/plain": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + "post": { + "tags": [ + "IdentityProviders" + ], + "summary": "Creates a new identity provider.", + "operationId": "IdentityProviders_Create", + "requestBody": { + "description": "The identity provider to create.", + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/IdentityProvider" } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + } } - }, - "/api/v1/Users": { - "get": { - "tags": [ - "Users" - ], - "summary": "Gets a list of all users in the system.", - "operationId": "UsersGet", - "responses": { - "200": { - "description": "Returns a list of users.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/User" - } - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + }, + "responses": { + "201": { + "description": "The identity provider was created successfully. The Location header contains the URL to the new item.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } } - }, - "/api/v1/Users/{id}": { - "get": { - "tags": [ - "Users" - ], - "summary": "Gets the user with the given ID.", - "operationId": "UsersGetById", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ID of the user to retrieve.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Returns the requested user.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/User" - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "The user does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + } + } + }, + "/api/v1/IdentityProviders/{id}": { + "get": { + "tags": [ + "IdentityProviders" + ], + "summary": "Gets the identity provider with the given ID.", + "operationId": "IdentityProviders_GetById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The ID of the identity provider to retrieve.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Returns the requested identity provider.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } } + } }, - "put": { - "tags": [ - "Users" - ], - "summary": "Updates an existing user.", - "operationId": "UsersUpdate", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ID of the user to update.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "requestBody": { - "description": "The new data of the user.", - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/User" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/User" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/User" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/User" - } - } - } - }, - "responses": { - "200": { - "description": "Returns the updated user.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/User" - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "The user does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + "404": { + "description": "The identity provider does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } + } }, - "delete": { - "tags": [ - "Users" - ], - "summary": "Permanently deletes an existing user.", - "description": "Note that deleted users will automatically be recreated if they log into Access Management afterwards.\r\nTo completely remove users, first remove them from the external identity provider.", - "operationId": "UsersDelete", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ID of the user to delete.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "204": { - "description": "The user was successfully deleted." - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "The user does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } + } } + } }, - "/api/v1/Users/{id}/deactivate": { - "put": { - "tags": [ - "Users" - ], - "summary": "Deactivates a user, so they can no longer log in.", - "operationId": "UsersDeactivateUser", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ID of the user to deactivate.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "The user was successfully deactivated." - }, - "404": { - "description": "The user does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + "put": { + "tags": [ + "IdentityProviders" + ], + "summary": "Updates an existing identity provider.", + "operationId": "IdentityProviders_Update", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The ID of the identity provider to update.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "requestBody": { + "description": "The new data of the identity provider.", + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/IdentityProvider" } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + } } - }, - "/api/v1/Users/{id}/activate": { - "put": { - "tags": [ - "Users" - ], - "summary": "Re-activates a deactivated user so they can log in again.", - "operationId": "UsersActivateUser", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The ID of the user to activate.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "The user was successfully activated." - }, - "404": { - "description": "The user does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } + }, + "responses": { + "200": { + "description": "Returns the updated identity provider.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + } + } + }, + "404": { + "description": "The identity provider does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } } + } } + } }, - "/api/v1/Users/{userId}/generateClientSecret": { - "post": { - "tags": [ - "Users" - ], - "summary": "Generates a new client secret that can be used to log in as a given user.\r\n(Client secrets for users are deprecated. Please use service accounts instead.)", - "operationId": "UsersGenerateClientSecret", - "parameters": [ - { - "name": "userId", - "in": "path", - "description": "The ID of the user.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Returns the new client secret.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserClientSecret" - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "The user does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "deprecated": true + "delete": { + "tags": [ + "IdentityProviders" + ], + "summary": "Permanently deletes an existing identity provider.", + "operationId": "IdentityProviders_Delete", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The ID of the identity provider to delete.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } } - }, - "/api/v1/Users/{userId}/clientSecrets/{secretId}": { - "put": { - "tags": [ - "Users" - ], - "summary": "Updates an existing client secret.\r\n(Client secrets for users are deprecated. Please use service accounts instead.)", - "operationId": "UsersUpdateClientSecret", - "parameters": [ - { - "name": "userId", - "in": "path", - "description": "The ID of the user.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "secretId", - "in": "path", - "description": "The ID of the secret to update.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "requestBody": { - "description": "The new data of the client secret.", - "content": { - "application/json-patch+json": { - "schema": { - "$ref": "#/components/schemas/UserClientSecret" - } - }, - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserClientSecret" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/UserClientSecret" - } - }, - "application/*+json": { - "schema": { - "$ref": "#/components/schemas/UserClientSecret" - } - } - } - }, - "responses": { - "200": { - "description": "Returns the updated client secret.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/UserClientSecret" - } - } - } - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "The user or client secret does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "deprecated": true - }, - "delete": { - "tags": [ - "Users" - ], - "summary": "Permanently deletes an existing client secret from a user.\r\n(Client secrets for users are deprecated. Please use service accounts instead.)", - "operationId": "UsersDeleteClientSecret", - "parameters": [ - { - "name": "userId", - "in": "path", - "description": "The ID of the user.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - }, - { - "name": "secretId", - "in": "path", - "description": "The ID of the secret to delete.", - "required": true, - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "204": { - "description": "The client secret was successfully deleted." - }, - "400": { - "description": "A validation error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "404": { - "description": "The user or client secret does not exist.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - }, - "500": { - "description": "An unexpected error occurred.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ErrorResponse" - } - } - } - } - }, - "deprecated": true + ], + "responses": { + "204": { + "description": "The identity provider was successfully deleted." + }, + "404": { + "description": "The identity provider does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } } + } } - }, - "components": { - "schemas": { - "ApiResource": { - "required": [ - "key", - "name" - ], - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "key": { - "maxLength": 256, - "minLength": 1, - "pattern": "^[a-zA-Z0-9-_.]*$", - "type": "string" - }, - "name": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "roles": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApiResourceRole" - }, - "nullable": true - } - }, - "additionalProperties": false - }, - "ApiResourceLink": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string", - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false - }, - "ApiResourceRole": { - "required": [ - "key", - "name" - ], - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "key": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "name": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "apiResource": { - "$ref": "#/components/schemas/ApiResource" - } - }, - "additionalProperties": false - }, - "ApiResourceRoleLink": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string", - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false - }, - "Application": { - "required": [ - "allowedAuthenticationFlowType", - "clientId", - "name", - "redirectUrls" - ], - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Autogenerated Id.Readonly on Update", - "format": "int32", - "readOnly": true - }, - "createdBy": { - "$ref": "#/components/schemas/UserLink" - }, - "modifiedBy": { - "$ref": "#/components/schemas/UserLink" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "modifiedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "clientId": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "name": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "redirectUrls": { - "type": "array", - "items": { - "type": "string" - } - }, - "allowedAuthenticationFlowType": { - "$ref": "#/components/schemas/AuthenticationFlowType" - } - }, - "additionalProperties": false - }, - "ApplicationLink": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string", - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false - }, - "AuditLog": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Autogenerated Id.", - "format": "int32", - "readOnly": true - }, - "user": { - "$ref": "#/components/schemas/Link" - }, - "date": { - "type": "string", - "format": "date-time" - }, - "entityType": { - "type": "string", - "nullable": true - }, - "entity": { - "$ref": "#/components/schemas/Link" - }, - "action": { - "$ref": "#/components/schemas/EntityActionType" - } - }, - "additionalProperties": false - }, - "AuditLogEntry": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Autogenerated Id.", - "format": "int32", - "readOnly": true - }, - "user": { - "$ref": "#/components/schemas/Link" - }, - "date": { - "type": "string", - "format": "date-time" - }, - "entityType": { - "type": "string", - "nullable": true - }, - "entityId": { - "type": "integer", - "format": "int32" - }, - "entityData": { - "nullable": true - }, - "action": { - "$ref": "#/components/schemas/EntityActionType" - } - }, - "additionalProperties": false - }, - "AuthenticationFlowType": { - "enum": [ - "AuthorizationCodeWithPkce", - "AuthorizationCode", - "Implicit" - ], + }, + "/api/v1/IdentityProviders/icon/{name}": { + "get": { + "tags": [ + "IdentityProviders" + ], + "summary": "Gets the icon for a given identity provider.", + "description": "If no icon has been specified for the identity provider, a default icon is returned.", + "operationId": "IdentityProviders_GetIcon", + "parameters": [ + { + "name": "name", + "in": "path", + "description": "The name of the identity provider to get an icon for.", + "required": true, + "schema": { "type": "string" + } + } + ], + "responses": { + "302": { + "description": "Redirects to a local image." }, - "ClaimBasedAccessControlEntry": { - "type": "object", - "properties": { - "applications": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApplicationLink" - }, - "nullable": true - }, - "apiResources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApiResourceLink" - }, - "nullable": true - }, - "apiResourceRoles": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApiResourceRoleLink" - }, - "nullable": true - }, - "claimType": { - "maxLength": 256, - "type": "string", - "description": "Gets or sets Claim type coming from the IdP.", - "nullable": true - }, - "claimValue": { - "maxLength": 256, - "type": "string", - "description": "Gets or sets Claim value coming from the IdP.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Represents idp claim access control for applications , resources and roles." - }, - "EntityActionType": { - "enum": [ - "Deleted", - "Updated", - "Added", - "Activated", - "Deactivated" - ], - "type": "string" + "200": { + "description": "Returns the icon as an image." }, - "ErrorMessage": { - "type": "object", - "properties": { - "code": { - "type": "string", - "nullable": true - }, - "message": { - "type": "string", - "nullable": true - }, - "localizedMessage": { - "type": "string", - "nullable": true - }, - "target": { - "type": "string", - "nullable": true - }, - "details": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ErrorMessage" - }, - "nullable": true - }, - "innerError": { - "$ref": "#/components/schemas/IInnerError" - }, - "stackTrace": { - "type": "string", - "nullable": true - }, - "innerException": { - "$ref": "#/components/schemas/ErrorMessage" - } - }, - "additionalProperties": false + "500": { + "description": "An unexpected error occurred." + } + } + } + }, + "/api/v1/IdentityProviders/loginOptions": { + "get": { + "tags": [ + "IdentityProviders" + ], + "summary": "Gets a list of all login possibilities currently available.", + "operationId": "IdentityProviders_GetLoginOptions", + "responses": { + "200": { + "description": "Returns the list of login options.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LoginOption" + } + } + } + } }, - "ErrorResponse": { - "type": "object", - "properties": { - "errorMessage": { - "$ref": "#/components/schemas/ErrorMessage" - } - }, - "additionalProperties": false - }, - "IInnerError": { - "type": "object", - "properties": { - "code": { - "type": "string", - "nullable": true - }, - "innerError": { - "$ref": "#/components/schemas/IInnerError" - } - }, - "additionalProperties": false - }, - "IdentityProvider": { - "required": [ - "key", - "name", - "parameters", - "type" - ], - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Autogenerated Id.", - "format": "int32", - "readOnly": true - }, - "createdBy": { - "$ref": "#/components/schemas/UserLink" - }, - "modifiedBy": { - "$ref": "#/components/schemas/UserLink" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "modifiedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "key": { - "maxLength": 64, - "minLength": 1, - "pattern": "^[a-zA-Z0-9_]*$", - "type": "string", - "description": "Provider name.Readonly on Update" - }, - "name": { - "maxLength": 256, - "minLength": 1, - "type": "string", - "description": "Provider display name." - }, - "isEnabled": { - "type": "boolean", - "description": "Specifies if provider is enabled.", - "default": true - }, - "description": { - "maxLength": 2048, - "type": "string", - "description": "Provider description.", - "nullable": true - }, - "type": { - "$ref": "#/components/schemas/IdentityProviderType" - }, - "iconUrl": { - "type": "string", - "description": "The external URL of the icon to use for this provider.", - "nullable": true - }, - "iconViewUrl": { - "type": "string", - "description": "The URL to view the icon for this provider.", - "nullable": true, - "readOnly": true - }, - "accessControlList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ClaimBasedAccessControlEntry" - }, - "description": "Access Control List", - "nullable": true - }, - "forwardedClaims": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Forwarded Claims", - "nullable": true - }, - "parameters": { - "$ref": "#/components/schemas/IdentityProviderParameters" - }, - "redirectUrl": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "postLogoutRedirectUrl": { - "type": "string", - "nullable": true, - "readOnly": true - }, - "validateUrl": { - "type": "string", - "description": "Gets or sets the URL to use to validate that this Tridion.AccessManagement.Model.V1.IdentityProvider is configured correctly.", - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false, - "description": "Represents the identity provider." - }, - "IdentityProviderLink": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string", - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false, - "description": "Readonly on Update" - }, - "IdentityProviderParameters": { - "type": "object", - "anyOf": [ - { - "$ref": "#/components/schemas/LdapParameters" - }, - { - "$ref": "#/components/schemas/OpenIdParameters" - }, - { - "$ref": "#/components/schemas/SamlParameters" - }, - { - "$ref": "#/components/schemas/WindowsParameters" - } - ], - "properties": { - "$type": { - "type": "string", - "readOnly": true - } - }, - "additionalProperties": false, - "discriminator": { - "propertyName": "$type" - } - }, - "IdentityProviderType": { - "enum": [ - "OpenIdConnect", - "SAML2P", - "LDAP", - "Windows" - ], - "type": "string", - "description": "Readonly on Update", - "readOnly": true - }, - "IdentityProviderTypeOption": { - "type": "object", - "properties": { - "typeId": { - "$ref": "#/components/schemas/IdentityProviderType" - }, - "name": { - "type": "string", - "description": "Localized human readable name.", - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false, - "description": "Represents the Identity provider type option description." - }, - "LdapParameters": { - "required": [ - "fullNameClaim", - "port", - "searchAccount", - "searchAccountPassword", - "serverAddress", - "userBaseDn", - "usernameClaim", - "useSsl" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/IdentityProviderParameters" - } - ], - "properties": { - "separator": { - "maxLength": 1, - "type": "string", - "description": "Separator to join IdP name and username.", - "nullable": true - }, - "usernameClaim": { - "maxLength": 256, - "minLength": 1, - "type": "string", - "description": "Provider claim type to use for username." - }, - "fullNameClaim": { - "maxLength": 256, - "minLength": 1, - "type": "string", - "description": "Provider claim type to use for Full name." - }, - "serverAddress": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "port": { - "type": "integer", - "format": "int32" - }, - "useSsl": { - "type": "boolean" - }, - "searchAccount": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "searchAccountPassword": { - "maxLength": 256, - "minLength": 1, - "type": "string", - "format": "password" - }, - "userBaseDn": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "groupBaseDn": { - "maxLength": 256, - "type": "string", - "nullable": true - }, - "groupMemberAttribute": { - "maxLength": 256, - "type": "string", - "nullable": true - }, - "additionalAttributes": { - "maxLength": 256, - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, - "Link": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, - "LoginOption": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "key": { - "type": "string", - "nullable": true - }, - "loginTriggerUrl": { - "type": "string", - "nullable": true - }, - "iconUrl": { - "type": "string", - "nullable": true - } - }, - "additionalProperties": false - }, - "LoginStatus": { - "enum": [ - "None", - "Anonymous", - "LoggedIn" - ], - "type": "string" + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } }, - "OpenIdParameters": { - "required": [ - "authority", - "clientId", - "fullNameClaim", - "usernameClaim" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/IdentityProviderParameters" - } - ], - "properties": { - "separator": { - "maxLength": 1, - "type": "string", - "description": "Separator to join IdP name and username.", - "nullable": true - }, - "usernameClaim": { - "maxLength": 256, - "minLength": 1, - "type": "string", - "description": "Provider claim type to use for username." - }, - "fullNameClaim": { - "maxLength": 256, - "minLength": 1, - "type": "string", - "description": "Provider claim type to use for Full name." - }, - "authority": { - "maxLength": 256, - "minLength": 1, - "type": "string", - "format": "uri" - }, - "clientId": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "clientSecret": { - "maxLength": 256, - "type": "string", - "format": "password", - "nullable": true - }, - "endSessionEndpoint": { - "maxLength": 256, - "type": "string", - "format": "uri", - "nullable": true - }, - "responseType": { - "maxLength": 256, - "type": "string", - "default": "id_token", - "nullable": true - }, - "sendIdTokenHintDuringLogout": { - "type": "boolean" - } - }, - "additionalProperties": false - }, - "SamlParameters": { - "required": [ - "certificates", - "fullNameClaim", - "issuerName", - "serviceProviderName", - "singleLogoutServiceUrl", - "singleSignOnServiceUrl", - "usernameClaim" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/IdentityProviderParameters" - } - ], - "properties": { - "separator": { - "maxLength": 1, - "type": "string", - "description": "Separator to join IdP name and username.", - "nullable": true - }, - "usernameClaim": { - "maxLength": 256, - "minLength": 1, - "type": "string", - "description": "Provider claim type to use for username." - }, - "fullNameClaim": { - "maxLength": 256, - "minLength": 1, - "type": "string", - "description": "Provider claim type to use for Full name." - }, - "issuerName": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "serviceProviderName": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "singleSignOnServiceUrl": { - "maxLength": 256, - "minLength": 1, - "type": "string", - "format": "uri" - }, - "singleLogoutServiceUrl": { - "maxLength": 256, - "minLength": 1, - "type": "string", - "format": "uri" - }, - "certificates": { - "minItems": 1, - "type": "array", - "items": { - "type": "string" - } - } + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/IdentityProviders/getParametersForIdentityProviderType/{providerType}": { + "get": { + "tags": [ + "IdentityProviders" + ], + "summary": "Gets a list of parameters specific to a given type of identity provider.", + "operationId": "IdentityProviders_GetParametersForIdentityProviderType", + "parameters": [ + { + "name": "providerType", + "in": "path", + "description": "The type of identity provider to retrieve the parameters for.", + "required": true, + "schema": { + "$ref": "#/components/schemas/IdentityProviderType" + } + } + ], + "responses": { + "200": { + "description": "Returns the list of parameters for the given type.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IdentityProviderParameters" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/ServiceAccounts": { + "get": { + "tags": [ + "ServiceAccounts" + ], + "summary": "Gets a list of all service accounts in the system.", + "operationId": "ServiceAccounts_Get", + "responses": { + "200": { + "description": "Returns a list of service accounts.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ServiceAccount" + } + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "post": { + "tags": [ + "ServiceAccounts" + ], + "summary": "Creates a new service account.", + "operationId": "ServiceAccounts_Create", + "requestBody": { + "description": "The data of the service account to create.", + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/ServiceAccount" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceAccount" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ServiceAccount" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ServiceAccount" + } + } + } + }, + "responses": { + "201": { + "description": "The service account was created successfully. The Location header contains the URL to the new item.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceAccount" + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/ServiceAccounts/{id}": { + "get": { + "tags": [ + "ServiceAccounts" + ], + "summary": "Gets the service account with the given ID.", + "operationId": "ServiceAccounts_GetById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The ID of the service account to retrieve.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Returns the requested service account.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceAccount" + } + } + } + }, + "404": { + "description": "The service account does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "ServiceAccounts" + ], + "summary": "Updates an existing service account.", + "operationId": "ServiceAccounts_Update", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The ID of the service account to update.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "requestBody": { + "description": "The new data of the service account.", + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/ServiceAccount" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceAccount" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ServiceAccount" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ServiceAccount" + } + } + } + }, + "responses": { + "200": { + "description": "Returns the updated service account.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ServiceAccount" + } + } + } + }, + "404": { + "description": "The service account does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "ServiceAccounts" + ], + "summary": "Permanently deletes an existing service account.", + "operationId": "ServiceAccounts_Delete", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The ID of the service account to delete.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "204": { + "description": "The service account was successfully deleted." + }, + "404": { + "description": "The service account does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/ServiceAccounts/{serviceAccountId}/generateClientSecret": { + "post": { + "tags": [ + "ServiceAccounts" + ], + "summary": "Generates a new client secret that can be used to log in as a given service account.", + "operationId": "ServiceAccounts_GenerateClientSecret", + "parameters": [ + { + "name": "serviceAccountId", + "in": "path", + "description": "The ID of the service account.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Returns the new client secret.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserClientSecret" + } + } + } + }, + "404": { + "description": "The service account does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/ServiceAccounts/{serviceAccountId}/clientSecrets/{secretId}": { + "put": { + "tags": [ + "ServiceAccounts" + ], + "summary": "Updates an existing client secret.", + "operationId": "ServiceAccounts_UpdateClientSecret", + "parameters": [ + { + "name": "serviceAccountId", + "in": "path", + "description": "The ID of the service account.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "secretId", + "in": "path", + "description": "The ID of the secret to update.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "requestBody": { + "description": "The new data of the client secret.", + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/UserClientSecret" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserClientSecret" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserClientSecret" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UserClientSecret" + } + } + } + }, + "responses": { + "200": { + "description": "Returns the updated client secret.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserClientSecret" + } + } + } + }, + "404": { + "description": "The service account or client secret does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "ServiceAccounts" + ], + "summary": "Permanently deletes an existing client secret from a service account.", + "operationId": "ServiceAccounts_DeleteClientSecret", + "parameters": [ + { + "name": "serviceAccountId", + "in": "path", + "description": "The ID of the service account.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "secretId", + "in": "path", + "description": "The ID of the secret to delete.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "204": { + "description": "The client secret was successfully deleted." + }, + "404": { + "description": "The service account or client secret does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/System/getLoginStatus": { + "get": { + "tags": [ + "System" + ], + "summary": "Gets the login status of the current user.", + "operationId": "System_GetLoginStatus", + "responses": { + "200": { + "description": "Returns either None, LoggedIn, or Anonymous (if there are no IDPs yet or the configuration forces an anonymous state).", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/LoginStatus" + } }, - "additionalProperties": false - }, - "ServiceAccount": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Autogenerated Id.", - "format": "int32", - "readOnly": true - }, - "createdBy": { - "$ref": "#/components/schemas/UserLink" - }, - "modifiedBy": { - "$ref": "#/components/schemas/UserLink" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "modifiedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "name": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "clientId": { - "maxLength": 256, - "type": "string", - "nullable": true - }, - "lastLoginAt": { - "type": "string", - "format": "date-time", - "nullable": true, - "readOnly": true - }, - "clientSecrets": { - "maxItems": 2, - "type": "array", - "items": { - "$ref": "#/components/schemas/UserClientSecret" - }, - "nullable": true, - "readOnly": true - }, - "accessControlEntry": { - "$ref": "#/components/schemas/ServiceAccountBasedAccessControlEntry" - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/LoginStatus" + } }, - "additionalProperties": false - }, - "ServiceAccountBasedAccessControlEntry": { - "type": "object", - "properties": { - "apiResources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApiResourceLink" - }, - "nullable": true - }, - "apiResourceRoles": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApiResourceRoleLink" - }, - "nullable": true - }, - "applications": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApplicationLink" - }, - "nullable": true - } + "text/json": { + "schema": { + "$ref": "#/components/schemas/LoginStatus" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } }, - "additionalProperties": false - }, - "SupportedCulture": { - "type": "object", - "properties": { - "displayName": { - "type": "string", - "nullable": true - }, - "name": { - "type": "string", - "nullable": true - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } }, - "additionalProperties": false - }, - "SupportedCultures": { - "type": "object", - "properties": { - "languages": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SupportedCulture" - }, - "nullable": true, - "readOnly": true - }, - "regions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SupportedCulture" - }, - "nullable": true, - "readOnly": true - } + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/System/userInfo": { + "get": { + "tags": [ + "System" + ], + "summary": "Gets information about the current user.", + "operationId": "System_GetUserInfo", + "responses": { + "200": { + "description": "Returns information about the current user.", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/UserInfo" + } }, - "additionalProperties": false - }, - "User": { - "required": [ - "identityProvider", - "identityProviderKey", - "name", - "subject" - ], - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Autogenerated Id.", - "format": "int32", - "readOnly": true - }, - "createdBy": { - "$ref": "#/components/schemas/UserLink" - }, - "modifiedBy": { - "$ref": "#/components/schemas/UserLink" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "modifiedAt": { - "type": "string", - "format": "date-time", - "readOnly": true - }, - "name": { - "maxLength": 256, - "minLength": 1, - "type": "string" - }, - "email": { - "maxLength": 256, - "type": "string", - "format": "email", - "nullable": true - }, - "language": { - "maxLength": 20, - "type": "string", - "nullable": true - }, - "region": { - "maxLength": 20, - "type": "string", - "nullable": true - }, - "subject": { - "maxLength": 256, - "minLength": 1, - "type": "string", - "description": "Readonly on Update" - }, - "identityProvider": { - "$ref": "#/components/schemas/IdentityProviderLink" - }, - "identityProviderKey": { - "maxLength": 256, - "minLength": 1, - "type": "string", - "description": "Readonly on Update" - }, - "clientId": { - "maxLength": 256, - "type": "string", - "description": "Readonly on Update", - "nullable": true, - "readOnly": true - }, - "isEnabled": { - "type": "boolean", - "default": true - }, - "lastLoginAt": { - "type": "string", - "format": "date-time", - "nullable": true, - "readOnly": true - }, - "clientSecrets": { - "maxItems": 2, - "type": "array", - "items": { - "$ref": "#/components/schemas/UserClientSecret" - }, - "nullable": true, - "readOnly": true - }, - "accessControlEntry": { - "$ref": "#/components/schemas/UserBasedAccessControlEntry" - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserInfo" + } }, - "additionalProperties": false - }, - "UserBasedAccessControlEntry": { - "type": "object", - "properties": { - "applications": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApplicationLink" - }, - "nullable": true - }, - "apiResources": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApiResourceLink" - }, - "nullable": true - }, - "apiResourceRoles": { - "type": "array", - "items": { - "$ref": "#/components/schemas/ApiResourceRoleLink" - }, - "nullable": true - } + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserInfo" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } }, - "additionalProperties": false, - "description": "Represents user access control for applications , resources and roles." - }, - "UserClientSecret": { - "required": [ - "clientSecret", - "expiresAt" - ], - "type": "object", - "properties": { - "id": { - "type": "integer", - "description": "Autogenerated Id.", - "format": "int32", - "readOnly": true - }, - "clientSecret": { - "maxLength": 4000, - "minLength": 1, - "type": "string", - "readOnly": true - }, - "expiresAt": { - "type": "string", - "format": "date-time" - }, - "lastLoginAt": { - "type": "string", - "format": "date-time", - "nullable": true, - "readOnly": true - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } }, - "additionalProperties": false - }, - "UserInfo": { - "type": "object", - "properties": { - "name": { - "type": "string", - "nullable": true - }, - "subject": { - "type": "string", - "nullable": true - }, - "avatar": { - "type": "string", - "nullable": true - }, - "roles": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true - }, - "isAnonymous": { - "type": "boolean" - }, - "locale": { - "$ref": "#/components/schemas/UserLocaleInfo" - } + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/System/supportedCultures": { + "get": { + "tags": [ + "System" + ], + "summary": "Gets a list of all supported languages and a list of all supported regions.", + "operationId": "System_GetSupportedCultures", + "responses": { + "200": { + "description": "Returns an object with a list of all supported languages and a separate list of supported regions.", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/SupportedCultures" + } }, - "additionalProperties": false - }, - "UserLink": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int32" - }, - "name": { - "type": "string", - "nullable": true, - "readOnly": true - } + "application/json": { + "schema": { + "$ref": "#/components/schemas/SupportedCultures" + } }, - "additionalProperties": false, - "readOnly": true - }, - "UserLocaleInfo": { - "type": "object", - "properties": { - "localeId": { - "type": "string", - "nullable": true - }, - "languageId": { - "type": "string", - "nullable": true - }, - "languageCode": { - "type": "string", - "nullable": true - }, - "fullDateTimeFormat": { - "type": "string", - "nullable": true - }, - "shortDateTimeFormat": { - "type": "string", - "nullable": true - }, - "longDateFormat": { - "type": "string", - "nullable": true - }, - "longTimeFormat": { - "type": "string", - "nullable": true - }, - "shortDateFormat": { - "type": "string", - "nullable": true - }, - "shortTimeFormat": { - "type": "string", - "nullable": true - }, - "amDesignator": { - "type": "string", - "nullable": true - }, - "pmDesignator": { - "type": "string", - "nullable": true - }, - "dayNames": { - "nullable": true - }, - "shortDayNames": { - "nullable": true - }, - "shortestDayNames": { - "nullable": true - }, - "firstDayOfWeek": { - "type": "string", - "nullable": true - }, - "monthNames": { - "nullable": true - }, - "shortMonthNames": { - "nullable": true - } + "text/json": { + "schema": { + "$ref": "#/components/schemas/SupportedCultures" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } }, - "additionalProperties": false + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/Users": { + "get": { + "tags": [ + "Users" + ], + "summary": "Gets a list of all users in the system.", + "operationId": "Users_Get", + "responses": { + "200": { + "description": "Returns a list of users.", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } }, - "WindowsParameters": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/IdentityProviderParameters" - } - ], - "additionalProperties": false + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/Users/{id}": { + "get": { + "tags": [ + "Users" + ], + "summary": "Gets the user with the given ID.", + "operationId": "Users_GetById", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The ID of the user to retrieve.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Returns the requested user.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "404": { + "description": "The user does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "put": { + "tags": [ + "Users" + ], + "summary": "Updates an existing user.", + "operationId": "Users_Update", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The ID of the user to update.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "requestBody": { + "description": "The new data of the user.", + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "responses": { + "200": { + "description": "Returns the updated user.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "404": { + "description": "The user does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Users" + ], + "summary": "Permanently deletes an existing user.", + "description": "Note that deleted users will automatically be recreated if they log into Access Management afterwards.\r\nTo completely remove users, first remove them from the external identity provider.", + "operationId": "Users_Delete", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The ID of the user to delete.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "204": { + "description": "The user was successfully deleted." + }, + "404": { + "description": "The user does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/Users/{id}/deactivate": { + "put": { + "tags": [ + "Users" + ], + "summary": "Deactivates a user, so they can no longer log in.", + "operationId": "Users_DeactivateUser", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The ID of the user to deactivate.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "The user was successfully deactivated." + }, + "404": { + "description": "The user does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/Users/{id}/activate": { + "put": { + "tags": [ + "Users" + ], + "summary": "Re-activates a deactivated user so they can log in again.", + "operationId": "Users_ActivateUser", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The ID of the user to activate.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "The user was successfully activated." + }, + "404": { + "description": "The user does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v1/Users/{userId}/generateClientSecret": { + "post": { + "tags": [ + "Users" + ], + "summary": "Generates a new client secret that can be used to log in as a given user.\r\n(Client secrets for users are deprecated. Please use service accounts instead.)", + "operationId": "Users_GenerateClientSecret", + "parameters": [ + { + "name": "userId", + "in": "path", + "description": "The ID of the user.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Returns the new client secret.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserClientSecret" + } + } + } + }, + "404": { + "description": "The user does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } } + }, + "deprecated": true } + }, + "/api/v1/Users/{userId}/clientSecrets/{secretId}": { + "put": { + "tags": [ + "Users" + ], + "summary": "Updates an existing client secret.\r\n(Client secrets for users are deprecated. Please use service accounts instead.)", + "operationId": "Users_UpdateClientSecret", + "parameters": [ + { + "name": "userId", + "in": "path", + "description": "The ID of the user.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "secretId", + "in": "path", + "description": "The ID of the secret to update.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "requestBody": { + "description": "The new data of the client secret.", + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/UserClientSecret" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserClientSecret" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserClientSecret" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UserClientSecret" + } + } + } + }, + "responses": { + "200": { + "description": "Returns the updated client secret.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserClientSecret" + } + } + } + }, + "404": { + "description": "The user or client secret does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "deprecated": true + }, + "delete": { + "tags": [ + "Users" + ], + "summary": "Permanently deletes an existing client secret from a user.\r\n(Client secrets for users are deprecated. Please use service accounts instead.)", + "operationId": "Users_DeleteClientSecret", + "parameters": [ + { + "name": "userId", + "in": "path", + "description": "The ID of the user.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "secretId", + "in": "path", + "description": "The ID of the secret to delete.", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "204": { + "description": "The client secret was successfully deleted." + }, + "404": { + "description": "The user or client secret does not exist.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "400": { + "description": "A validation error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "An unexpected error occurred.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + }, + "deprecated": true + } + } }, - "tags": [ - { - "name": "ApiResources", - "description": "API resources represent the services and roles that can be associated with an identity provider or user." + "components": { + "schemas": { + "ApiResource": { + "required": [ + "key", + "name" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "key": { + "maxLength": 256, + "minLength": 1, + "pattern": "^[a-zA-Z0-9-_.]*$", + "type": "string" + }, + "name": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "roles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiResourceRole" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "ApiResourceLink": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false + }, + "ApiResourceRole": { + "required": [ + "key", + "name" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "key": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "name": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "apiResource": { + "$ref": "#/components/schemas/ApiResource" + } + }, + "additionalProperties": false + }, + "ApiResourceRoleLink": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false + }, + "Application": { + "required": [ + "allowedAuthenticationFlowType", + "clientId", + "name", + "redirectUrls" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Autogenerated Id.Readonly on Update", + "format": "int32", + "readOnly": true + }, + "createdBy": { + "$ref": "#/components/schemas/UserLink" + }, + "modifiedBy": { + "$ref": "#/components/schemas/UserLink" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "clientId": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "name": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "redirectUrls": { + "type": "array", + "items": { + "type": "string" + } + }, + "allowedAuthenticationFlowType": { + "$ref": "#/components/schemas/AuthenticationFlowType" + } + }, + "additionalProperties": false + }, + "ApplicationLink": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false + }, + "AuditLog": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Autogenerated Id.", + "format": "int32", + "readOnly": true + }, + "user": { + "$ref": "#/components/schemas/Link" + }, + "date": { + "type": "string", + "format": "date-time" + }, + "entityType": { + "type": "string", + "nullable": true + }, + "entity": { + "$ref": "#/components/schemas/Link" + }, + "action": { + "$ref": "#/components/schemas/EntityActionType" + } + }, + "additionalProperties": false + }, + "AuditLogEntry": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Autogenerated Id.", + "format": "int32", + "readOnly": true + }, + "user": { + "$ref": "#/components/schemas/Link" + }, + "date": { + "type": "string", + "format": "date-time" + }, + "entityType": { + "type": "string", + "nullable": true + }, + "entityId": { + "type": "integer", + "format": "int32" + }, + "entityData": { + "nullable": true + }, + "action": { + "$ref": "#/components/schemas/EntityActionType" + } + }, + "additionalProperties": false + }, + "AuthenticationFlowType": { + "enum": [ + "AuthorizationCodeWithPkce", + "AuthorizationCode", + "Implicit" + ], + "type": "string" + }, + "ClaimBasedAccessControlEntry": { + "type": "object", + "properties": { + "applications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationLink" + }, + "nullable": true + }, + "apiResources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiResourceLink" + }, + "nullable": true + }, + "apiResourceRoles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiResourceRoleLink" + }, + "nullable": true + }, + "claimType": { + "maxLength": 256, + "type": "string", + "description": "Gets or sets Claim type coming from the IdP.", + "nullable": true + }, + "claimValue": { + "maxLength": 256, + "type": "string", + "description": "Gets or sets Claim value coming from the IdP.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents idp claim access control for applications , resources and roles." + }, + "EntityActionType": { + "enum": [ + "Deleted", + "Updated", + "Added", + "Activated", + "Deactivated" + ], + "type": "string" + }, + "ErrorMessage": { + "type": "object", + "properties": { + "code": { + "type": "string", + "nullable": true + }, + "message": { + "type": "string", + "nullable": true + }, + "localizedMessage": { + "type": "string", + "nullable": true + }, + "target": { + "type": "string", + "nullable": true + }, + "details": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ErrorMessage" + }, + "nullable": true + }, + "innerError": { + "$ref": "#/components/schemas/IInnerError" + }, + "stackTrace": { + "type": "string", + "nullable": true + }, + "innerException": { + "$ref": "#/components/schemas/ErrorMessage" + } + }, + "additionalProperties": false + }, + "ErrorResponse": { + "type": "object", + "properties": { + "errorMessage": { + "$ref": "#/components/schemas/ErrorMessage" + } + }, + "additionalProperties": false + }, + "IInnerError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "nullable": true + }, + "innerError": { + "$ref": "#/components/schemas/IInnerError" + } + }, + "additionalProperties": false + }, + "IdentityProvider": { + "required": [ + "key", + "name", + "parameters", + "type" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Autogenerated Id.", + "format": "int32", + "readOnly": true + }, + "createdBy": { + "$ref": "#/components/schemas/UserLink" + }, + "modifiedBy": { + "$ref": "#/components/schemas/UserLink" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "key": { + "maxLength": 64, + "minLength": 1, + "pattern": "^[a-zA-Z0-9_]*$", + "type": "string", + "description": "Provider name.Readonly on Update" + }, + "name": { + "maxLength": 256, + "minLength": 1, + "type": "string", + "description": "Provider display name." + }, + "isEnabled": { + "type": "boolean", + "description": "Specifies if provider is enabled.", + "default": true + }, + "description": { + "maxLength": 2048, + "type": "string", + "description": "Provider description.", + "nullable": true + }, + "type": { + "$ref": "#/components/schemas/IdentityProviderType" + }, + "iconUrl": { + "type": "string", + "description": "The external URL of the icon to use for this provider.", + "nullable": true + }, + "iconViewUrl": { + "type": "string", + "description": "The URL to view the icon for this provider.", + "nullable": true, + "readOnly": true + }, + "accessControlList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ClaimBasedAccessControlEntry" + }, + "description": "Access Control List", + "nullable": true + }, + "forwardedClaims": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Forwarded Claims", + "nullable": true + }, + "parameters": { + "$ref": "#/components/schemas/IdentityProviderParameters" + }, + "redirectUrl": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "postLogoutRedirectUrl": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "validateUrl": { + "type": "string", + "description": "Gets or sets the URL to use to validate that this Tridion.AccessManagement.Model.V1.IdentityProvider is configured correctly.", + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false, + "description": "Represents the identity provider." + }, + "IdentityProviderLink": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false, + "description": "Readonly on Update" + }, + "IdentityProviderParameters": { + "type": "object", + "anyOf": [ + { + "$ref": "#/components/schemas/LdapParameters" + }, + { + "$ref": "#/components/schemas/OpenIdParameters" + }, + { + "$ref": "#/components/schemas/SamlParameters" + }, + { + "$ref": "#/components/schemas/WindowsParameters" + } + ], + "properties": { + "$type": { + "type": "string", + "readOnly": true + } + }, + "additionalProperties": false, + "discriminator": { + "propertyName": "$type" + } + }, + "IdentityProviderType": { + "enum": [ + "OpenIdConnect", + "SAML2P", + "LDAP", + "Windows" + ], + "type": "string", + "description": "Readonly on Update", + "readOnly": true + }, + "IdentityProviderTypeOption": { + "type": "object", + "properties": { + "typeId": { + "$ref": "#/components/schemas/IdentityProviderType" + }, + "name": { + "type": "string", + "description": "Localized human readable name.", + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false, + "description": "Represents the Identity provider type option description." + }, + "LdapParameters": { + "required": [ + "fullNameClaim", + "port", + "searchAccount", + "searchAccountPassword", + "serverAddress", + "userBaseDn", + "usernameClaim", + "useSsl" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/IdentityProviderParameters" + } + ], + "properties": { + "separator": { + "maxLength": 1, + "type": "string", + "description": "Separator to join IdP name and username.", + "nullable": true + }, + "usernameClaim": { + "maxLength": 256, + "minLength": 1, + "type": "string", + "description": "Provider claim type to use for username." + }, + "fullNameClaim": { + "maxLength": 256, + "minLength": 1, + "type": "string", + "description": "Provider claim type to use for Full name." + }, + "serverAddress": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "port": { + "type": "integer", + "format": "int32" + }, + "useSsl": { + "type": "boolean" + }, + "searchAccount": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "searchAccountPassword": { + "maxLength": 256, + "minLength": 1, + "type": "string", + "format": "password" + }, + "userBaseDn": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "groupBaseDn": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "groupMemberAttribute": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "additionalAttributes": { + "maxLength": 256, + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "Link": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "LoginOption": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "key": { + "type": "string", + "nullable": true + }, + "loginTriggerUrl": { + "type": "string", + "nullable": true + }, + "iconUrl": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "LoginStatus": { + "enum": [ + "None", + "Anonymous", + "LoggedIn" + ], + "type": "string" + }, + "OpenIdParameters": { + "required": [ + "authority", + "clientId", + "fullNameClaim", + "usernameClaim" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/IdentityProviderParameters" + } + ], + "properties": { + "separator": { + "maxLength": 1, + "type": "string", + "description": "Separator to join IdP name and username.", + "nullable": true + }, + "usernameClaim": { + "maxLength": 256, + "minLength": 1, + "type": "string", + "description": "Provider claim type to use for username." + }, + "fullNameClaim": { + "maxLength": 256, + "minLength": 1, + "type": "string", + "description": "Provider claim type to use for Full name." + }, + "authority": { + "maxLength": 256, + "minLength": 1, + "type": "string", + "format": "uri" + }, + "clientId": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "clientSecret": { + "maxLength": 256, + "type": "string", + "format": "password", + "nullable": true + }, + "endSessionEndpoint": { + "maxLength": 256, + "type": "string", + "format": "uri", + "nullable": true + }, + "additionalScopes": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "responseType": { + "maxLength": 256, + "type": "string", + "default": "id_token", + "nullable": true + }, + "sendIdTokenHintDuringLogout": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "SamlParameters": { + "required": [ + "certificates", + "fullNameClaim", + "issuerName", + "serviceProviderName", + "singleLogoutServiceUrl", + "singleSignOnServiceUrl", + "usernameClaim" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/IdentityProviderParameters" + } + ], + "properties": { + "separator": { + "maxLength": 1, + "type": "string", + "description": "Separator to join IdP name and username.", + "nullable": true + }, + "usernameClaim": { + "maxLength": 256, + "minLength": 1, + "type": "string", + "description": "Provider claim type to use for username." + }, + "fullNameClaim": { + "maxLength": 256, + "minLength": 1, + "type": "string", + "description": "Provider claim type to use for Full name." + }, + "issuerName": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "serviceProviderName": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "singleSignOnServiceUrl": { + "maxLength": 256, + "minLength": 1, + "type": "string", + "format": "uri" + }, + "singleLogoutServiceUrl": { + "maxLength": 256, + "minLength": 1, + "type": "string", + "format": "uri" + }, + "certificates": { + "minItems": 1, + "type": "array", + "items": { + "type": "string" + } + } + }, + "additionalProperties": false + }, + "ServiceAccount": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Autogenerated Id.", + "format": "int32", + "readOnly": true + }, + "createdBy": { + "$ref": "#/components/schemas/UserLink" + }, + "modifiedBy": { + "$ref": "#/components/schemas/UserLink" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "name": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "clientId": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "lastLoginAt": { + "type": "string", + "format": "date-time", + "nullable": true, + "readOnly": true + }, + "clientSecrets": { + "maxItems": 2, + "type": "array", + "items": { + "$ref": "#/components/schemas/UserClientSecret" + }, + "nullable": true, + "readOnly": true + }, + "accessControlEntry": { + "$ref": "#/components/schemas/ServiceAccountBasedAccessControlEntry" + } + }, + "additionalProperties": false + }, + "ServiceAccountBasedAccessControlEntry": { + "type": "object", + "properties": { + "apiResources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiResourceLink" + }, + "nullable": true + }, + "apiResourceRoles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiResourceRoleLink" + }, + "nullable": true + }, + "applications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationLink" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "SupportedCulture": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "nullable": true + }, + "name": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "SupportedCultures": { + "type": "object", + "properties": { + "languages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SupportedCulture" + }, + "nullable": true, + "readOnly": true + }, + "regions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SupportedCulture" + }, + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false }, - { - "name": "Applications", - "description": "Applications that are secured by Access Management." + "User": { + "required": [ + "identityProvider", + "identityProviderKey", + "name", + "subject" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Autogenerated Id.", + "format": "int32", + "readOnly": true + }, + "createdBy": { + "$ref": "#/components/schemas/UserLink" + }, + "modifiedBy": { + "$ref": "#/components/schemas/UserLink" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "name": { + "maxLength": 256, + "minLength": 1, + "type": "string" + }, + "email": { + "maxLength": 256, + "type": "string", + "format": "email", + "nullable": true + }, + "language": { + "maxLength": 20, + "type": "string", + "nullable": true + }, + "region": { + "maxLength": 20, + "type": "string", + "nullable": true + }, + "subject": { + "maxLength": 256, + "minLength": 1, + "type": "string", + "description": "Readonly on Update" + }, + "identityProvider": { + "$ref": "#/components/schemas/IdentityProviderLink" + }, + "identityProviderKey": { + "maxLength": 256, + "minLength": 1, + "type": "string", + "description": "Readonly on Update" + }, + "clientId": { + "maxLength": 256, + "type": "string", + "description": "Readonly on Update", + "nullable": true, + "readOnly": true + }, + "isEnabled": { + "type": "boolean", + "default": true + }, + "lastLoginAt": { + "type": "string", + "format": "date-time", + "nullable": true, + "readOnly": true + }, + "clientSecrets": { + "maxItems": 2, + "type": "array", + "items": { + "$ref": "#/components/schemas/UserClientSecret" + }, + "nullable": true, + "readOnly": true + }, + "accessControlEntry": { + "$ref": "#/components/schemas/UserBasedAccessControlEntry" + } + }, + "additionalProperties": false }, - { - "name": "AuditLogs", - "description": "Audit logs store information about every action taken in Access Management." + "UserBasedAccessControlEntry": { + "type": "object", + "properties": { + "applications": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApplicationLink" + }, + "nullable": true + }, + "apiResources": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiResourceLink" + }, + "nullable": true + }, + "apiResourceRoles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiResourceRoleLink" + }, + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents user access control for applications , resources and roles." }, - { - "name": "IdentityProviders", - "description": "Identity providers allow you to log in with an account from an external system." + "UserClientSecret": { + "required": [ + "clientSecret", + "expiresAt" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Autogenerated Id.", + "format": "int32", + "readOnly": true + }, + "clientSecret": { + "maxLength": 4000, + "minLength": 1, + "type": "string", + "readOnly": true + }, + "expiresAt": { + "type": "string", + "format": "date-time" + }, + "lastLoginAt": { + "type": "string", + "format": "date-time", + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false }, - { - "name": "ServiceAccounts", - "description": "Service accounts are used to run various services and applications." + "UserInfo": { + "type": "object", + "properties": { + "name": { + "type": "string", + "nullable": true + }, + "subject": { + "type": "string", + "nullable": true + }, + "avatar": { + "type": "string", + "nullable": true + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + }, + "isAnonymous": { + "type": "boolean" + }, + "locale": { + "$ref": "#/components/schemas/UserLocaleInfo" + } + }, + "additionalProperties": false }, - { - "name": "System", - "description": "System-level operations that are not directly related to specific entities." + "UserLink": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "type": "string", + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false, + "readOnly": true }, - { - "name": "Users", - "description": "Non-service users within the system." + "UserLocaleInfo": { + "type": "object", + "properties": { + "localeId": { + "type": "string", + "nullable": true + }, + "languageId": { + "type": "string", + "nullable": true + }, + "languageCode": { + "type": "string", + "nullable": true + }, + "fullDateTimeFormat": { + "type": "string", + "nullable": true + }, + "shortDateTimeFormat": { + "type": "string", + "nullable": true + }, + "longDateFormat": { + "type": "string", + "nullable": true + }, + "longTimeFormat": { + "type": "string", + "nullable": true + }, + "shortDateFormat": { + "type": "string", + "nullable": true + }, + "shortTimeFormat": { + "type": "string", + "nullable": true + }, + "amDesignator": { + "type": "string", + "nullable": true + }, + "pmDesignator": { + "type": "string", + "nullable": true + }, + "dayNames": { + "nullable": true + }, + "shortDayNames": { + "nullable": true + }, + "shortestDayNames": { + "nullable": true + }, + "firstDayOfWeek": { + "type": "string", + "nullable": true + }, + "monthNames": { + "nullable": true + }, + "shortMonthNames": { + "nullable": true + } + }, + "additionalProperties": false + }, + "WindowsParameters": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/IdentityProviderParameters" + } + ], + "additionalProperties": false } + } + }, + "tags": [ + { + "name": "ApiResources", + "description": "API resources represent the services and roles that can be associated with an identity provider or user." + }, + { + "name": "Applications", + "description": "Applications that are secured by Access Management." + }, + { + "name": "AuditLogs", + "description": "Audit logs store information about every action taken in Access Management." + }, + { + "name": "IdentityProviders", + "description": "Identity providers allow you to log in with an account from an external system." + }, + { + "name": "ServiceAccounts", + "description": "Service accounts are used to run various services and applications." + }, + { + "name": "System", + "description": "System-level operations that are not directly related to specific entities." + }, + { + "name": "Users", + "description": "Non-service users within the system." + } ] } diff --git a/Source/ISHRemote/Trisoft.ISHRemote.OpenApiISH30/OpenApiISH30.json b/Source/ISHRemote/Trisoft.ISHRemote.OpenApiISH30/OpenApiISH30.json index ae950414..a19e77bd 100644 --- a/Source/ISHRemote/Trisoft.ISHRemote.OpenApiISH30/OpenApiISH30.json +++ b/Source/ISHRemote/Trisoft.ISHRemote.OpenApiISH30/OpenApiISH30.json @@ -1,90 +1,87 @@ { "openapi": "3.0.1", "info": { - "title": "InfoShare API v3.0.0 (20240404)", + "title": "InfoShare API v3.0.0 (20251210)", "contact": { "name": "RWS Support", - "url": "https://gateway.sdl.com/" + "url": "https://gateway.rws.com/" }, "version": "v3.0" }, "servers": [ { - "url": "https://ish.example.com/ISHWS/Api" + "url": "https://ish.example.com/ISHWS/api" } ], "paths": { - "/Application/Version": { - "get": { - "tags": [ - "Application" - ], - "summary": "Gets the version of the application server.", - "operationId": "GetApplicationVersion", - "responses": { - "200": { - "description": "Success", - "content": { - "text/plain": { - "schema": { - "type": "string" - } - } - } - } - } - } - }, - "/v3/BackgroundTasks": { + "/v3/Annotations": { "post": { "tags": [ - "BackgroundTasks" + "Annotations" ], - "summary": "Creates a new background task.", - "operationId": "CreateBackgroundTask", + "summary": "Creates an annotation.", + "operationId": "CreateAnnotation", "requestBody": { "content": { - "multipart/form-data": { + "application/json": { "schema": { - "type": "object", - "properties": { - "inputdata": { - "type": "string", - "format": "binary", - "nullable": true - }, - "metadata": { - "allOf": [ - { - "$ref": "#/components/schemas/CreateBackgroundTask" - } - ] + "allOf": [ + { + "$ref": "#/components/schemas/CreateAnnotation" } - } - }, - "encoding": { - "inputdata": { - "style": "form" - }, - "metadata": { - "style": "form" - } + ], + "description": "Represents a create annotation model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateAnnotation" + } + ], + "description": "Represents a create annotation model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateAnnotation" + } + ], + "description": "Represents a create annotation model." } } } }, "responses": { "201": { - "description": "Success", + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BackgroundTask" + "$ref": "#/components/schemas/Annotation" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/BackgroundTask" + "$ref": "#/components/schemas/Annotation" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" } } } @@ -104,8 +101,8 @@ } } }, - "403": { - "description": "Forbidden", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -135,31 +132,48 @@ } } } - }, - "get": { + } + }, + "/v3/Annotations/ByAnnotationId/{AnnotationId}": { + "delete": { "tags": [ - "BackgroundTasks" + "Annotations" + ], + "summary": "Deletes the annotation with the specified annotation ID.", + "operationId": "DeleteAnnotationByAnnotationId", + "parameters": [ + { + "name": "AnnotationId", + "in": "path", + "description": "The annotation identifier.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The annotation identifier." + } + } ], - "summary": "Gets background task. - NOT IMPLEMENTED.", - "operationId": "GetBackgroundTaskById", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BackgroundTask" + "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/BackgroundTask" + "$ref": "#/components/schemas/Message" } } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -188,6 +202,21 @@ } } }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, "default": { "description": "Error", "content": { @@ -204,68 +233,105 @@ } } } - } - }, - "/v3/Baselines/Get": { - "post": { + }, + "get": { "tags": [ - "Baselines" + "Annotations" ], - "summary": "Gets all baselines in the repository that match the criteria given in the parameters.", - "operationId": "GetBaselineList", - "requestBody": { - "description": "Request object with the criteria in its properties.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/GetBaselineList" - } - ], - "description": "Request object to get all baselines in the repository that match the criteria given in the properties." - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/GetBaselineList" - } - ], - "description": "Request object to get all baselines in the repository that match the criteria given in the properties." - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/GetBaselineList" - } - ], - "description": "Request object to get all baselines in the repository that match the criteria given in the properties." - } + "summary": "Gets the annotation with the specified annotation ID.", + "operationId": "GetAnnotationByAnnotationId", + "parameters": [ + { + "name": "AnnotationId", + "in": "path", + "description": "The identifier of the annotation.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the annotation." + } + }, + { + "name": "SelectedProperties", + "in": "query", + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + } + }, + { + "name": "FieldGroup", + "in": "query", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + } + }, + { + "name": "Field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + } + }, + { + "name": "IncludeLinks", + "in": "query", + "description": "true to include the links; otherwise, false. Default is false.", + "schema": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false } } - }, + ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Baseline" - } + "$ref": "#/components/schemas/Annotation" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Baseline" - } + "$ref": "#/components/schemas/Annotation" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" } } } @@ -301,57 +367,59 @@ } } } - } - }, - "/v3/Baselines/{id}/Report/Complete": { - "post": { + }, + "put": { "tags": [ - "Baselines" + "Annotations" ], - "summary": "Expands and completes the baseline starting from the incoming logicalIds using the extend baseline and/or the autocomplete mode.", - "operationId": "CompleteBaseline", + "summary": "Updates the annotation with the specified annotation ID.", + "operationId": "UpdateAnnotationByAnnotationId", "parameters": [ { - "name": "id", + "name": "AnnotationId", "in": "path", - "description": "Specify the element name of the Baseline.", + "description": "The annotation identifier.", "required": true, "schema": { - "type": "string" + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The annotation identifier." } } ], "requestBody": { - "description": "Parameters which will be used to expand and complete the baseline starting from the incoming logicalIds using the extend baseline and/or the autocomplete mode.", + "description": "Request object with the criteria in its properties.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CompleteBaseline" + "$ref": "#/components/schemas/UpdateAnnotationByAnnotationId" } ], - "description": "The model contains the parameters which will be used to expand and complete the baseline starting from the incoming logicalIds using the extend baseline and/or the autocomplete mode." + "description": "Represents an update annotation model." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CompleteBaseline" + "$ref": "#/components/schemas/UpdateAnnotationByAnnotationId" } ], - "description": "The model contains the parameters which will be used to expand and complete the baseline starting from the incoming logicalIds using the extend baseline and/or the autocomplete mode." + "description": "Represents an update annotation model." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CompleteBaseline" + "$ref": "#/components/schemas/UpdateAnnotationByAnnotationId" } ], - "description": "The model contains the parameters which will be used to expand and complete the baseline starting from the incoming logicalIds using the extend baseline and/or the autocomplete mode." + "description": "Represents an update annotation model." } } } @@ -362,24 +430,18 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BaselineReportEntry" - } + "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BaselineReportEntry" - } + "$ref": "#/components/schemas/Message" } } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -408,6 +470,36 @@ } } }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, "default": { "description": "Error", "content": { @@ -426,83 +518,46 @@ } } }, - "/v3/Baselines/{id}/Report/Expand": { - "post": { + "/v3/Annotations/ByReplyCardId/{ReplyCardId}": { + "delete": { "tags": [ - "Baselines" + "Annotations" ], - "summary": "Expands baseline reports in the repository that match the criteria given in the parameters.", - "operationId": "ExpandBaseline", + "summary": "Deletes the annotation reply with the specified reply card ID.", + "operationId": "DeleteAnnotationByReplyCardId", "parameters": [ { - "name": "id", + "name": "ReplyCardId", "in": "path", - "description": "The identifier of the baseline.", + "description": "Reply card identifier.", "required": true, "schema": { - "type": "string" + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "Reply card identifier.", + "format": "int64" } } ], - "requestBody": { - "description": "Request object with the criteria in its properties.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/ExpandBaseline" - } - ], - "description": "Represents a ExpandBaseline." - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/ExpandBaseline" - } - ], - "description": "Represents a ExpandBaseline." - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/ExpandBaseline" - } - ], - "description": "Represents a ExpandBaseline." - } - } - } - }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BaselineReportEntry" - } + "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BaselineReportEntry" - } + "$ref": "#/components/schemas/Message" } } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -531,6 +586,21 @@ } } }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, "default": { "description": "Error", "content": { @@ -547,69 +617,105 @@ } } } - } - }, - "/v3/DocumentObjects/ByLogicalId/Get": { - "post": { + }, + "get": { "tags": [ - "DocumentObjects" + "Annotations" ], - "summary": "Gets all document objects in the Repository that match the criteria given in the parameters.", - "description": "Depending on which status filter is specified, the objects with following status types can be returned:\r\n
Status filterReturned status types
AllAll status types
LatestReleasedLatest released excluding out-of-date
DraftOrLatestReleasedDraft and latest released excluding out-of-date
AllReleasedAll released including out-of-date
", - "operationId": "GetDocumentObjectListByLogicalId", - "requestBody": { - "description": "Request object with the criteria in its properties.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/GetDocumentObjectListByLogicalId" - } - ], - "description": "Request object to get all objects in the repository that match the criteria given in the properties." - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/GetDocumentObjectListByLogicalId" - } - ], - "description": "Request object to get all objects in the repository that match the criteria given in the properties." - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/GetDocumentObjectListByLogicalId" - } - ], - "description": "Request object to get all objects in the repository that match the criteria given in the properties." - } + "summary": "Gets the annotation reply with the specified reply card ID.", + "operationId": "GetAnnotationByReplyCardId", + "parameters": [ + { + "name": "ReplyCardId", + "in": "path", + "description": "Reply card identifier.", + "required": true, + "schema": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "Reply card identifier.", + "format": "int64" + } + }, + { + "name": "SelectedProperties", + "in": "query", + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + } + }, + { + "name": "FieldGroup", + "in": "query", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + } + }, + { + "name": "Field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + } + }, + { + "name": "IncludeLinks", + "in": "query", + "description": "true to include the links; otherwise, false. Default is false.", + "schema": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false } } - }, + ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentObject" - } + "$ref": "#/components/schemas/Annotation" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentObject" - } + "$ref": "#/components/schemas/Annotation" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" } } } @@ -645,16 +751,28 @@ } } } - } - }, - "/v3/DocumentObjects/Get": { - "post": { + }, + "put": { "tags": [ - "DocumentObjects" + "Annotations" + ], + "summary": "Updates the annotation reply with the specified reply card ID.", + "operationId": "UpdateAnnotationByReplyCardId", + "parameters": [ + { + "name": "ReplyCardId", + "in": "path", + "description": "Reply card identifier.", + "required": true, + "schema": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "Reply card identifier.", + "format": "int64" + } + } ], - "summary": "Gets all document objects in the Repository that match the criteria given in the parameters.", - "description": "Depending on which status filter is specified, the objects with following status types can be returned:\r\n
Status filterReturned status types
AllAll status types
LatestReleasedLatest released excluding out-of-date
DraftOrLatestReleasedDraft and latest released excluding out-of-date
AllReleasedAll released including out-of-date
", - "operationId": "GetDocumentObjectList", "requestBody": { "description": "Request object with the criteria in its properties.", "content": { @@ -662,30 +780,30 @@ "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetDocumentObjectList" + "$ref": "#/components/schemas/UpdateAnnotationByReplyCardId" } ], - "description": "Request object to get all objects in the repository that match the criteria given in the properties." + "description": "Represents an update annotation reply model." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetDocumentObjectList" + "$ref": "#/components/schemas/UpdateAnnotationByReplyCardId" } ], - "description": "Request object to get all objects in the repository that match the criteria given in the properties." + "description": "Represents an update annotation reply model." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetDocumentObjectList" + "$ref": "#/components/schemas/UpdateAnnotationByReplyCardId" } ], - "description": "Request object to get all objects in the repository that match the criteria given in the properties." + "description": "Represents an update annotation reply model." } } } @@ -696,18 +814,57 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentObject" - } + "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentObject" - } + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" } } } @@ -745,88 +902,66 @@ } } }, - "/v3/DocumentObjects/ByLanguageCardId/Get": { + "/v3/Annotations/Replies": { "post": { "tags": [ - "DocumentObjects" + "Annotations" ], - "summary": "Gets all document objects in the Repository that match the criteria given in the parameters.", - "description": "Depending on which status filter is specified, the objects with following status types can be returned:\r\n
Status filterReturned status types
AllAll status types
LatestReleasedLatest released excluding out-of-date
DraftOrLatestReleasedDraft and latest released excluding out-of-date
AllReleasedAll released including out-of-date
", - "operationId": "GetDocumentObjectListByLanguageCardId", + "summary": "Creates an annotation reply.", + "operationId": "CreateAnnotationReply", "requestBody": { - "description": "Request object with the criteria in its properties.", + "description": "The create annotation reply model.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetDocumentObjectListByLanguageCardId" + "$ref": "#/components/schemas/CreateAnnotationReply" } ], - "description": "Request object to get all objects in the repository that match the criteria given in the properties." + "description": "Represents a create annotation reply model." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetDocumentObjectListByLanguageCardId" + "$ref": "#/components/schemas/CreateAnnotationReply" } ], - "description": "Request object to get all objects in the repository that match the criteria given in the properties." + "description": "Represents a create annotation reply model." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetDocumentObjectListByLanguageCardId" + "$ref": "#/components/schemas/CreateAnnotationReply" } ], - "description": "Request object to get all objects in the repository that match the criteria given in the properties." + "description": "Represents a create annotation reply model." } } } }, "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentObject" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentObject" - } - } - } - } - }, - "400": { - "description": "Bad Request", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "$ref": "#/components/schemas/Annotation" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "$ref": "#/components/schemas/Annotation" } } } }, - "default": { - "description": "Error", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -839,112 +974,6 @@ } } } - } - } - } - }, - "/v3/DocumentObjects/ByLogicalId/{logicalId}": { - "get": { - "tags": [ - "DocumentObjects" - ], - "summary": "Gets the document object by combination of it logical identifier, version and language.", - "operationId": "GetDocumentObjectByLogicalId", - "parameters": [ - { - "name": "logicalId", - "in": "path", - "description": "Logical identifier of the document object.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "version", - "in": "query", - "description": "Version of the document object.", - "schema": { - "type": "string" - } - }, - { - "name": "language", - "in": "query", - "description": "The language of a document object.", - "schema": { - "type": "string" - } - }, - { - "name": "resolution", - "in": "query", - "description": "The resolution of an illustration.", - "schema": { - "type": "string" - } - }, - { - "name": "selectedProperties", - "in": "query", - "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectedProperties" - } - ], - "description": "Enumeration holding the selected properties." - } - }, - { - "name": "fieldGroup", - "in": "query", - "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/FieldGroup" - } - ], - "description": "Groups of metadata fields." - } - }, - { - "name": "field", - "in": "query", - "description": "Specifies one or more metadata fields to return.", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "includeLinks", - "in": "query", - "description": "true to include the links; otherwise, false. Default is false.", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/DocumentObject" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/DocumentObject" - } - } - } }, "400": { "description": "Bad Request", @@ -961,8 +990,8 @@ } } }, - "404": { - "description": "Not Found", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -992,48 +1021,15 @@ } } } - }, - "put": { + } + }, + "/v3/Annotations/ByAnnotationId/Get": { + "post": { "tags": [ - "DocumentObjects" - ], - "summary": "Updates the document object by its logical identifier.", - "operationId": "UpdateDocumentObjectByLogicalId", - "parameters": [ - { - "name": "logicalId", - "in": "path", - "description": "Logical id of the document object.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "version", - "in": "query", - "description": "The version of the document to update.", - "schema": { - "type": "string" - } - }, - { - "name": "language", - "in": "query", - "description": "The language of the document to update.", - "schema": { - "type": "string" - } - }, - { - "name": "resolution", - "in": "query", - "description": "The resolution of the document to update.", - "schema": { - "type": "string" - } - } + "Annotations" ], + "summary": "Gets the set of annotations with the specified set of annotation IDs (and matching possible additional filter criteria).", + "operationId": "GetAnnotationListByAnnotationId", "requestBody": { "description": "Request object with the criteria in its properties.", "content": { @@ -1041,30 +1037,30 @@ "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdateDocumentObject" + "$ref": "#/components/schemas/GetAnnotationListByAnnotationId" } ], - "description": "Represents a document." + "description": "Request object to get all objects in the repository that match the criteria given in the properties." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdateDocumentObject" + "$ref": "#/components/schemas/GetAnnotationListByAnnotationId" } ], - "description": "Represents a document." + "description": "Request object to get all objects in the repository that match the criteria given in the properties." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdateDocumentObject" + "$ref": "#/components/schemas/GetAnnotationListByAnnotationId" } ], - "description": "Represents a document." + "description": "Request object to get all objects in the repository that match the criteria given in the properties." } } } @@ -1075,12 +1071,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/Annotation" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/Annotation" + } } } } @@ -1100,38 +1102,8 @@ } } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, - "default": { - "description": "Error", + "default": { + "description": "Error", "content": { "application/json": { "schema": { @@ -1146,79 +1118,46 @@ } } } - }, - "delete": { + } + }, + "/v3/Annotations/Get": { + "post": { "tags": [ - "DocumentObjects" - ], - "summary": "Deletes a document object by its logical identifier.", - "operationId": "DeleteDocumentObjectByLogicalId", - "parameters": [ - { - "name": "logicalId", - "in": "path", - "description": "Logical identifier of the document object to delete.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "version", - "in": "query", - "description": "The version of the document to delete.", - "schema": { - "type": "string" - } - }, - { - "name": "language", - "in": "query", - "description": "The language of the document to delete.", - "schema": { - "type": "string" - } - }, - { - "name": "resolution", - "in": "query", - "description": "The resolution of the document to delete.", - "schema": { - "type": "string" - } - } + "Annotations" ], + "summary": "Gets a list of annotations that match the provided filter criteria.", + "operationId": "GetAnnotationList", "requestBody": { - "description": "The parameters that will be used for delete operation.", + "description": "Request object with the criteria in its properties.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/DeleteDocumentObjectByLogicalId" + "$ref": "#/components/schemas/GetAnnotationList" } ], - "description": "Request object to delete document object." + "description": "Request object to get all annotations in the repository that match the criteria given in the properties." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/DeleteDocumentObjectByLogicalId" + "$ref": "#/components/schemas/GetAnnotationList" } ], - "description": "Request object to delete document object." + "description": "Request object to get all annotations in the repository that match the criteria given in the properties." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/DeleteDocumentObjectByLogicalId" + "$ref": "#/components/schemas/GetAnnotationList" } ], - "description": "Request object to delete document object." + "description": "Request object to get all annotations in the repository that match the criteria given in the properties." } } } @@ -1229,12 +1168,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/Annotation" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/Annotation" + } } } } @@ -1254,8 +1199,8 @@ } } }, - "403": { - "description": "Forbidden", + "default": { + "description": "Error", "content": { "application/json": { "schema": { @@ -1268,116 +1213,100 @@ } } } - }, - "404": { - "description": "Not Found", + } + } + } + }, + "/Application/Version": { + "get": { + "tags": [ + "Application" + ], + "summary": "Gets the version of the application server.", + "operationId": "GetApplicationVersion", + "responses": { + "200": { + "description": "Success", "content": { - "application/json": { + "text/plain": { "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "type": "string" + } + } + } + } + } + } + }, + "/v3/BackgroundTasks": { + "post": { + "tags": [ + "BackgroundTasks" + ], + "summary": "Creates a background task.", + "operationId": "CreateBackgroundTask", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "required": [ + "metadata" + ], + "type": "object", + "properties": { + "inputData": { + "type": "string", + "format": "binary", + "nullable": true + }, + "metadata": { + "type": "CreateBackgroundTask", + "allOf": [ + { + "$ref": "#/components/schemas/CreateBackgroundTask" + } + ] + } } }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "encoding": { + "inputData": { + "style": "form" + }, + "metadata": { + "style": "form" } } } - }, - "default": { - "description": "Error", + } + }, + "responses": { + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "$ref": "#/components/schemas/BackgroundTask" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - } - } - } - }, - "/v3/DocumentObjects/ByLanguageCardId/{languageCardId}": { - "get": { - "tags": [ - "DocumentObjects" - ], - "summary": "Gets the document object by its language card identifier.", - "operationId": "GetDocumentObjectByLanguageCardId", - "parameters": [ - { - "name": "languageCardId", - "in": "path", - "description": "Language card identifier of the document object.", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "selectedProperties", - "in": "query", - "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectedProperties" - } - ], - "description": "Enumeration holding the selected properties." - } - }, - { - "name": "fieldGroup", - "in": "query", - "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/FieldGroup" + "$ref": "#/components/schemas/BackgroundTask" } - ], - "description": "Groups of metadata fields." - } - }, - { - "name": "field", - "in": "query", - "description": "Specifies one or more metadata fields to return.", - "schema": { - "type": "array", - "items": { - "type": "string" } } }, - { - "name": "includeLinks", - "in": "query", - "description": "true to include the links; otherwise, false. Default is false.", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "Success", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentObject" + "$ref": "#/components/schemas/InfoShareProblemDetails" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/DocumentObject" + "$ref": "#/components/schemas/InfoShareProblemDetails" } } } @@ -1397,8 +1326,8 @@ } } }, - "404": { - "description": "Not Found", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -1428,25 +1357,15 @@ } } } - }, - "put": { + } + }, + "/v3/BackgroundTasks/Get": { + "post": { "tags": [ - "DocumentObjects" - ], - "summary": "Updates the document object by its language card identifier.", - "operationId": "UpdateDocumentObjectByLanguageCardId", - "parameters": [ - { - "name": "languageCardId", - "in": "path", - "description": "Language card identifier of the document object.", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } + "BackgroundTasks" ], + "summary": "Gets the set of background tasks that match the provided filter criteria.", + "operationId": "GetBackgroundTaskList", "requestBody": { "description": "Request object with the criteria in its properties.", "content": { @@ -1454,30 +1373,30 @@ "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdateDocumentObject" + "$ref": "#/components/schemas/GetBackgroundTaskList" } ], - "description": "Represents a document." + "description": "Request object to get all background tasks in the repository that match the criteria given in the properties." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdateDocumentObject" + "$ref": "#/components/schemas/GetBackgroundTaskList" } ], - "description": "Represents a document." + "description": "Request object to get all background tasks in the repository that match the criteria given in the properties." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdateDocumentObject" + "$ref": "#/components/schemas/GetBackgroundTaskList" } ], - "description": "Represents a document." + "description": "Request object to get all background tasks in the repository that match the criteria given in the properties." } } } @@ -1488,12 +1407,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/BackgroundTask" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/BackgroundTask" + } } } } @@ -1513,36 +1438,6 @@ } } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, "default": { "description": "Error", "content": { @@ -1559,93 +1454,88 @@ } } } - }, - "delete": { + } + }, + "/v3/BackgroundTasks/{TaskId}": { + "get": { "tags": [ - "DocumentObjects" + "BackgroundTasks" ], - "summary": "Deletes a document object by its language card identifier.", - "operationId": "DeleteDocumentObjectByLanguageCardId", + "summary": "Gets the background task with the specified ID.", + "operationId": "GetBackgroundTask", "parameters": [ { - "name": "languageCardId", + "name": "TaskId", "in": "path", - "description": "Language card identifier of the document object to delete.", + "description": "Identifier of the background task.", "required": true, "schema": { + "maximum": 9999999999, + "minimum": 1, "type": "integer", + "description": "Identifier of the background task.", "format": "int64" } - } - ], - "requestBody": { - "description": "The parameters that will be used for delete operation.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/DeleteDocumentObjectByLanguageCardId" - } - ], - "description": "Request object to delete document object." - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/DeleteDocumentObjectByLanguageCardId" - } - ], - "description": "Request object to delete document object." - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/DeleteDocumentObjectByLanguageCardId" - } - ], - "description": "Request object to delete document object." - } + }, + { + "name": "SelectedProperties", + "in": "query", + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + } + }, + { + "name": "FieldGroup", + "in": "query", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + } + }, + { + "name": "Field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." } } - }, + ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Message" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/Message" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "$ref": "#/components/schemas/BackgroundTask" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "$ref": "#/components/schemas/BackgroundTask" } } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -1659,8 +1549,8 @@ } } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -1692,21 +1582,24 @@ } } }, - "/v3/DocumentObjects/ByLanguageCardId/{languageCardId}/Content": { + "/v3/BackgroundTasks/Content/{DataRef}": { "get": { "tags": [ - "DocumentObjects" + "BackgroundTasks" ], - "summary": "Gets the content by its language card identifier.", - "operationId": "GetDocumentObjectContentByLanguageCardId", + "summary": "Gets the content of the background task with the specified data reference.", + "operationId": "GetBackgroundTaskContent", "parameters": [ { - "name": "languageCardId", + "name": "DataRef", "in": "path", - "description": "Language card identifier of the document object.", + "description": "Identifier of the background task content.", "required": true, "schema": { + "maximum": 9999999999, + "minimum": 1, "type": "integer", + "description": "Identifier of the background task content.", "format": "int64" } } @@ -1723,8 +1616,8 @@ } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -1738,8 +1631,8 @@ } } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -1769,52 +1662,46 @@ } } } - }, - "put": { + } + }, + "/v3/Baselines/Get": { + "post": { "tags": [ - "DocumentObjects" - ], - "summary": "Updates the document object content by its language card identifier.", - "operationId": "UpdateDocumentObjectContentByLanguageCardId", - "parameters": [ - { - "name": "languageCardId", - "in": "path", - "description": "Language card identifier of the document object.", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } + "Baselines" ], + "summary": "Gets all baselines in the repository that match the criteria given in the parameters.", + "operationId": "GetBaselineList", "requestBody": { + "description": "Request object with the criteria in its properties.", "content": { - "multipart/form-data": { + "application/json": { "schema": { - "type": "object", - "properties": { - "content": { - "type": "string", - "format": "binary" - }, - "metadata": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateDocumentObjectContent" - } - ], - "nullable": true + "allOf": [ + { + "$ref": "#/components/schemas/GetBaselineList" } - } - }, - "encoding": { - "content": { - "style": "form" - }, - "metadata": { - "style": "form" - } + ], + "description": "Request object to get all baselines in the repository that match the criteria given in the properties." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetBaselineList" + } + ], + "description": "Request object to get all baselines in the repository that match the criteria given in the properties." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetBaselineList" + } + ], + "description": "Request object to get all baselines in the repository that match the criteria given in the properties." } } } @@ -1825,12 +1712,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/Baseline" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/Baseline" + } } } } @@ -1850,8 +1743,8 @@ } } }, - "403": { - "description": "Forbidden", + "default": { + "description": "Error", "content": { "application/json": { "schema": { @@ -1864,56 +1757,79 @@ } } } + } + } + } + }, + "/v3/Baselines/{Id}": { + "get": { + "tags": [ + "Baselines" + ], + "summary": "Gets the baseline with the specified ID.", + "operationId": "GetBaseline", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "Identifier of the baseline.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the baseline." + } }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + { + "name": "SelectedProperties", + "in": "query", + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" } - } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" } }, - "default": { - "description": "Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + { + "name": "FieldGroup", + "in": "query", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + } + }, + { + "name": "Field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } + "description": "Specifies one or more metadata fields to return." } - } - } - } - }, - "/v3/DocumentObjects/ByLanguageCardId/{languageCardId}/PossibleTargetStatuses": { - "get": { - "tags": [ - "DocumentObjects" - ], - "summary": "Getting status (transition) list by language card identifier.", - "operationId": "GetDocumentObjectPossibleTargetStatusListByLanguageCardId", - "parameters": [ + }, { - "name": "languageCardId", - "in": "path", - "description": "Language card identifier of the document object.", - "required": true, + "name": "IncludeLinks", + "in": "query", + "description": "true to include the links; otherwise, false. Default is false.", "schema": { - "type": "integer", - "format": "int64" + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false } } ], @@ -1923,24 +1839,18 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LovValue" - } + "$ref": "#/components/schemas/Baseline" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LovValue" - } + "$ref": "#/components/schemas/Baseline" } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -1954,8 +1864,8 @@ } } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -1985,54 +1895,81 @@ } } } - } - }, - "/v3/DocumentObjects/PossibleTargetStatuses": { - "get": { + }, + "put": { "tags": [ - "DocumentObjects" + "Baselines" ], - "summary": "Getting status (initial) list by document object type.", - "operationId": "GetDocumentObjectPossibleTargetStatusList", + "summary": "Updates the baseline with the specified ID.", + "operationId": "UpdateBaseline", "parameters": [ { - "name": "objectType", - "in": "query", - "description": "Type of the document.", + "name": "Id", + "in": "path", + "description": "The identifier of the baseline.", + "required": true, "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/DocumentObjectTypeFilter" - } - ], - "description": "Enumeration holding the type of document for filtering." + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the baseline." } } ], + "requestBody": { + "description": "Request body with a list of the fields.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateBaseline" + } + ], + "description": "Represents an update baseline model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateBaseline" + } + ], + "description": "Represents an update baseline model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateBaseline" + } + ], + "description": "Represents an update baseline model." + } + } + } + }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LovValue" - } + "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LovValue" - } + "$ref": "#/components/schemas/Message" } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -2046,8 +1983,8 @@ } } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -2077,27 +2014,40 @@ } } } - } - }, - "/v3/DocumentObjects": { - "post": { + }, + "delete": { "tags": [ - "DocumentObjects" + "Baselines" + ], + "summary": "Deletes the baseline with the specified ID.", + "operationId": "DeleteBaseline", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "The identifier of the baseline.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the baseline." + } + } ], - "summary": "Creates document object. - NOT IMPLEMENTED.", - "operationId": "CreateDocumentObject", "responses": { - "201": { + "200": { "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/DocumentObject" + "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/DocumentObject" + "$ref": "#/components/schemas/Message" } } } @@ -2117,8 +2067,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -2150,56 +2100,59 @@ } } }, - "/v3/DocumentObjects/ByLanguageCardId/{languageCardId}/Content/CheckOut": { + "/v3/Baselines/{Id}/Report/Complete": { "post": { "tags": [ - "DocumentObjects" + "Baselines" ], - "summary": "Check out the document object by its language card identifier.", - "operationId": "CheckOutDocumentObjectByLanguageCardId", + "summary": "Expands and completes the baseline with the specified ID, starting from the logical IDs provided, and optionally using Extend Baseline mode and/or Autocomplete mode.", + "operationId": "CompleteBaseline", "parameters": [ { - "name": "languageCardId", + "name": "Id", "in": "path", - "description": "Language card identifier of the document object.", + "description": "The identifier of the baseline.", "required": true, "schema": { - "type": "integer", - "format": "int64" + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the baseline." } } ], "requestBody": { - "description": "Request object with the criteria in its properties.", + "description": "Parameters which will be used to expand and complete the baseline starting from the incoming logicalIds using the extend baseline and/or the autocomplete mode.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CheckOutDocumentObject" + "$ref": "#/components/schemas/CompleteBaseline" } ], - "description": "Represents model to check out a document" + "description": "The model contains the parameters which will be used to expand and complete the baseline starting from the incoming logicalIds using the extend baseline and/or the autocomplete mode." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CheckOutDocumentObject" + "$ref": "#/components/schemas/CompleteBaseline" } ], - "description": "Represents model to check out a document" + "description": "The model contains the parameters which will be used to expand and complete the baseline starting from the incoming logicalIds using the extend baseline and/or the autocomplete mode." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CheckOutDocumentObject" + "$ref": "#/components/schemas/CompleteBaseline" } ], - "description": "Represents model to check out a document" + "description": "The model contains the parameters which will be used to expand and complete the baseline starting from the incoming logicalIds using the extend baseline and/or the autocomplete mode." } } } @@ -2210,12 +2163,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/BaselineReportEntry" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/BaselineReportEntry" + } } } } @@ -2235,21 +2194,6 @@ } } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, "404": { "description": "Not Found", "content": { @@ -2283,52 +2227,59 @@ } } }, - "/v3/DocumentObjects/ByLanguageCardId/{languageCardId}/Content/CheckIn": { + "/v3/Baselines/{Id}/Report/Expand": { "post": { "tags": [ - "DocumentObjects" + "Baselines" ], - "summary": "Checks in the document object by its language card identifier.", - "operationId": "CheckInDocumentObjectByLanguageCardId", + "summary": "Expands the baseline with the specified ID, starting from the logical IDs provided.", + "operationId": "ExpandBaseline", "parameters": [ { - "name": "languageCardId", + "name": "Id", "in": "path", - "description": "Language card identifier of the document object.", + "description": "The identifier of the baseline.", "required": true, "schema": { - "type": "integer", - "format": "int64" + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the baseline." } } ], "requestBody": { + "description": "Request object with the criteria in its properties.", "content": { - "multipart/form-data": { + "application/json": { "schema": { - "type": "object", - "properties": { - "content": { - "type": "string", - "format": "binary" - }, - "metadata": { - "allOf": [ - { - "$ref": "#/components/schemas/CheckInDocumentObject" - } - ], - "nullable": true + "allOf": [ + { + "$ref": "#/components/schemas/ExpandBaseline" } - } - }, - "encoding": { - "content": { - "style": "form" - }, - "metadata": { - "style": "form" - } + ], + "description": "Represents a ExpandBaseline." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/ExpandBaseline" + } + ], + "description": "Represents a ExpandBaseline." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/ExpandBaseline" + } + ], + "description": "Represents a ExpandBaseline." } } } @@ -2339,12 +2290,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/BaselineReportEntry" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/BaselineReportEntry" + } } } } @@ -2364,21 +2321,6 @@ } } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, "404": { "description": "Not Found", "content": { @@ -2412,56 +2354,59 @@ } } }, - "/v3/DocumentObjects/ByLanguageCardId/{languageCardId}/Content/UndoCheckout": { - "post": { + "/v3/Baselines/{Id}/Entries": { + "put": { "tags": [ - "DocumentObjects" + "Baselines" ], - "summary": "Undo checkout of the document object by its language card identifier.", - "operationId": "UndoCheckoutDocumentObjectByLanguageCardId", + "summary": "Adds, changes or deletes objects in the baseline with the specified ID.", + "operationId": "UpdateBaselineEntryList", "parameters": [ { - "name": "languageCardId", + "name": "Id", "in": "path", - "description": "Language card identifier of the document object.", + "description": "The identifier of the baseline.", "required": true, "schema": { - "type": "integer", - "format": "int64" + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the baseline." } } ], "requestBody": { - "description": "Required current metadata of the object.", + "description": "Request object with the criteria in its properties.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UndoCheckoutDocumentObject" + "$ref": "#/components/schemas/UpdateEntries" } ], - "description": "Represents model to undo checkout of a document" + "description": "The model contains the parameters which will be used to add/update/delete entries in the baseline." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UndoCheckoutDocumentObject" + "$ref": "#/components/schemas/UpdateEntries" } ], - "description": "Represents model to undo checkout of a document" + "description": "The model contains the parameters which will be used to add/update/delete entries in the baseline." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UndoCheckoutDocumentObject" + "$ref": "#/components/schemas/UpdateEntries" } ], - "description": "Represents model to undo checkout of a document" + "description": "The model contains the parameters which will be used to add/update/delete entries in the baseline." } } } @@ -2482,23 +2427,8 @@ } } }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, - "403": { - "description": "Forbidden", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -2512,8 +2442,8 @@ } } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -2543,68 +2473,25 @@ } } } - } - }, - "/v3/DocumentObjects/ByLogicalId/{logicalId}/Location": { + }, "get": { "tags": [ - "DocumentObjects" + "Baselines" ], - "summary": "Get the location of a document object in the folder structure.", - "operationId": "GetDocumentObjectLocation", + "summary": "Gets the objects in the baseline with the specified ID.", + "operationId": "GetBaselineEntryList", "parameters": [ { - "name": "logicalId", + "name": "Id", "in": "path", - "description": "Logical identifier of the document object.", + "description": "The identifier of the baseline.", "required": true, "schema": { - "type": "string" - } - }, - { - "name": "selectedProperties", - "in": "query", - "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectedProperties" - } - ], - "description": "Enumeration holding the selected properties." - } - }, - { - "name": "fieldGroup", - "in": "query", - "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/FieldGroup" - } - ], - "description": "Groups of metadata fields." - } - }, - { - "name": "field", - "in": "query", - "description": "Specifies one or more metadata fields to return.", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "includeLinks", - "in": "query", - "description": "true to include the links; otherwise, false. Default is false.", - "schema": { - "type": "boolean" + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the baseline." } } ], @@ -2616,7 +2503,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/Folder" + "$ref": "#/components/schemas/BaselineEntry" } } }, @@ -2624,12 +2511,27 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/Folder" + "$ref": "#/components/schemas/BaselineEntry" } } } } }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, "400": { "description": "Bad Request", "content": { @@ -2663,25 +2565,40 @@ } } }, - "/v3/DocumentObjects/Versions": { + "/v3/Baselines/{Id}/Entries/CleanUp": { "post": { "tags": [ - "DocumentObjects" + "Baselines" + ], + "summary": "Cleans up the baseline with the specified ID by removing unused entries.", + "operationId": "CleanUpBaseline", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "The identifier of the baseline.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the baseline." + } + } ], - "summary": "Creates document object version. - NOT IMPLEMENTED", - "operationId": "CreateDocumentObjectVersion", "responses": { - "201": { + "200": { "description": "Success", "content": { "application/json": { "schema": { - "type": "string" + "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { - "type": "string" + "$ref": "#/components/schemas/Message" } } } @@ -2701,8 +2618,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -2734,25 +2651,40 @@ } } }, - "/v3/DocumentObjects/Languages": { + "/v3/Baselines/{Id}/Freeze": { "post": { "tags": [ - "DocumentObjects" + "Baselines" + ], + "summary": "Freezes the baseline with the specified ID. If this action fails, a report is provided identifying problem areas that caused the action to fail.", + "operationId": "FreezeBaseline", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "The identifier of the baseline.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the baseline." + } + } ], - "summary": "Creates document object language. - NOT IMPLEMENTED.", - "operationId": "CreateDocumentObjectLanguage", "responses": { - "201": { + "200": { "description": "Success", "content": { "application/json": { "schema": { - "type": "string" + "$ref": "#/components/schemas/BaselineFreezeReport" } }, "text/json": { "schema": { - "type": "string" + "$ref": "#/components/schemas/BaselineFreezeReport" } } } @@ -2772,8 +2704,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -2805,64 +2737,44 @@ } } }, - "/v3/DocumentObjects/ByLogicalId/{logicalId}/ByVersion/{version}/UsedInPublications/Get": { + "/v3/Baselines/Report/ExtendByBaseline": { "post": { "tags": [ - "DocumentObjects" - ], - "summary": "Get the list of publications using a document object.", - "operationId": "GetPublicationListUsingDocumentObject", - "parameters": [ - { - "name": "logicalId", - "in": "path", - "description": "Logical identifier of an object.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "version", - "in": "path", - "description": "The version of an object.", - "required": true, - "schema": { - "type": "string" - } - } + "Baselines" ], + "summary": "Extends the specified versions of the specified logical objects with the contents of a baseline specified by an ID.", + "operationId": "ExtendBaselineReportByBaseline", "requestBody": { - "description": "Required metadata for a publications.", + "description": "Parameters which will be used to extend a baseline report.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetPublicationListUsingDocumentObject" + "$ref": "#/components/schemas/ExtendBaselineReportByBaseline" } ], - "description": "Represents model to get list of publications inside which the object is used." + "description": "The model contains the parameters which will be used to expand the baseline starting from the incoming logicalIds using the extend baseline." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetPublicationListUsingDocumentObject" + "$ref": "#/components/schemas/ExtendBaselineReportByBaseline" } ], - "description": "Represents model to get list of publications inside which the object is used." + "description": "The model contains the parameters which will be used to expand the baseline starting from the incoming logicalIds using the extend baseline." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetPublicationListUsingDocumentObject" + "$ref": "#/components/schemas/ExtendBaselineReportByBaseline" } ], - "description": "Represents model to get list of publications inside which the object is used." + "description": "The model contains the parameters which will be used to expand the baseline starting from the incoming logicalIds using the extend baseline." } } } @@ -2875,7 +2787,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/Publication" + "$ref": "#/components/schemas/BaselineReportEntry" } } }, @@ -2883,7 +2795,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/Publication" + "$ref": "#/components/schemas/BaselineReportEntry" } } } @@ -2904,8 +2816,8 @@ } } }, - "default": { - "description": "Error", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -2918,59 +2830,63 @@ } } } - } - } - } - }, - "/v3/DocumentObjects/ByLogicalId/{logicalId}/UsedInDocumentObjects/Get": { - "post": { - "tags": [ - "DocumentObjects" - ], - "summary": "Gets the list of document objects that are referencing the given logical id.", - "operationId": "GetDocumentObjectListUsingDocumentObject", - "parameters": [ - { - "name": "logicalId", - "in": "path", - "description": "Logical identifier of the document object.", - "required": true, - "schema": { - "type": "string" + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } } } + } + } + }, + "/v3/Baselines/Report/ExtendByCandidate": { + "post": { + "tags": [ + "Baselines" ], + "summary": "Extends the specified versions of the specified logical objects with versions that are marked as candidates for a baseline specified by an ID.", + "operationId": "ExtendBaselineReportByCandidate", "requestBody": { - "description": "The parameters that will be used for filtering operation.", + "description": "Parameters which will be used to extend a baseline report.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetDocumentObjectListUsingDocumentObject" + "$ref": "#/components/schemas/ExtendBaselineReportByCandidate" } ], - "description": "Request object to get all objects in the repository that are referencing the given logical id." + "description": "The model contains the parameters which will be used to expand the baseline starting from the incoming logicalIds using candidates for the baseline." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetDocumentObjectListUsingDocumentObject" + "$ref": "#/components/schemas/ExtendBaselineReportByCandidate" } ], - "description": "Request object to get all objects in the repository that are referencing the given logical id." + "description": "The model contains the parameters which will be used to expand the baseline starting from the incoming logicalIds using candidates for the baseline." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetDocumentObjectListUsingDocumentObject" + "$ref": "#/components/schemas/ExtendBaselineReportByCandidate" } ], - "description": "Request object to get all objects in the repository that are referencing the given logical id." + "description": "The model contains the parameters which will be used to expand the baseline starting from the incoming logicalIds using candidates for the baseline." } } } @@ -2983,7 +2899,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentObject" + "$ref": "#/components/schemas/BaselineReportEntry" } } }, @@ -2991,7 +2907,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentObject" + "$ref": "#/components/schemas/BaselineReportEntry" } } } @@ -3012,6 +2928,21 @@ } } }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, "default": { "description": "Error", "content": { @@ -3030,55 +2961,60 @@ } } }, - "/v3/DocumentObjects/ByLanguageCardId/{languageCardId}/References": { - "get": { + "/v3/Baselines": { + "post": { "tags": [ - "DocumentObjects" + "Baselines" ], - "summary": "Get the logical identifiers for all document objects referenced by the specified document object.", - "operationId": "GetDocumentObjectReferenceListByLanguageCardId", - "parameters": [ - { - "name": "languageCardId", - "in": "path", - "description": "Language card identifier of the document object.", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "linkType", - "in": "query", - "description": "The enumeration indicating which link fields must be used.", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/LinkType" - } - ] + "summary": "Creates a baseline.", + "operationId": "CreateBaseline", + "requestBody": { + "description": "Parameters which will be used to create a baseline.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateBaseline" + } + ], + "description": "Represents the information required for creating baseline." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateBaseline" + } + ], + "description": "Represents the information required for creating baseline." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateBaseline" + } + ], + "description": "Represents the information required for creating baseline." + } } } - ], + }, "responses": { - "200": { - "description": "Success", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/Baseline" } }, "text/json": { "schema": { - "type": "array", - "items": { - "type": "string" - } + "$ref": "#/components/schemas/Baseline" } } } @@ -3098,6 +3034,21 @@ } } }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, "default": { "description": "Error", "content": { @@ -3116,78 +3067,60 @@ } } }, - "/v3/Folders/RootFolders": { - "get": { + "/v3/Baselines/Copy": { + "post": { "tags": [ - "Folders" + "Baselines" ], - "summary": "Gets the root folders of types like Data, System, Favorites.", - "operationId": "GetRootFolderList", - "parameters": [ - { - "name": "selectedProperties", - "in": "query", - "description": "Selected properties to filter the properties. Default is Id.", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectedProperties" - } - ], - "description": "Enumeration holding the selected properties." - } - }, - { - "name": "fieldGroup", - "in": "query", - "description": "Field group of Metadata fields. Default is None.", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/FieldGroup" - } - ], - "description": "Groups of metadata fields." - } - }, - { - "name": "field", - "in": "query", - "description": "Specifies one or more metadata fields to return.", - "schema": { - "type": "array", - "items": { - "type": "string" + "summary": "Creates a copy of a baseline.", + "operationId": "CopyBaseline", + "requestBody": { + "description": "Parameters which will be used to copy a baseline.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CopyBaseline" + } + ], + "description": "Represents the information required for copying baseline." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CopyBaseline" + } + ], + "description": "Represents the information required for copying baseline." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CopyBaseline" + } + ], + "description": "Represents the information required for copying baseline." } - } - }, - { - "name": "includeLinks", - "in": "query", - "description": "{true} to include the links; otherwise, {false}. Default is {false}.", - "schema": { - "type": "boolean" } } - ], + }, "responses": { - "200": { - "description": "Success", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Folder" - } + "$ref": "#/components/schemas/Baseline" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Folder" - } + "$ref": "#/components/schemas/Baseline" } } } @@ -3207,6 +3140,21 @@ } } }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, "default": { "description": "Error", "content": { @@ -3225,108 +3173,48 @@ } } }, - "/v3/Folders/{id}/Objects": { - "get": { + "/v3/Baselines/Report/Expand": { + "post": { "tags": [ - "Folders" + "Baselines" ], - "summary": "Gets the objects in the folder specified by id.", - "description": "Depending on which object type is specified, the following types can be returned:\r\n
Object typeReturned types
AnyFolders and contents
FoldersFolder, ReferenceFolder, PublicationFolder, MapFolder, TopicFolder, LibraryFolder, IllustrationFolder and OtherFolder
ContentsPublication, Map, Topic, Library, Illustration and Other
", - "operationId": "GetFolderObjectList", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Card identifier of the folder whose objects will be returned, e.g. 25432.", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "objectType", - "in": "query", - "description": "Specifies whether folders, contents or both will be returned. If not supplied, all types will be returned.", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/FolderObjectTypeFilter" - } - ], - "description": "Enumeration that lists possible folder item types." - } - }, - { - "name": "language", - "in": "query", - "description": "The language for which to retrieve document metadata fields, e.g. VLANGUAGEEN, en. If not supplied, the user language will be used.", - "schema": { - "type": "string" - } - }, - { - "name": "resolution", - "in": "query", - "description": "The resolution for which to retrieve image metadata fields, e.g. VRESLOW, Low. If not supplied, the system resolution will be used.", - "schema": { - "type": "string" - } - }, - { - "name": "selectedProperties", - "in": "query", - "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectedProperties" - } - ], - "description": "Enumeration holding the selected properties." - } - }, - { - "name": "fieldGroup", - "in": "query", - "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/FieldGroup" - } - ], - "description": "Groups of metadata fields." - } - }, - { - "name": "field", - "in": "query", - "description": "Specifies one or more metadata fields to return.", - "schema": { - "type": "array", - "items": { - "type": "string" + "summary": "Expands the specified versions of the specified logical objects, starting from the logical IDs provided.", + "operationId": "ExpandBaselineReport", + "requestBody": { + "description": "Parameters which will be used to extend a baseline report.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/ExpandReport" + } + ], + "description": "The model contains the parameters which will be used to expand the baseline starting from the incoming logicalIds using candidates for the baseline." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/ExpandReport" + } + ], + "description": "The model contains the parameters which will be used to expand the baseline starting from the incoming logicalIds using candidates for the baseline." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/ExpandReport" + } + ], + "description": "The model contains the parameters which will be used to expand the baseline starting from the incoming logicalIds using candidates for the baseline." } - } - }, - { - "name": "includeLinks", - "in": "query", - "description": "true to include the links; otherwise, false. Default is false.", - "schema": { - "type": "boolean" - } - }, - { - "name": "includePartialItems", - "in": "query", - "description": "true to include partial items when the version or language is missing; otherwise, false. Default is false.", - "schema": { - "type": "boolean" } } - ], + }, "responses": { "200": { "description": "Success", @@ -3335,7 +3223,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/BaseObject" + "$ref": "#/components/schemas/BaselineReportEntry" } } }, @@ -3343,7 +3231,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/BaseObject" + "$ref": "#/components/schemas/BaselineReportEntry" } } } @@ -3382,37 +3270,66 @@ } } }, - "/v3/Folders/{id}": { - "delete": { + "/v3/Baselines/Report/Complete": { + "post": { "tags": [ - "Folders" + "Baselines" ], - "summary": "Deletes a folder.", - "operationId": "DeleteFolder", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Id of the folder to delete.", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "summary": "Expands and completes the specified versions of the logical objects, starting from the logical IDs provided, and optionally using Extend Baseline mode and/or Autocomplete mode.", + "operationId": "CompleteBaselineReport", + "requestBody": { + "description": "Parameters which will be used to extend a baseline report.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CompleteReport" + } + ], + "description": "The model contains the parameters which will be used to expand the baseline starting from the incoming logicalIds using candidates for the baseline." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CompleteReport" + } + ], + "description": "The model contains the parameters which will be used to expand the baseline starting from the incoming logicalIds using candidates for the baseline." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CompleteReport" + } + ], + "description": "The model contains the parameters which will be used to expand the baseline starting from the incoming logicalIds using candidates for the baseline." + } } } - ], + }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/BaselineReportEntry" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/BaselineReportEntry" + } } } } @@ -3432,36 +3349,6 @@ } } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, "default": { "description": "Error", "content": { @@ -3478,67 +3365,27 @@ } } } - }, + } + }, + "/v3/Baselines/{Id}/UsedInPublications": { "get": { "tags": [ - "Folders" + "Baselines" ], - "summary": "Gets the properties of the given folder.", - "operationId": "GetFolder", + "summary": "Gets the list of publications that reference the baseline specified by the ID.", + "operationId": "GetPublicationListUsingBaseline", "parameters": [ { - "name": "id", + "name": "Id", "in": "path", - "description": "The identifier of the folder.", + "description": "The identifier of the baseline.", "required": true, "schema": { - "type": "integer", - "format": "int64" - } - }, - { - "name": "selectedProperties", - "in": "query", - "description": "Specifies which properties to return.", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectedProperties" - } - ], - "description": "Enumeration holding the selected properties." - } - }, - { - "name": "fieldGroup", - "in": "query", - "description": "Specifies the group of metadata fields to return.", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/FieldGroup" - } - ], - "description": "Groups of metadata fields." - } - }, - { - "name": "field", - "in": "query", - "description": "Specifies one or more metadata fields to return.", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "includeLinks", - "in": "query", - "description": "{true} to include the links; otherwise, {false}. Default is {false}.", - "schema": { - "type": "boolean" + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the baseline." } } ], @@ -3548,12 +3395,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Folder" + "type": "array", + "items": { + "$ref": "#/components/schemas/Publication" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Folder" + "type": "array", + "items": { + "$ref": "#/components/schemas/Publication" + } } } } @@ -3573,23 +3426,8 @@ } } }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, - "default": { - "description": "Error", + "default": { + "description": "Error", "content": { "application/json": { "schema": { @@ -3604,56 +3442,61 @@ } } } - }, - "put": { + } + }, + "/v3/Conditions/{ConditionName}/UsedInDocumentObjects/Get": { + "post": { "tags": [ - "Folders" + "Conditions" ], - "summary": "Updates the folder specified by id.", - "operationId": "UpdateFolder", + "summary": "Gets the list of document objects that use the condition with the specified condition name.", + "operationId": "GetDocumentObjectListUsingConditionName", "parameters": [ { - "name": "id", + "name": "ConditionName", "in": "path", - "description": "The identifier of folder.", + "description": "The name of the condition.", "required": true, "schema": { - "type": "integer", - "format": "int64" + "maxLength": 1333, + "minLength": 1, + "pattern": "^[^<>=!(),:\\ ]+$", + "type": "string", + "description": "The name of the condition." } } ], "requestBody": { - "description": "The update folder model.", + "description": "Request body containing filter criteria.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdateFolder" + "$ref": "#/components/schemas/GetDocumentObjectListUsingConditionName" } ], - "description": "Represents an update folder model." + "description": "Request object to get all document objects in the repository where the condition name is used." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdateFolder" + "$ref": "#/components/schemas/GetDocumentObjectListUsingConditionName" } ], - "description": "Represents an update folder model." + "description": "Request object to get all document objects in the repository where the condition name is used." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdateFolder" + "$ref": "#/components/schemas/GetDocumentObjectListUsingConditionName" } ], - "description": "Represents an update folder model." + "description": "Request object to get all document objects in the repository where the condition name is used." } } } @@ -3664,12 +3507,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObject" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObject" + } } } } @@ -3689,36 +3538,6 @@ } } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, "default": { "description": "Error", "content": { @@ -3737,60 +3556,94 @@ } } }, - "/v3/Folders": { + "/v3/Conditions/{ConditionName}/Values/{ConditionValue}/UsedInDocumentObjects/Get": { "post": { "tags": [ - "Folders" + "Conditions" + ], + "summary": "Gets the list of document objects in which the condition with the specified condition name has the specified condition value.", + "operationId": "GetDocumentObjectListUsingConditionValue", + "parameters": [ + { + "name": "ConditionName", + "in": "path", + "description": "The name of the condition.", + "required": true, + "schema": { + "maxLength": 1333, + "minLength": 1, + "pattern": "^[^<>=!(),:\\ ]+$", + "type": "string", + "description": "The name of the condition." + } + }, + { + "name": "ConditionValue", + "in": "path", + "description": "The value of the condition.", + "required": true, + "schema": { + "maxLength": 1333, + "minLength": 1, + "pattern": "^[^,:]+$", + "type": "string", + "description": "The value of the condition." + } + } ], - "summary": "Creates the new folder in the specified parent folder.", - "operationId": "CreateFolder", "requestBody": { - "description": "The create folder model.", + "description": "Request body containing filter criteria.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CreateFolder" + "$ref": "#/components/schemas/GetDocumentObjectListUsingConditionValue" } ], - "description": "Represents a create folder model." + "description": "Request object to get all document objects in the repository where the condition name and value are used." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CreateFolder" + "$ref": "#/components/schemas/GetDocumentObjectListUsingConditionValue" } ], - "description": "Represents a create folder model." + "description": "Request object to get all document objects in the repository where the condition name and value are used." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CreateFolder" + "$ref": "#/components/schemas/GetDocumentObjectListUsingConditionValue" } ], - "description": "Represents a create folder model." + "description": "Request object to get all document objects in the repository where the condition name and value are used." } } } }, "responses": { - "201": { + "200": { "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/FolderDescriptor" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObject" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/FolderDescriptor" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObject" + } } } } @@ -3810,21 +3663,6 @@ } } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, "default": { "description": "Error", "content": { @@ -3843,44 +3681,45 @@ } } }, - "/v3/Folders/Get": { + "/v3/DocumentObjects/ByLogicalId/Get": { "post": { "tags": [ - "Folders" + "DocumentObjects" ], - "summary": "Gets all folders in the Repository that match the criteria given in the parameters.", - "operationId": "GetFolderList", + "summary": "Gets the set of document objects with the specified set of logical IDs (and matching possible additional filter criteria).", + "description": "Depending on which status filter is specified, the objects with following status types can be returned:\r\n
Status filterReturned status types
AllAll status types
LatestReleasedLatest released excluding out-of-date
DraftOrLatestReleasedDraft and latest released excluding out-of-date
AllReleasedAll released including out-of-date
", + "operationId": "GetDocumentObjectListByLogicalId", "requestBody": { - "description": "Request folders with the criteria in its properties.", + "description": "Request object with the criteria in its properties.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetFolderList" + "$ref": "#/components/schemas/GetDocumentObjectListByLogicalId" } ], - "description": "Request folder to get all folders in the repository that match the criteria given in the properties." + "description": "Request object to get all objects in the repository that match the criteria given in the properties." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetFolderList" + "$ref": "#/components/schemas/GetDocumentObjectListByLogicalId" } ], - "description": "Request folder to get all folders in the repository that match the criteria given in the properties." + "description": "Request object to get all objects in the repository that match the criteria given in the properties." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetFolderList" + "$ref": "#/components/schemas/GetDocumentObjectListByLogicalId" } ], - "description": "Request folder to get all folders in the repository that match the criteria given in the properties." + "description": "Request object to get all objects in the repository that match the criteria given in the properties." } } } @@ -3893,7 +3732,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/Folder" + "$ref": "#/components/schemas/DocumentObject" } } }, @@ -3901,7 +3740,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/Folder" + "$ref": "#/components/schemas/DocumentObject" } } } @@ -3940,44 +3779,45 @@ } } }, - "/v3/Folders/MoveFolder": { + "/v3/DocumentObjects/Get": { "post": { "tags": [ - "Folders" + "DocumentObjects" ], - "summary": "Moves a folder to another folder.", - "operationId": "MoveFolder", + "summary": "Gets the set of document objects that match the filter criteria.", + "description": "Depending on which status filter is specified, the objects with following status types can be returned:\r\n
Status filterReturned status types
AllAll status types
LatestReleasedLatest released excluding out-of-date
DraftOrLatestReleasedDraft and latest released excluding out-of-date
AllReleasedAll released including out-of-date
", + "operationId": "GetDocumentObjectList", "requestBody": { - "description": "Represents the model to move a folder.", + "description": "Request object with the criteria in its properties.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/MoveFolder" + "$ref": "#/components/schemas/GetDocumentObjectList" } ], - "description": "Represents a move folder model." + "description": "Request object to get all objects in the repository that match the criteria given in the properties." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/MoveFolder" + "$ref": "#/components/schemas/GetDocumentObjectList" } ], - "description": "Represents a move folder model." + "description": "Request object to get all objects in the repository that match the criteria given in the properties." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/MoveFolder" + "$ref": "#/components/schemas/GetDocumentObjectList" } ], - "description": "Represents a move folder model." + "description": "Request object to get all objects in the repository that match the criteria given in the properties." } } } @@ -3988,12 +3828,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObject" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObject" + } } } } @@ -4013,36 +3859,6 @@ } } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, "default": { "description": "Error", "content": { @@ -4061,44 +3877,45 @@ } } }, - "/v3/Folders/MoveObject": { + "/v3/DocumentObjects/ByLanguageCardId/Get": { "post": { "tags": [ - "Folders" + "DocumentObjects" ], - "summary": "Moves an object to another folder.", - "operationId": "MoveObjectToFolder", + "summary": "Gets the set of document objects with the specified set of language card IDs (and matching possible additional filter criteria).", + "description": "Depending on which status filter is specified, the objects with following status types can be returned:\r\n
Status filterReturned status types
AllAll status types
LatestReleasedLatest released excluding out-of-date
DraftOrLatestReleasedDraft and latest released excluding out-of-date
AllReleasedAll released including out-of-date
", + "operationId": "GetDocumentObjectListByLanguageCardId", "requestBody": { - "description": "Represents the model to move an object.", + "description": "Request object with the criteria in its properties.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/MoveObject" + "$ref": "#/components/schemas/GetDocumentObjectListByLanguageCardId" } ], - "description": "Represents a move object model." + "description": "Request object to get all objects in the repository that match the criteria given in the properties." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/MoveObject" + "$ref": "#/components/schemas/GetDocumentObjectListByLanguageCardId" } ], - "description": "Represents a move object model." + "description": "Request object to get all objects in the repository that match the criteria given in the properties." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/MoveObject" + "$ref": "#/components/schemas/GetDocumentObjectListByLanguageCardId" } ], - "description": "Represents a move object model." + "description": "Request object to get all objects in the repository that match the criteria given in the properties." } } } @@ -4109,12 +3926,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObject" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObject" + } } } } @@ -4134,38 +3957,8 @@ } } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, - "default": { - "description": "Error", + "default": { + "description": "Error", "content": { "application/json": { "schema": { @@ -4182,56 +3975,45 @@ } } }, - "/v3/Folders/{id}/Shortcuts": { - "delete": { + "/v3/DocumentObjects/ByLogicalId/ByVersionAndLanguageFilter/Get": { + "post": { "tags": [ - "Folders" - ], - "summary": "Removes shortcut from the specified reference folder.", - "operationId": "RemoveShortcutFromFolder", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The identifier of the folder.", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } + "DocumentObjects" ], + "summary": "Gets the set of document objects with the specified set of logical IDs and matching the version and language filter criteria.", + "description": "Depending on which status filter is specified, the objects with following status types can be returned:\r\n
Status filterReturned status types
AllAll status types
LatestReleasedLatest released excluding out-of-date
DraftOrLatestReleasedDraft and latest released excluding out-of-date
AllReleasedAll released including out-of-date
", + "operationId": "GetDocumentObjectListByVersionAndLanguageFilter", "requestBody": { - "description": "Represents logical identifier model of the document object or publication for which to remove a shortcut.", + "description": "Request object with the criteria in its properties.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/RemoveShortcut" + "$ref": "#/components/schemas/GetDocumentObjectsByLogicalIdVersionAndLanguageFilter" } ], - "description": "Represents logical identifier model." + "description": "Request parameters to retrieve document objects by combination of logical identifier, version and language." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/RemoveShortcut" + "$ref": "#/components/schemas/GetDocumentObjectsByLogicalIdVersionAndLanguageFilter" } ], - "description": "Represents logical identifier model." + "description": "Request parameters to retrieve document objects by combination of logical identifier, version and language." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/RemoveShortcut" + "$ref": "#/components/schemas/GetDocumentObjectsByLogicalIdVersionAndLanguageFilter" } ], - "description": "Represents logical identifier model." + "description": "Request parameters to retrieve document objects by combination of logical identifier, version and language." } } } @@ -4242,12 +4024,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObject" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObject" + } } } } @@ -4267,36 +4055,6 @@ } } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, "default": { "description": "Error", "content": { @@ -4313,56 +4071,46 @@ } } } - }, - "put": { + } + }, + "/v3/DocumentObjects/ByLogicalId/ByVersionFilter/Get": { + "post": { "tags": [ - "Folders" - ], - "summary": "Adds shortcut to the specified reference folder.", - "operationId": "AddShortcutToFolder", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "Specifies the card identifier of the folder to which to add the shortcut.", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } + "DocumentObjects" ], + "summary": "Gets the set of document objects with the specified set of logical IDs and matching the version filter criteria.", + "operationId": "GetDocumentObjectListByVersionFilter", "requestBody": { - "description": "Represents logical identifier model of the document object or publication for which to create a shortcut.", + "description": "Request object with the criteria in its properties.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/AddShortcut" + "$ref": "#/components/schemas/GetDocumentObjectsByLogicalIdVersionFilter" } ], - "description": "Represents logical identifier model." + "description": "Request parameters to retrieve document objects by combination of logical identifier and version." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/AddShortcut" + "$ref": "#/components/schemas/GetDocumentObjectsByLogicalIdVersionFilter" } ], - "description": "Represents logical identifier model." + "description": "Request parameters to retrieve document objects by combination of logical identifier and version." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/AddShortcut" + "$ref": "#/components/schemas/GetDocumentObjectsByLogicalIdVersionFilter" } ], - "description": "Represents logical identifier model." + "description": "Request parameters to retrieve document objects by combination of logical identifier and version." } } } @@ -4373,12 +4121,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObject" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObject" + } } } } @@ -4398,36 +4152,6 @@ } } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, "default": { "description": "Error", "content": { @@ -4446,67 +4170,107 @@ } } }, - "/v3/Folders/{id}/Location": { + "/v3/DocumentObjects/ByLogicalId/{LogicalId}": { "get": { "tags": [ - "Folders" + "DocumentObjects" ], - "summary": "Gets the parents of the given folder.", - "operationId": "GetFolderLocation", + "summary": "Gets the document object with the specified logical ID. Additional filters may also be provided, such as version and language.", + "operationId": "GetDocumentObjectByLogicalId", "parameters": [ { - "name": "id", + "name": "LogicalId", "in": "path", - "description": "The identifier of the folder.", + "description": "The logical identifier of the document object.", "required": true, "schema": { - "type": "integer", - "format": "int64" + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The logical identifier of the document object." } }, { - "name": "selectedProperties", + "name": "Version", "in": "query", - "description": "Specifies which properties to return.", + "description": "The version of the document object.", + "schema": { + "type": "string", + "description": "The version of the document object.", + "nullable": true + } + }, + { + "name": "Language", + "in": "query", + "description": "The language of the document object.", + "schema": { + "maxLength": 255, + "type": "string", + "description": "The language of the document object.", + "nullable": true + } + }, + { + "name": "Resolution", + "in": "query", + "description": "The resolution of the document object.", + "schema": { + "maxLength": 255, + "type": "string", + "description": "The resolution of the document object.", + "nullable": true + } + }, + { + "name": "SelectedProperties", + "in": "query", + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", "schema": { "allOf": [ { "$ref": "#/components/schemas/SelectedProperties" } ], - "description": "Enumeration holding the selected properties." + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" } }, { - "name": "fieldGroup", + "name": "FieldGroup", "in": "query", - "description": "Specifies the group of metadata fields to return.", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", "schema": { "allOf": [ { "$ref": "#/components/schemas/FieldGroup" } ], - "description": "Groups of metadata fields." + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" } }, { - "name": "field", + "name": "Field", "in": "query", "description": "Specifies one or more metadata fields to return.", "schema": { "type": "array", "items": { "type": "string" - } + }, + "description": "Specifies one or more metadata fields to return." } }, { - "name": "includeLinks", + "name": "IncludeLinks", "in": "query", - "description": "{true} to include the links; otherwise, {false}. Default is {false}.", + "description": "true to include the links; otherwise, false. Default is false.", "schema": { - "type": "boolean" + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false } } ], @@ -4516,24 +4280,18 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Folder" - } + "$ref": "#/components/schemas/DocumentObject" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Folder" - } + "$ref": "#/components/schemas/DocumentObject" } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -4547,8 +4305,8 @@ } } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -4578,23 +4336,57 @@ } } } - } - }, - "/v3/Inboxes/{id}/Objects/Get": { - "post": { + }, + "put": { "tags": [ - "Inboxes" + "DocumentObjects" ], - "summary": "Gets a list of document objects for the specified inbox.", - "operationId": "GetInboxObjectList", + "summary": "Updates the document object with the specified logical ID. Additional filters may also be provided, such as version and language.", + "operationId": "UpdateDocumentObjectByLogicalId", "parameters": [ { - "name": "id", + "name": "LogicalId", "in": "path", - "description": "Specify the id of the inbox.", + "description": "The logical identifier of the document object.", "required": true, "schema": { - "type": "string" + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The logical identifier of the document object." + } + }, + { + "name": "Version", + "in": "query", + "description": "The version of the document object.", + "schema": { + "type": "string", + "description": "The version of the document object.", + "nullable": true + } + }, + { + "name": "Language", + "in": "query", + "description": "The language of the document object.", + "schema": { + "maxLength": 255, + "type": "string", + "description": "The language of the document object.", + "nullable": true + } + }, + { + "name": "Resolution", + "in": "query", + "description": "The resolution of the document object.", + "schema": { + "maxLength": 255, + "type": "string", + "description": "The resolution of the document object.", + "nullable": true } } ], @@ -4605,30 +4397,30 @@ "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetInboxObjectList" + "$ref": "#/components/schemas/UpdateDocumentObject" } ], - "description": "Represents an Inbox object list." + "description": "Represents a document." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetInboxObjectList" + "$ref": "#/components/schemas/UpdateDocumentObject" } ], - "description": "Represents an Inbox object list." + "description": "Represents a document." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetInboxObjectList" + "$ref": "#/components/schemas/UpdateDocumentObject" } ], - "description": "Represents an Inbox object list." + "description": "Represents a document." } } } @@ -4639,24 +4431,18 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentObject" - } + "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentObject" - } + "$ref": "#/components/schemas/Message" } } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -4685,6 +4471,21 @@ } } }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, "default": { "description": "Error", "content": { @@ -4701,39 +4502,113 @@ } } } - } - }, - "/v3/Inboxes": { - "get": { + }, + "delete": { "tags": [ - "Inboxes" + "DocumentObjects" ], - "summary": "Gets the list of all inboxes.", - "operationId": "GetInboxList", + "summary": "Deletes the document object with the specified logical ID. Additional filters may also be provided, such as version and language.", + "operationId": "DeleteDocumentObjectByLogicalId", + "parameters": [ + { + "name": "LogicalId", + "in": "path", + "description": "The logical identifier of the document object.", + "required": true, + "schema": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The logical identifier of the document object." + } + }, + { + "name": "Version", + "in": "query", + "description": "The version of the document object.", + "schema": { + "type": "string", + "description": "The version of the document object.", + "nullable": true + } + }, + { + "name": "Language", + "in": "query", + "description": "The language of the document object.", + "schema": { + "maxLength": 255, + "type": "string", + "description": "The language of the document object.", + "nullable": true + } + }, + { + "name": "Resolution", + "in": "query", + "description": "The resolution of the document object.", + "schema": { + "maxLength": 255, + "type": "string", + "description": "The resolution of the document object.", + "nullable": true + } + } + ], + "requestBody": { + "description": "The parameters that will be used for delete operation.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/DeleteDocumentObjectByLogicalId" + } + ], + "description": "Request object to delete document object." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/DeleteDocumentObjectByLogicalId" + } + ], + "description": "Request object to delete document object." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/DeleteDocumentObjectByLogicalId" + } + ], + "description": "Request object to delete document object." + } + } + } + }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Inbox" - } + "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Inbox" - } + "$ref": "#/components/schemas/Message" } } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -4762,6 +4637,21 @@ } } }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, "default": { "description": "Error", "content": { @@ -4780,34 +4670,75 @@ } } }, - "/v3/Lists/{id}/Values": { + "/v3/DocumentObjects/ByLanguageCardId/{LanguageCardId}": { "get": { "tags": [ - "Lists" + "DocumentObjects" ], - "summary": "Get the values for the specified list of values.", - "operationId": "GetLovValueList", + "summary": "Gets the document object with the specified language card ID.", + "operationId": "GetDocumentObjectByLanguageCardId", "parameters": [ { - "name": "id", + "name": "LanguageCardId", "in": "path", - "description": "The identifier of a list of values (e.g. DRESOLUTION).", + "description": "The language card identifier of the document object.", "required": true, "schema": { - "type": "string" + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" } }, { - "name": "activityFilter", + "name": "SelectedProperties", "in": "query", - "description": "The filter to limit the result of the active LovValues.", + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", "schema": { "allOf": [ { - "$ref": "#/components/schemas/ActivityFilter" + "$ref": "#/components/schemas/SelectedProperties" } ], - "description": "Allows explicit filtering." + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + } + }, + { + "name": "FieldGroup", + "in": "query", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + } + }, + { + "name": "Field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + } + }, + { + "name": "IncludeLinks", + "in": "query", + "description": "true to include the links; otherwise, false. Default is false.", + "schema": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false } } ], @@ -4817,18 +4748,27 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LovValue" - } + "$ref": "#/components/schemas/DocumentObject" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LovValue" - } + "$ref": "#/components/schemas/DocumentObject" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" } } } @@ -4865,20 +4805,24 @@ } } }, - "post": { + "put": { "tags": [ - "Lists" + "DocumentObjects" ], - "summary": "Create a lov value in the specified list of value.", - "operationId": "CreateLovValue", + "summary": "Updates the document object with the specified language card ID.", + "operationId": "UpdateDocumentObjectByLanguageCardId", "parameters": [ { - "name": "id", + "name": "LanguageCardId", "in": "path", - "description": "The list of values identifier (e.g. DRESOLUTION).", + "description": "The language card identifier of the document object.", "required": true, "schema": { - "type": "string" + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" } } ], @@ -4889,52 +4833,52 @@ "schema": { "allOf": [ { - "$ref": "#/components/schemas/CreateLovValue" + "$ref": "#/components/schemas/UpdateDocumentObject" } ], - "description": "Represents a create lov Value model." + "description": "Represents a document." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CreateLovValue" + "$ref": "#/components/schemas/UpdateDocumentObject" } ], - "description": "Represents a create lov Value model." + "description": "Represents a document." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CreateLovValue" + "$ref": "#/components/schemas/UpdateDocumentObject" } ], - "description": "Represents a create lov Value model." + "description": "Represents a document." } } } }, "responses": { - "201": { + "200": { "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/LovValue" + "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/LovValue" + "$ref": "#/components/schemas/Message" } } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -4948,8 +4892,23 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -4979,66 +4938,59 @@ } } } - } - }, - "/v3/Lists/{id}/Values/{valueId}": { - "put": { - "tags": [ - "Lists" + }, + "delete": { + "tags": [ + "DocumentObjects" ], - "summary": "Update Lov value based on the specified parameters.", - "operationId": "UpdateLovValue", + "summary": "Deletes the document object with the specified language card ID.", + "operationId": "DeleteDocumentObjectByLanguageCardId", "parameters": [ { - "name": "id", - "in": "path", - "description": "The list of values identifier (e.g. DRESOLUTION).", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "valueId", + "name": "LanguageCardId", "in": "path", - "description": "The lov value identifier.", + "description": "The language card identifier of the document object.", "required": true, "schema": { - "type": "string" + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" } } ], "requestBody": { - "description": "Update Lov value model.", + "description": "The parameters that will be used for delete operation.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdateLovValue" + "$ref": "#/components/schemas/DeleteDocumentObjectByLanguageCardId" } ], - "description": "Represents an update lov Value model." + "description": "Request object to delete document object." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdateLovValue" + "$ref": "#/components/schemas/DeleteDocumentObjectByLanguageCardId" } ], - "description": "Represents an update lov Value model." + "description": "Request object to delete document object." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdateLovValue" + "$ref": "#/components/schemas/DeleteDocumentObjectByLanguageCardId" } ], - "description": "Represents an update lov Value model." + "description": "Request object to delete document object." } } } @@ -5059,8 +5011,8 @@ } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -5074,8 +5026,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -5089,8 +5041,8 @@ } } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -5120,30 +5072,27 @@ } } } - }, - "delete": { + } + }, + "/v3/DocumentObjects/ByLanguageCardId/{LanguageCardId}/Content": { + "get": { "tags": [ - "Lists" + "DocumentObjects" ], - "summary": "Delete lov value based on the specified parameters.", - "operationId": "DeleteLovValue", + "summary": "Gets the contents of the document object with the specified language card ID.", + "operationId": "GetDocumentObjectContentByLanguageCardId", "parameters": [ { - "name": "id", - "in": "path", - "description": "The list of values identifier (e.g. DRESOLUTION).", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "valueId", + "name": "LanguageCardId", "in": "path", - "description": "The lov value identifier.", + "description": "The language card identifier of the document object.", "required": true, "schema": { - "type": "string" + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" } } ], @@ -5151,35 +5100,16 @@ "200": { "description": "Success", "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Message" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/Message" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { + "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "type": "string", + "format": "binary" } } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -5193,8 +5123,8 @@ } } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -5225,65 +5155,80 @@ } } }, - "get": { + "put": { "tags": [ - "Lists" + "DocumentObjects" ], - "summary": "Get the lov value based on the specified parameters.", - "operationId": "GetLovValue", + "summary": "Updates the contents of the document object with the specified language card ID.", + "operationId": "UpdateDocumentObjectContentByLanguageCardId", "parameters": [ { - "name": "id", - "in": "path", - "description": "The identifier of a list of values (e.g. DRESOLUTION).", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "valueId", + "name": "LanguageCardId", "in": "path", - "description": "The lov value identifier (e.g. VRESHIGH for DRESOLUTION).", + "description": "The language card identifier of the document object.", "required": true, "schema": { - "type": "string" + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" } } ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LovValue" + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "required": [ + "content" + ], + "type": "object", + "properties": { + "content": { + "type": "string", + "format": "binary" + }, + "metadata": { + "type": "UpdateDocumentObjectContent", + "allOf": [ + { + "$ref": "#/components/schemas/UpdateDocumentObjectContent" + } + ], + "nullable": true + } } }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/LovValue" + "encoding": { + "content": { + "style": "form" + }, + "metadata": { + "style": "form" } } } - }, - "400": { - "description": "Bad Request", + } + }, + "responses": { + "200": { + "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "$ref": "#/components/schemas/Message" } } } }, - "404": { - "description": "Not Found", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -5297,8 +5242,8 @@ } } }, - "default": { - "description": "Error", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -5311,73 +5256,6 @@ } } } - } - } - } - }, - "/v3/Lists/Get": { - "post": { - "tags": [ - "Lists" - ], - "summary": "Get the public list of LOVs.", - "operationId": "GetLovList", - "requestBody": { - "description": "Request object with the criteria in its properties.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/GetLovList" - } - ], - "description": "Represents a get Lov list model." - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/GetLovList" - } - ], - "description": "Represents a get Lov list model." - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/GetLovList" - } - ], - "description": "Represents a get Lov list model." - } - } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LovList" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LovList" - } - } - } - } }, "400": { "description": "Bad Request", @@ -5412,85 +5290,84 @@ } } }, - "/v3/MetadataBinding/Fields/{fieldName}/Levels/{fieldLevel}/Tags/Get": { - "post": { + "/v3/DocumentObjects/ByLogicalId/{LogicalId}/Content": { + "get": { "tags": [ - "MetadataBinding" + "DocumentObjects" ], - "summary": "Gets list of tags that match the criteria given in the parameters for specified field.", - "operationId": "GetMetadataBindingTagList", + "summary": "Gets the contents of the document object with the specified logical ID. Additional filters may also be provided, such as version and language.", + "description": "If no version is specified, the latest version of the object is returned. If no language is specified, the object is returned in the source language.", + "operationId": "GetDocumentObjectContentByLogicalId", "parameters": [ { - "name": "fieldName", + "name": "LogicalId", "in": "path", - "description": "Element name of a field.", + "description": "The logical identifier of the document object.", "required": true, "schema": { - "type": "string" + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The logical identifier of the document object." } }, { - "name": "fieldLevel", - "in": "path", - "description": "Level of an object.", - "required": true, + "name": "Version", + "in": "query", + "description": "The version of the document object.", "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Level" - } - ], - "description": "Enumeration holding the visible InfoShare hierarchy levels." + "type": "string", + "description": "The version of the document object.", + "nullable": true } - } - ], - "requestBody": { - "description": "Request object with the criteria in its properties.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/GetMetadataBindingTagList" - } - ], - "description": "Request object to get metadata bound tags that match the criteria given in the properties." - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/GetMetadataBindingTagList" - } - ], - "description": "Request object to get metadata bound tags that match the criteria given in the properties." - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/GetMetadataBindingTagList" - } - ], - "description": "Request object to get metadata bound tags that match the criteria given in the properties." - } + }, + { + "name": "Language", + "in": "query", + "description": "The language of the document object.", + "schema": { + "maxLength": 255, + "type": "string", + "description": "The language of the document object.", + "nullable": true + } + }, + { + "name": "Resolution", + "in": "query", + "description": "The resolution of the document object.", + "schema": { + "maxLength": 255, + "type": "string", + "description": "The resolution of the document object.", + "nullable": true } } - }, + ], "responses": { "200": { "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + }, + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TagList" + "$ref": "#/components/schemas/InfoShareProblemDetails" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/TagList" + "$ref": "#/components/schemas/InfoShareProblemDetails" } } } @@ -5528,85 +5405,55 @@ } } }, - "/v3/MetadataBinding/Fields/{fieldName}/Levels/{fieldLevel}/TagStructure/Get": { - "post": { + "/v3/DocumentObjects/ByLanguageCardId/{LanguageCardId}/Content/Info": { + "get": { "tags": [ - "MetadataBinding" + "DocumentObjects" ], - "summary": "Gets tags structure that match the criteria given in the parameters for specified field.", - "operationId": "GetMetadataBindingTagStructure", + "summary": "Gets the content information of the document object with the specified language card ID.", + "operationId": "GetDocumentObjectContentInfoByLanguageCardId", "parameters": [ { - "name": "fieldName", - "in": "path", - "description": "Element name of a field.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "fieldLevel", + "name": "LanguageCardId", "in": "path", - "description": "Level of an object.", + "description": "The language card identifier of the document object.", "required": true, "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/Level" - } - ], - "description": "Enumeration holding the visible InfoShare hierarchy levels." + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" } } ], - "requestBody": { - "description": "Request object with the criteria in its properties.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/GetMetadataBindingTagStructure" - } - ], - "description": "Request object to get metadata bound tags structure that match the criteria given in the properties." - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/GetMetadataBindingTagStructure" - } - ], - "description": "Request object to get metadata bound tags structure that match the criteria given in the properties." - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/GetMetadataBindingTagStructure" - } - ], - "description": "Request object to get metadata bound tags structure that match the criteria given in the properties." - } - } - } - }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/TagStructure" + "$ref": "#/components/schemas/ContentInfo" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/TagStructure" + "$ref": "#/components/schemas/ContentInfo" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" } } } @@ -5644,49 +5491,25 @@ } } }, - "/v3/My": { + "/v3/DocumentObjects/ByLanguageCardId/{LanguageCardId}/PossibleTargetStatuses": { "get": { "tags": [ - "My" + "DocumentObjects" ], - "summary": "Gets current user in the repository.", - "operationId": "GetCurrentUser", + "summary": "Gets the possible target workflow statuses (based on the current workflow status) for the document object with the specified language card ID.", + "operationId": "GetDocumentObjectPossibleTargetStatusListByLanguageCardId", "parameters": [ { - "name": "selectedProperties", - "in": "query", - "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectedProperties" - } - ], - "description": "Enumeration holding the selected properties." - } - }, - { - "name": "fieldGroup", - "in": "query", - "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/FieldGroup" - } - ], - "description": "Groups of metadata fields." - } - }, - { - "name": "field", - "in": "query", - "description": "Specifies one or more metadata fields to return.", + "name": "LanguageCardId", + "in": "path", + "description": "The language card identifier of the document object.", + "required": true, "schema": { - "type": "array", - "items": { - "type": "string" - } + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" } } ], @@ -5696,18 +5519,24 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "type": "array", + "items": { + "$ref": "#/components/schemas/LovValue" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/User" + "type": "array", + "items": { + "$ref": "#/components/schemas/LovValue" + } } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -5720,69 +5549,25 @@ } } } - } - } - }, - "put": { - "tags": [ - "My" - ], - "summary": "Update user who made the call.", - "operationId": "UpdateCurrentUser", - "requestBody": { - "description": "Specifies fields that should be updated and values for them.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateCurrentUser" - } - ], - "description": "Represents an update current user model." - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateCurrentUser" - } - ], - "description": "Represents an update current user model." - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateCurrentUser" - } - ], - "description": "Represents an update current user model." - } - } - } - }, - "responses": { - "200": { - "description": "Success", + }, + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Message" + "$ref": "#/components/schemas/InfoShareProblemDetails" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Message" + "$ref": "#/components/schemas/InfoShareProblemDetails" } } } }, - "400": { - "description": "Bad Request", - "content": { + "default": { + "description": "Error", + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InfoShareProblemDetails" @@ -5794,18 +5579,63 @@ } } } + } + } + } + }, + "/v3/DocumentObjects/PossibleTargetStatuses": { + "get": { + "tags": [ + "DocumentObjects" + ], + "summary": "Gets a list of possible target workflow statuses for newly created document objects of the specified object type.", + "operationId": "GetDocumentObjectPossibleTargetStatusList", + "parameters": [ + { + "name": "ObjectType", + "in": "query", + "description": "Type of the document.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/DocumentObjectTypeFilter" + } + ], + "default": "any" + } }, - "403": { - "description": "Forbidden", + { + "name": "ActivityFilter", + "in": "query", + "description": "Filter of activity that limits the possible target statuses to only the active or inactive ones. If not supplied, only the active ones will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/ActivityFilter" + } + ], + "default": "active" + } + } + ], + "responses": { + "200": { + "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "type": "array", + "items": { + "$ref": "#/components/schemas/LovValue" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "type": "array", + "items": { + "$ref": "#/components/schemas/LovValue" + } } } } @@ -5825,6 +5655,21 @@ } } }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, "default": { "description": "Error", "content": { @@ -5843,36 +5688,75 @@ } } }, - "/v3/My/PreferenceSets/{setName}": { - "get": { + "/v3/DocumentObjects": { + "post": { "tags": [ - "My" + "DocumentObjects" ], - "summary": "Get preference set for the current user.", - "operationId": "GetMyPreferences", - "parameters": [ - { - "name": "setName", - "in": "path", - "description": "Name of the preference set to be retrieved.", - "required": true, - "schema": { - "type": "string" + "summary": "Creates a document object.", + "operationId": "CreateDocumentObject", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "required": [ + "content", + "metadata" + ], + "type": "object", + "properties": { + "content": { + "type": "string", + "format": "binary" + }, + "metadata": { + "type": "CreateDocumentObject", + "allOf": [ + { + "$ref": "#/components/schemas/CreateDocumentObject" + } + ] + } + } + }, + "encoding": { + "content": { + "style": "form" + }, + "metadata": { + "style": "form" + } + } } } - ], + }, "responses": { - "200": { - "description": "Success", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PreferenceSet" + "$ref": "#/components/schemas/DocumentObject" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/PreferenceSet" + "$ref": "#/components/schemas/DocumentObject" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" } } } @@ -5892,8 +5776,8 @@ } } }, - "404": { - "description": "Not Found", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -5923,55 +5807,61 @@ } } } - }, - "put": { + } + }, + "/v3/DocumentObjects/ByLanguageCardId/{LanguageCardId}/Content/CheckOut": { + "post": { "tags": [ - "My" + "DocumentObjects" ], - "summary": "Update current user preferences.", - "operationId": "SetMyPreferences", + "summary": "Checks out the document object with the specified language card ID.", + "operationId": "CheckOutDocumentObjectByLanguageCardId", "parameters": [ { - "name": "setName", + "name": "LanguageCardId", "in": "path", - "description": "Name of the current user preference set.", + "description": "The language card identifier of the document object.", "required": true, "schema": { - "type": "string" + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" } } ], "requestBody": { - "description": "Update current user preference set model.", + "description": "Request object with the criteria in its properties.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdatePreferenceSet" + "$ref": "#/components/schemas/CheckOutDocumentObject" } ], - "description": "Represents an update current user preference set model." + "description": "Represents model to check out a document" } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdatePreferenceSet" + "$ref": "#/components/schemas/CheckOutDocumentObject" } ], - "description": "Represents an update current user preference set model." + "description": "Represents model to check out a document" } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdatePreferenceSet" + "$ref": "#/components/schemas/CheckOutDocumentObject" } ], - "description": "Represents an update current user preference set model." + "description": "Represents model to check out a document" } } } @@ -5992,8 +5882,8 @@ } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -6007,8 +5897,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -6022,8 +5912,8 @@ } } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -6055,74 +5945,81 @@ } } }, - "/v3/My/Privileges": { - "get": { - "tags": [ - "My" - ], - "summary": "Get privileges for the current user.", - "operationId": "GetMyPrivileges", - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LovValue" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LovValue" - } - } - } - } - } - } - } - }, - "/v3/Objects/{id}": { - "get": { + "/v3/DocumentObjects/ByLanguageCardId/{LanguageCardId}/Content/CheckIn": { + "post": { "tags": [ - "Objects" + "DocumentObjects" ], - "summary": "Gets the object type based on the object identifier.", - "operationId": "GetObject", + "summary": "Checks in the document object with the specified language card ID.", + "operationId": "CheckInDocumentObjectByLanguageCardId", "parameters": [ { - "name": "id", + "name": "LanguageCardId", "in": "path", - "description": "The object identifier (e.g. logical id GUID-..., language card, folder id 12345678, user id VUSERAUTHOR, user group id VUSERGROUPDEFAULTDEPARTMENT).", + "description": "The language card identifier of the document object.", "required": true, "schema": { - "type": "string" + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" } } ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "required": [ + "content" + ], + "type": "object", + "properties": { + "content": { + "type": "string", + "format": "binary" + }, + "metadata": { + "type": "CheckInDocumentObject", + "allOf": [ + { + "$ref": "#/components/schemas/CheckInDocumentObject" + } + ], + "nullable": true + } + } + }, + "encoding": { + "content": { + "style": "form" + }, + "metadata": { + "style": "form" + } + } + } + } + }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/BaseObject" + "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/BaseObject" + "$ref": "#/components/schemas/Message" } } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -6151,8 +6048,23 @@ } } }, - "default": { - "description": "Error", + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", "content": { "application/json": { "schema": { @@ -6169,31 +6081,81 @@ } } }, - "/v3/Publications": { + "/v3/DocumentObjects/ByLanguageCardId/{LanguageCardId}/Content/UndoCheckout": { "post": { "tags": [ - "Publications" + "DocumentObjects" ], - "summary": "Creates publication. - NOT IMPLEMENTED.", - "operationId": "CreatePublication", + "summary": "Undoes the checkout of the document object with the specified language card ID.", + "operationId": "UndoCheckoutDocumentObjectByLanguageCardId", + "parameters": [ + { + "name": "LanguageCardId", + "in": "path", + "description": "The language card identifier of the document object.", + "required": true, + "schema": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" + } + } + ], + "requestBody": { + "description": "Required current metadata of the object.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UndoCheckoutDocumentObject" + } + ], + "description": "Represents model to undo checkout of a document" + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UndoCheckoutDocumentObject" + } + ], + "description": "Represents model to undo checkout of a document" + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UndoCheckoutDocumentObject" + } + ], + "description": "Represents model to undo checkout of a document" + } + } + } + }, "responses": { - "201": { + "200": { "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Publication" + "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Publication" + "$ref": "#/components/schemas/Message" } } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -6207,8 +6169,23 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -6240,46 +6217,102 @@ } } }, - "/v3/Publications/Versions": { - "post": { + "/v3/DocumentObjects/ByLogicalId/{LogicalId}/Location": { + "get": { "tags": [ - "Publications" + "DocumentObjects" ], - "summary": "Creates version of a publication. - NOT IMPLEMENTED.", - "operationId": "CreatePublicationVersion", - "responses": { - "201": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Publication" + "summary": "Gets the repository folder location of the document object with the specified logical ID. The response is an array of the folders that form the path to this location.", + "operationId": "GetDocumentObjectLocation", + "parameters": [ + { + "name": "LogicalId", + "in": "path", + "description": "The logical identifier of the document object.", + "required": true, + "schema": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The logical identifier of the document object." + } + }, + { + "name": "SelectedProperties", + "in": "query", + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/Publication" + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + } + }, + { + "name": "FieldGroup", + "in": "query", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" } - } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" } }, - "400": { - "description": "Bad Request", + { + "name": "Field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + } + }, + { + "name": "IncludeLinks", + "in": "query", + "description": "true to include the links; otherwise, false. Default is false.", + "schema": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "type": "array", + "items": { + "$ref": "#/components/schemas/Folder" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "type": "array", + "items": { + "$ref": "#/components/schemas/Folder" + } } } } }, - "403": { - "description": "Forbidden", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -6311,25 +6344,75 @@ } } }, - "/v3/Publications/Languages": { + "/v3/DocumentObjects/Versions": { "post": { "tags": [ - "Publications" + "DocumentObjects" ], - "summary": "Creates language of a publication. - NOT IMPLEMENTED.", - "operationId": "CreatePublicationLanguage", + "summary": "Creates a version of a document object.", + "operationId": "CreateDocumentObjectVersion", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "required": [ + "metadata" + ], + "type": "object", + "properties": { + "content": { + "type": "string", + "format": "binary", + "nullable": true + }, + "metadata": { + "type": "CreateDocumentObjectVersion", + "allOf": [ + { + "$ref": "#/components/schemas/CreateDocumentObjectVersion" + } + ] + } + } + }, + "encoding": { + "content": { + "style": "form" + }, + "metadata": { + "style": "form" + } + } + } + } + }, "responses": { "201": { - "description": "Success", + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Publication" + "$ref": "#/components/schemas/DocumentObject" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Publication" + "$ref": "#/components/schemas/DocumentObject" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" } } } @@ -6349,8 +6432,8 @@ } } }, - "403": { - "description": "Forbidden", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -6382,78 +6465,66 @@ } } }, - "/v3/Publications/ByLanguageCardId/{languageCardId}": { - "put": { + "/v3/DocumentObjects/Languages": { + "post": { "tags": [ - "Publications" - ], - "summary": "Updates the publication output by its language card identifier.", - "operationId": "UpdatePublicationByLanguageCardId", - "parameters": [ - { - "name": "languageCardId", - "in": "path", - "description": "Language card identifier of the publication output.", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } + "DocumentObjects" ], + "summary": "Creates a language of a version of a document object.", + "operationId": "CreateDocumentObjectLanguage", "requestBody": { - "description": "Request object with the criteria in its properties.", "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdatePublication" - } - ], - "description": "Represents an update model for publication." - } - }, - "text/json": { + "multipart/form-data": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdatePublication" - } + "required": [ + "metadata" ], - "description": "Represents an update model for publication." - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdatePublication" + "type": "object", + "properties": { + "content": { + "type": "string", + "format": "binary", + "nullable": true + }, + "metadata": { + "type": "CreateDocumentObjectLanguage", + "allOf": [ + { + "$ref": "#/components/schemas/CreateDocumentObjectLanguage" + } + ] } - ], - "description": "Represents an update model for publication." + } + }, + "encoding": { + "content": { + "style": "form" + }, + "metadata": { + "style": "form" + } } } } }, "responses": { - "200": { - "description": "Success", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Message" + "$ref": "#/components/schemas/DocumentObject" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Message" + "$ref": "#/components/schemas/DocumentObject" } } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -6467,8 +6538,8 @@ } } }, - "403": { - "description": "Forbidden", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -6482,8 +6553,8 @@ } } }, - "404": { - "description": "Not Found", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -6513,36 +6584,94 @@ } } } - }, - "delete": { + } + }, + "/v3/DocumentObjects/ByLogicalId/{LogicalId}/ByVersion/{Version}/UsedInPublications/Get": { + "post": { "tags": [ - "Publications" + "DocumentObjects" ], - "summary": "Deletes publication. - NOT IMPLEMENTED.", - "operationId": "DeletePublicationByLanguageCardId", + "summary": "Gets the list of publications that reference the document object specified by the logical ID and version.", + "operationId": "GetPublicationListUsingDocumentObject", "parameters": [ { - "name": "languageCardId", + "name": "LogicalId", "in": "path", + "description": "The logical identifier of the referenced document object.", "required": true, "schema": { - "type": "integer", - "format": "int64" + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The logical identifier of the referenced document object." + } + }, + { + "name": "Version", + "in": "path", + "description": "The version of the referenced document object.", + "required": true, + "schema": { + "minLength": 1, + "type": "string", + "description": "The version of the referenced document object." } } ], + "requestBody": { + "description": "Request body to get all publications in the Repository that are referencing the document object specified by the logical identifier and version.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetPublicationListUsingDocumentObject" + } + ], + "description": "Request body to get all publications in the Repository that are referencing a document object specified by the logical identifier and version." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetPublicationListUsingDocumentObject" + } + ], + "description": "Request body to get all publications in the Repository that are referencing a document object specified by the logical identifier and version." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetPublicationListUsingDocumentObject" + } + ], + "description": "Request body to get all publications in the Repository that are referencing a document object specified by the logical identifier and version." + } + } + } + }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/Publication" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/Publication" + } } } } @@ -6562,8 +6691,8 @@ } } }, - "403": { - "description": "Forbidden", + "default": { + "description": "Error", "content": { "application/json": { "schema": { @@ -6576,9 +6705,91 @@ } } } + } + } + } + }, + "/v3/DocumentObjects/ByLogicalId/{LogicalId}/UsedInDocumentObjects/Get": { + "post": { + "tags": [ + "DocumentObjects" + ], + "summary": "Gets the list of document objects that reference the document object specified by the logical ID.", + "operationId": "GetDocumentObjectListUsingDocumentObject", + "parameters": [ + { + "name": "LogicalId", + "in": "path", + "description": "The logical identifier of the referenced document object.", + "required": true, + "schema": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The logical identifier of the referenced document object." + } + } + ], + "requestBody": { + "description": "Request body to get all document objects in the Repository that are referencing the document object specified by the logical identifier.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetDocumentObjectListUsingDocumentObject" + } + ], + "description": "Request object to get all objects in the repository that are referencing the given logical id." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetDocumentObjectListUsingDocumentObject" + } + ], + "description": "Request object to get all objects in the repository that are referencing the given logical id." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetDocumentObjectListUsingDocumentObject" + } + ], + "description": "Request object to get all objects in the repository that are referencing the given logical id." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObject" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObject" + } + } + } + } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -6608,67 +6819,41 @@ } } } - }, + } + }, + "/v3/DocumentObjects/ByLanguageCardId/{LanguageCardId}/References": { "get": { "tags": [ - "Publications" + "DocumentObjects" ], - "summary": "Get publication in the Repository that match the criteria given in the parameters.", - "operationId": "GetPublicationByLanguageCardId", + "summary": "Gets the list of logical IDs of all document objects referenced by the language object specified by the language card ID.", + "operationId": "GetDocumentObjectReferenceListByLanguageCardId", "parameters": [ { - "name": "languageCardId", + "name": "LanguageCardId", "in": "path", - "description": "Language card identifier of the publication.", + "description": "The language card identifier of the document object.", "required": true, "schema": { + "maximum": 9999999999, + "minimum": 1, "type": "integer", + "description": "The language card identifier of the document object.", "format": "int64" } }, { - "name": "selectedProperties", - "in": "query", - "description": "Selected properties to filter the properties. Default is Id.", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectedProperties" - } - ], - "description": "Enumeration holding the selected properties." - } - }, - { - "name": "fieldGroup", + "name": "LinkType", "in": "query", - "description": "Field group of metadata fields. Default is None.", + "description": "The enumeration indicating which link fields must be used.", "schema": { "allOf": [ { - "$ref": "#/components/schemas/FieldGroup" + "$ref": "#/components/schemas/LinkType" } ], - "description": "Groups of metadata fields." - } - }, - { - "name": "field", - "in": "query", - "description": "Specifies one or more metadata fields to return.", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "includeLinks", - "in": "query", - "description": "{true} to include the links; otherwise, {false}. Default is {false}.", - "schema": { - "type": "boolean" + "description": "The enumeration indicating which link fields must be used.", + "default": "all" } } ], @@ -6678,12 +6863,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Publication" + "type": "array", + "items": { + "type": "string" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Publication" + "type": "array", + "items": { + "type": "string" + } } } } @@ -6703,21 +6894,6 @@ } } }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, "default": { "description": "Error", "content": { @@ -6736,82 +6912,59 @@ } } }, - "/v3/Publications/ByLogicalId/{logicalId}": { - "put": { + "/v3/DocumentObjects/ByLanguageCardId/{LanguageCardId}/SmartTags/Get": { + "post": { "tags": [ - "Publications" + "DocumentObjects" ], - "summary": "Updates publication in the repository that match the criteria given in the parameters.", - "operationId": "UpdatePublicationByLogicalId", + "summary": "Gets the set of smart tags for the document object specified by the language card ID.", + "operationId": "GetDocumentObjectSmartTagListByLanguageCardId", "parameters": [ { - "name": "logicalId", + "name": "LanguageCardId", "in": "path", - "description": "Logical identifier of the publication.", + "description": "The language card identifier of the document object.", "required": true, "schema": { - "type": "string" - } - }, - { - "name": "version", - "in": "query", - "description": "The version of the publication to update.", - "schema": { - "type": "string" - } - }, - { - "name": "outputFormat", - "in": "query", - "description": "The output Format of the publication to update.", - "schema": { - "type": "string" - } - }, - { - "name": "languageCombination", - "in": "query", - "description": "The languageCombination of the publication to update.", - "schema": { - "type": "array", - "items": { - "type": "string" - } + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" } } ], "requestBody": { - "description": "Request object with the criteria in its properties.", + "description": "Request body holding information such as requested fields and their current values.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdatePublication" + "$ref": "#/components/schemas/GetDocumentObjectSmartTagsByLanguageCardId" } ], - "description": "Represents an update model for publication." + "description": "Request parameters to get smart tags of an object." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdatePublication" + "$ref": "#/components/schemas/GetDocumentObjectSmartTagsByLanguageCardId" } ], - "description": "Represents an update model for publication." + "description": "Request parameters to get smart tags of an object." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdatePublication" + "$ref": "#/components/schemas/GetDocumentObjectSmartTagsByLanguageCardId" } ], - "description": "Represents an update model for publication." + "description": "Request parameters to get smart tags of an object." } } } @@ -6822,12 +6975,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/FieldTag" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Message" + "type": "array", + "items": { + "$ref": "#/components/schemas/FieldTag" + } } } } @@ -6847,36 +7006,6 @@ } } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, "default": { "description": "Error", "content": { @@ -6893,42 +7022,62 @@ } } } - }, - "delete": { + } + }, + "/v3/DocumentObjects/ByLanguageCardId/BackgroundTasks": { + "post": { "tags": [ - "Publications" + "DocumentObjects" ], - "summary": "Deletes publication. - NOT IMPLEMENTED.", - "operationId": "DeletePublicationByLogicalId", - "parameters": [ - { - "name": "logicalId", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "version", - "in": "query", - "schema": { - "type": "string" + "summary": "Creates a background task for the set of language card IDs provided in the request, and with the event type specified in the request.", + "operationId": "CreateBackgroundTaskForDocumentObjectByLanguageCardId", + "requestBody": { + "description": "Parameters holding information such as even type and language card identifiers.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateBackgroundTaskForDocumentObjectByLanguageCardId" + } + ], + "description": "Request object to create background task for language card identifiers." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateBackgroundTaskForDocumentObjectByLanguageCardId" + } + ], + "description": "Request object to create background task for language card identifiers." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateBackgroundTaskForDocumentObjectByLanguageCardId" + } + ], + "description": "Request object to create background task for language card identifiers." + } } } - ], + }, "responses": { - "200": { - "description": "Success", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Message" + "$ref": "#/components/schemas/BackgroundTask" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Message" + "$ref": "#/components/schemas/BackgroundTask" } } } @@ -6948,36 +7097,6 @@ } } }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, "default": { "description": "Error", "content": { @@ -6994,93 +7113,77 @@ } } } - }, + } + }, + "/v3/ElectronicDocumentTypes/{Id}": { "get": { "tags": [ - "Publications" + "ElectronicDocumentTypes" ], - "summary": "Get publication in the Repository that match the criteria given in the parameters.", - "operationId": "GetPublicationByLogicalId", + "summary": "Gets the electronic document type with the specified ID.", + "operationId": "GetElectronicDocumentType", "parameters": [ { - "name": "logicalId", + "name": "Id", "in": "path", - "description": "The logical identifier of the object.", + "description": "The identifier of the electronic document type.", "required": true, "schema": { - "type": "string" - } - }, - { - "name": "version", - "in": "query", - "description": "The version number.", - "schema": { - "type": "string" - } - }, - { - "name": "outputFormat", - "in": "query", - "description": "The label/name of the OutputFormat (e.g. Manual, Documentation Online,...).", - "schema": { - "type": "string" - } - }, - { - "name": "languageCombination", - "in": "query", - "description": "The language combination of the PublicationOutput (e.g. en, en+fr+nl,...).", - "schema": { - "type": "array", - "items": { - "type": "string" - } + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the electronic document type." } }, { - "name": "selectedProperties", + "name": "SelectedProperties", "in": "query", - "description": "Selected properties to filter the properties. Default is Id.", + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", "schema": { "allOf": [ { "$ref": "#/components/schemas/SelectedProperties" } ], - "description": "Enumeration holding the selected properties." + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" } }, { - "name": "fieldGroup", + "name": "FieldGroup", "in": "query", - "description": "Field group of metadata fields. Default is None.", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", "schema": { "allOf": [ { "$ref": "#/components/schemas/FieldGroup" } ], - "description": "Groups of metadata fields." + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" } }, { - "name": "field", + "name": "Field", "in": "query", "description": "Specifies one or more metadata fields to return.", "schema": { "type": "array", "items": { "type": "string" - } + }, + "description": "Specifies one or more metadata fields to return." } }, { - "name": "includeLinks", + "name": "IncludeLinks", "in": "query", - "description": "{true} to include the links; otherwise, {false}. Default is {false}.", + "description": "true to include the links; otherwise, false. Default is false.", "schema": { - "type": "boolean" + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false } } ], @@ -7090,18 +7193,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Publication" + "$ref": "#/components/schemas/ElectronicDocumentType" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Publication" + "$ref": "#/components/schemas/ElectronicDocumentType" } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -7115,8 +7218,8 @@ } } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -7146,58 +7249,59 @@ } } } - } - }, - "/v3/Publications/ByLanguageCardId/{languageCardId}/Release": { - "post": { + }, + "put": { "tags": [ - "Publications" + "ElectronicDocumentTypes" ], - "summary": "Releases the publication output by its language card identifier.", - "operationId": "ReleasePublication", + "summary": "Updates the electronic document type with the specified ID.", + "operationId": "UpdateElectronicDocumentType", "parameters": [ { - "name": "languageCardId", + "name": "Id", "in": "path", - "description": "Language card identifier of the publication output.", + "description": "Identifier of the electronic document type.", "required": true, "schema": { - "type": "integer", - "format": "int64" + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the electronic document type." } } ], "requestBody": { - "description": "Request object with the criteria in its properties.", + "description": "Request body with a list of the fields.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/ReleasePublication" + "$ref": "#/components/schemas/UpdateElectronicDocumentType" } ], - "description": "Represents a release model for publication." + "description": "Represents an update electronic document type model" } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/ReleasePublication" + "$ref": "#/components/schemas/UpdateElectronicDocumentType" } ], - "description": "Represents a release model for publication." + "description": "Represents an update electronic document type model" } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/ReleasePublication" + "$ref": "#/components/schemas/UpdateElectronicDocumentType" } ], - "description": "Represents a release model for publication." + "description": "Represents an update electronic document type model" } } } @@ -7218,8 +7322,8 @@ } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -7233,8 +7337,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -7248,8 +7352,23 @@ } } }, - "404": { - "description": "Not Found", + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -7279,62 +7398,28 @@ } } } - } - }, - "/v3/Publications/ByLanguageCardId/{languageCardId}/Unrelease": { - "post": { + }, + "delete": { "tags": [ - "Publications" + "ElectronicDocumentTypes" ], - "summary": "Unreleases the publication output by its language card identifier.", - "operationId": "UnreleasePublication", + "summary": "Deletes the electronic document type with the specified ID.", + "operationId": "DeleteElectronicDocumentType", "parameters": [ { - "name": "languageCardId", + "name": "Id", "in": "path", - "description": "Language card identifier of the publication output.", + "description": "Identifier of the electronic document type.", "required": true, "schema": { - "type": "integer", - "format": "int64" + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the electronic document type." } } ], - "requestBody": { - "description": "Request object with the criteria in its properties.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UnreleasePublication" - } - ], - "description": "Model representing parameters for unreleasing a publication" - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UnreleasePublication" - } - ], - "description": "Model representing parameters for unreleasing a publication" - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UnreleasePublication" - } - ], - "description": "Model representing parameters for unreleasing a publication" - } - } - } - }, "responses": { "200": { "description": "Success", @@ -7351,8 +7436,8 @@ } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -7366,8 +7451,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -7381,8 +7466,8 @@ } } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -7414,67 +7499,75 @@ } } }, - "/v3/Publications/ByLogicalId/Get": { + "/v3/ElectronicDocumentTypes": { "post": { "tags": [ - "Publications" + "ElectronicDocumentTypes" ], - "summary": "Gets all publications in the Repository that match the criteria given in the parameters.", - "description": "Depending on which status filter is specified, the objects with following status types can be returned:\r\n
Status filterReturned status types
AllAll status types
LatestReleasedLatest released excluding out-of-date
DraftOrLatestReleasedDraft and latest released excluding out-of-date
AllReleasedAll released including out-of-date
", - "operationId": "GetPublicationListByLogicalId", + "summary": "Creates an electronic document type.", + "operationId": "CreateElectronicDocumentType", "requestBody": { - "description": "Request object with the criteria in its properties.", + "description": "Request body with a list of the fields.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetPublicationListByLogicalId" + "$ref": "#/components/schemas/CreateElectronicDocumentType" } ], - "description": "Request object to get all publications in the repository that match the criteria given in the properties." + "description": "The request object to create an electronic document type." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetPublicationListByLogicalId" + "$ref": "#/components/schemas/CreateElectronicDocumentType" } ], - "description": "Request object to get all publications in the repository that match the criteria given in the properties." + "description": "The request object to create an electronic document type." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetPublicationListByLogicalId" + "$ref": "#/components/schemas/CreateElectronicDocumentType" } ], - "description": "Request object to get all publications in the repository that match the criteria given in the properties." + "description": "The request object to create an electronic document type." } } } }, "responses": { - "200": { - "description": "Success", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Publication" - } + "$ref": "#/components/schemas/ElectronicDocumentType" } }, "text/json": { "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Publication" - } + "$ref": "#/components/schemas/ElectronicDocumentType" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" } } } @@ -7494,6 +7587,21 @@ } } }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, "default": { "description": "Error", "content": { @@ -7512,14 +7620,13 @@ } } }, - "/v3/Publications/Get": { + "/v3/ElectronicDocumentTypes/Get": { "post": { "tags": [ - "Publications" + "ElectronicDocumentTypes" ], - "summary": "Gets all publications in the Repository that match the criteria given in the parameters.", - "description": "Depending on which status filter is specified, the objects with following status types can be returned:\r\n
Status filterReturned status types
AllAll status types
LatestReleasedLatest released excluding out-of-date
DraftOrLatestReleasedDraft and latest released excluding out-of-date
AllReleasedAll released including out-of-date
", - "operationId": "GetPublicationList", + "summary": "Gets the set of electronic document types that match the filter criteria.", + "operationId": "GetElectronicDocumentTypeList", "requestBody": { "description": "Request object with the criteria in its properties.", "content": { @@ -7527,30 +7634,30 @@ "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetPublicationList" + "$ref": "#/components/schemas/GetElectronicDocumentTypeList" } ], - "description": "Request object to get all objects in the repository that match the criteria given in the properties." + "description": "Request object to get all electronic document types in the repository that match the criteria given in the properties." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetPublicationList" + "$ref": "#/components/schemas/GetElectronicDocumentTypeList" } ], - "description": "Request object to get all objects in the repository that match the criteria given in the properties." + "description": "Request object to get all electronic document types in the repository that match the criteria given in the properties." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetPublicationList" + "$ref": "#/components/schemas/GetElectronicDocumentTypeList" } ], - "description": "Request object to get all objects in the repository that match the criteria given in the properties." + "description": "Request object to get all electronic document types in the repository that match the criteria given in the properties." } } } @@ -7563,7 +7670,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/Publication" + "$ref": "#/components/schemas/ElectronicDocumentType" } } }, @@ -7571,7 +7678,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/Publication" + "$ref": "#/components/schemas/ElectronicDocumentType" } } } @@ -7610,86 +7717,66 @@ } } }, - "/v3/Publications/ByLanguageCardId/Get": { + "/v3/Events": { "post": { "tags": [ - "Publications" + "Events" ], - "summary": "Get publication.", - "operationId": "GetPublicationListByLanguageCardId", + "summary": "Creates an event.", + "operationId": "CreateEvent", "requestBody": { + "description": "The create event model.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetPublicationListByLanguageCardId" + "$ref": "#/components/schemas/CreateEvent" } ], - "description": "Request object to get all publications in the repository that match the criteria given in the properties." + "description": "Represents a create event model." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetPublicationListByLanguageCardId" + "$ref": "#/components/schemas/CreateEvent" } ], - "description": "Request object to get all publications in the repository that match the criteria given in the properties." + "description": "Represents a create event model." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetPublicationListByLanguageCardId" + "$ref": "#/components/schemas/CreateEvent" } ], - "description": "Request object to get all publications in the repository that match the criteria given in the properties." + "description": "Represents a create event model." } } } }, "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Publication" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Publication" - } - } - } - } - }, - "400": { - "description": "Bad Request", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "$ref": "#/components/schemas/EventProgress" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "$ref": "#/components/schemas/EventProgress" } } } }, - "default": { - "description": "Error", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -7702,40 +7789,6 @@ } } } - } - } - } - }, - "/v3/Publications/ByLanguageCardId/{languageCardId}/Content": { - "get": { - "tags": [ - "Publications" - ], - "summary": "Gets the content by its language card identifier.", - "operationId": "GetPublicationContentByLanguageCardId", - "parameters": [ - { - "name": "languageCardId", - "in": "path", - "description": "Language card identifier of the publication.", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } - } }, "400": { "description": "Bad Request", @@ -7752,8 +7805,8 @@ } } }, - "404": { - "description": "Not Found", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -7785,174 +7838,57 @@ } } }, - "/v3/Publications/ByLogicalId/{logicalId}/Location": { - "get": { + "/v3/Events/ByProgressId/{ProgressId}": { + "delete": { "tags": [ - "Publications" + "Events" ], - "summary": "Gets the location of a publication in the folder structure.", - "operationId": "GetPublicationLocation", + "summary": "Deletes the event with the specified progress ID.", + "operationId": "DeleteEvent", "parameters": [ { - "name": "logicalId", + "name": "ProgressId", "in": "path", - "description": "Logical identifier of the publication.", "required": true, "schema": { - "type": "string" - } - }, - { - "name": "selectedProperties", - "in": "query", - "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectedProperties" - } - ], - "description": "Enumeration holding the selected properties." - } - }, - { - "name": "fieldGroup", - "in": "query", - "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/FieldGroup" - } - ], - "description": "Groups of metadata fields." - } - }, - { - "name": "field", - "in": "query", - "description": "Specifies one or more metadata fields to return.", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "includeLinks", - "in": "query", - "description": "true to include the links; otherwise, false. Default is false.", - "schema": { - "type": "boolean" - } - } - ], - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Folder" - } - } - }, - "text/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Folder" - } - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, - "default": { - "description": "Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - } - } - } - }, - "/v3/Publications/ByLanguageCardId/{languageCardId}/CancelPublish": { - "post": { - "tags": [ - "Publications" - ], - "summary": "Cancels the publishing of the publication output.", - "operationId": "CancelPublicationPublish", - "parameters": [ - { - "name": "languageCardId", - "in": "path", - "description": "Language card identifier of the publication output.", - "required": true, - "schema": { - "type": "integer", - "format": "int64" + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "format": "int64" } } ], "requestBody": { - "description": "Request object with the criteria in its properties.", + "description": "The delete event model.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CancelPublicationPublish" + "$ref": "#/components/schemas/DeleteEvent" } ], - "description": "Represents an update model for CancelPublicationPublish." + "description": "Represents a delete event model." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CancelPublicationPublish" + "$ref": "#/components/schemas/DeleteEvent" } ], - "description": "Represents an update model for CancelPublicationPublish." + "description": "Represents a delete event model." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CancelPublicationPublish" + "$ref": "#/components/schemas/DeleteEvent" } ], - "description": "Represents an update model for CancelPublicationPublish." + "description": "Represents a delete event model." } } } @@ -7973,8 +7909,8 @@ } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -7988,8 +7924,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -8003,8 +7939,8 @@ } } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -8034,62 +7970,64 @@ } } } - } - }, - "/v3/Publications/ByLanguageCardId/{languageCardId}/Publish": { - "post": { + }, + "get": { "tags": [ - "Publications" + "Events" ], - "summary": "Publishes a publication output.", - "operationId": "PublishPublication", + "summary": "Gets the event with the specified progress ID.", + "operationId": "GetEventByProgressId", "parameters": [ { - "name": "languageCardId", + "name": "ProgressId", "in": "path", - "description": "Language card identifier of the publication output.", + "description": "Identifier of an event.", "required": true, "schema": { + "maximum": 9999999999, + "minimum": 1, "type": "integer", + "description": "Identifier of an event.", "format": "int64" } - } - ], - "requestBody": { - "description": "Required current metadata of the object.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/PublishPublication" - } - ], - "description": "Represents a publish model for publication." - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/PublishPublication" - } - ], - "description": "Represents a publish model for publication." - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/PublishPublication" - } - ], - "description": "Represents a publish model for publication." - } + }, + { + "name": "FieldGroup", + "in": "query", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + } + }, + { + "name": "Field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + } + }, + { + "name": "IncludeLinks", + "in": "query", + "description": "true to include the links; otherwise, false. Default is false.", + "schema": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false } } - }, + ], "responses": { "200": { "description": "Success", @@ -8106,23 +8044,8 @@ } } }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, - "403": { - "description": "Forbidden", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -8136,8 +8059,8 @@ } } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -8169,56 +8092,57 @@ } } }, - "/v3/Publications/ByLanguageCardId/{languageCardId}/Unpublish": { + "/v3/Events/ByProgressId/{ProgressId}/Terminate": { "post": { "tags": [ - "Publications" + "Events" ], - "summary": "Unpublish a publication output.", - "operationId": "UnpublishPublication", + "summary": "Terminates the event with the specified progress ID.", + "operationId": "TerminateEvent", "parameters": [ { - "name": "languageCardId", + "name": "ProgressId", "in": "path", - "description": "Language card identifier of the publication output.", "required": true, "schema": { + "maximum": 9999999999, + "minimum": 1, "type": "integer", "format": "int64" } } ], "requestBody": { - "description": "Required current metadata of the object.", + "description": "The terminate event model.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UnpublishPublication" + "$ref": "#/components/schemas/TerminateEvent" } ], - "description": "Represents an unpublish model for publication." + "description": "Represents a terminate event model." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UnpublishPublication" + "$ref": "#/components/schemas/TerminateEvent" } ], - "description": "Represents an unpublish model for publication." + "description": "Represents a terminate event model." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UnpublishPublication" + "$ref": "#/components/schemas/TerminateEvent" } ], - "description": "Represents an unpublish model for publication." + "description": "Represents a terminate event model." } } } @@ -8229,18 +8153,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/EventProgress" + "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/EventProgress" + "$ref": "#/components/schemas/Message" } } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -8254,8 +8178,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -8269,8 +8193,8 @@ } } }, - "404": { - "description": "Not Found", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -8284,7 +8208,22 @@ } } }, - "default": { + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { "description": "Error", "content": { "application/json": { @@ -8302,13 +8241,13 @@ } } }, - "/v3/Search": { + "/v3/Events/ByProgressId/Get": { "post": { "tags": [ - "Search" + "Events" ], - "summary": "Search all document object types in the repository that match the criteria given in the parameters.", - "operationId": "Search", + "summary": "Gets the events with the specified progress IDs (and matching possible additional filter criteria).", + "operationId": "GetEventListByProgressId", "requestBody": { "description": "Request object with the criteria in its properties.", "content": { @@ -8316,30 +8255,30 @@ "schema": { "allOf": [ { - "$ref": "#/components/schemas/SearchRequest" + "$ref": "#/components/schemas/GetEventListByProgressId" } ], - "description": "Represents search request criteria to find document objects." + "description": "Request object to get all objects in the repository that match the criteria given in the properties." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/SearchRequest" + "$ref": "#/components/schemas/GetEventListByProgressId" } ], - "description": "Represents search request criteria to find document objects." + "description": "Request object to get all objects in the repository that match the criteria given in the properties." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/SearchRequest" + "$ref": "#/components/schemas/GetEventListByProgressId" } ], - "description": "Represents search request criteria to find document objects." + "description": "Request object to get all objects in the repository that match the criteria given in the properties." } } } @@ -8350,12 +8289,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SearchResponse" + "type": "array", + "items": { + "$ref": "#/components/schemas/EventProgress" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/SearchResponse" + "type": "array", + "items": { + "$ref": "#/components/schemas/EventProgress" + } } } } @@ -8393,51 +8338,66 @@ } } }, - "/v3/Settings": { - "get": { + "/v3/Events/ByParentProgressId/Get": { + "post": { "tags": [ - "Settings" + "Events" ], - "summary": "Get settings in the repository that match the criteria given in the parameters.", - "operationId": "GetSettings", - "parameters": [ - { - "name": "field", - "in": "query", - "description": "Specifies one or more metadata fields to return.", - "schema": { - "type": "array", - "items": { - "type": "string" + "summary": "Gets the events with the specified parent progress IDs (and matching possible additional filter criteria).", + "operationId": "GetEventListByParentProgressId", + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetEventListByParentProgressId" + } + ], + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetEventListByParentProgressId" + } + ], + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetEventListByParentProgressId" + } + ], + "description": "Request object to get all objects in the repository that match the criteria given in the properties." } - } - }, - { - "name": "selectedProperties", - "in": "query", - "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectedProperties" - } - ], - "description": "Enumeration holding the selected properties." } } - ], + }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Setting" + "type": "array", + "items": { + "$ref": "#/components/schemas/EventProgress" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Setting" + "type": "array", + "items": { + "$ref": "#/components/schemas/EventProgress" + } } } } @@ -8457,21 +8417,6 @@ } } }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, "default": { "description": "Error", "content": { @@ -8488,66 +8433,68 @@ } } } - }, - "put": { + } + }, + "/v3/Events/Details": { + "post": { "tags": [ - "Settings" + "Events" ], - "summary": "Update submitted settings fields if the current required fields conditions are satisfied", - "operationId": "UpdateSettings", + "summary": "Creates an event detail for the specified progress ID, optionally with the content specified.", + "operationId": "CreateEventDetail", "requestBody": { - "description": "Update settings model", "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateSettings" - } - ], - "description": "Represents an update settings model." - } - }, - "text/json": { + "multipart/form-data": { "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateSettings" - } + "required": [ + "metadata" ], - "description": "Represents an update settings model." - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateSettings" + "type": "object", + "properties": { + "content": { + "type": "string", + "format": "binary", + "nullable": true + }, + "metadata": { + "type": "CreateEventDetail", + "allOf": [ + { + "$ref": "#/components/schemas/CreateEventDetail" + } + ] } - ], - "description": "Represents an update settings model." + } + }, + "encoding": { + "content": { + "style": "form" + }, + "metadata": { + "style": "form" + } } } } }, "responses": { - "200": { - "description": "Success", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Message" + "$ref": "#/components/schemas/EventProgress" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Message" + "$ref": "#/components/schemas/EventProgress" } } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -8561,8 +8508,8 @@ } } }, - "403": { - "description": "Forbidden", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -8576,8 +8523,8 @@ } } }, - "404": { - "description": "Not Found", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -8609,25 +8556,66 @@ } } }, - "/v3/Settings/WorkflowReport": { - "get": { + "/v3/Events/Overview/Get": { + "post": { "tags": [ - "Settings" + "Events" ], - "summary": "Get settings of the workflow report.", - "operationId": "GetWorkflowReportSettings", + "summary": "Gets an overview of the list of events that match the specified filter criteria.", + "operationId": "GetEventOverview", + "requestBody": { + "description": "The event overview model.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetEventOverview" + } + ], + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetEventOverview" + } + ], + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetEventOverview" + } + ], + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + } + } + } + }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/WorkflowReportSettings" + "type": "array", + "items": { + "$ref": "#/components/schemas/EventProgress" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/WorkflowReportSettings" + "type": "array", + "items": { + "$ref": "#/components/schemas/EventProgress" + } } } } @@ -8665,100 +8653,44 @@ } } }, - "/v3/Settings/TranslationReport": { - "get": { + "/v3/Events/ByProgressId/Overview/Get": { + "post": { "tags": [ - "Settings" + "Events" ], - "summary": "Get settings of the translation report.", - "operationId": "GetTranslationReportSettings", - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/TranslationReportSettings" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/TranslationReportSettings" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, - "default": { - "description": "Error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - } - } - } - }, - "/v3/UserGroups/Get": { - "post": { - "tags": [ - "UserGroups" - ], - "summary": "Gets the user groups.", - "operationId": "GetUserGroupList", + "summary": "Gets an overview of the list of events with the specified progress IDs (and matching possible additional filter criteria).", + "operationId": "GetEventByProgressIdOverview", "requestBody": { - "description": "Request object with the criteria in its properties.", + "description": "The event overview by progressId model.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetUserGroupList" + "$ref": "#/components/schemas/GetEventOverviewByProgressId" } ], - "description": "Request object to get all user groups in the repository that match the criteria given in the properties." + "description": "Request object to get all objects in the repository that match the criteria given in the properties." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetUserGroupList" + "$ref": "#/components/schemas/GetEventOverviewByProgressId" } ], - "description": "Request object to get all user groups in the repository that match the criteria given in the properties." + "description": "Request object to get all objects in the repository that match the criteria given in the properties." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/GetUserGroupList" + "$ref": "#/components/schemas/GetEventOverviewByProgressId" } ], - "description": "Request object to get all user groups in the repository that match the criteria given in the properties." + "description": "Request object to get all objects in the repository that match the criteria given in the properties." } } } @@ -8771,7 +8703,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/UserGroup" + "$ref": "#/components/schemas/EventProgress" } } }, @@ -8779,7 +8711,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/UserGroup" + "$ref": "#/components/schemas/EventProgress" } } } @@ -8818,31 +8750,82 @@ } } }, - "/v3/UserGroups": { - "post": { + "/v3/Events/ByDetailId/{DetailId}": { + "get": { "tags": [ - "UserGroups" + "Events" + ], + "summary": "Gets the event with the specified action/detail ID.", + "operationId": "GetEventByDetailId", + "parameters": [ + { + "name": "DetailId", + "in": "path", + "description": "The unique identifier of an event action/detail.", + "required": true, + "schema": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The unique identifier of an event action/detail.", + "format": "int64" + } + }, + { + "name": "FieldGroup", + "in": "query", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + } + }, + { + "name": "Field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + } + }, + { + "name": "IncludeLinks", + "in": "query", + "description": "true to include the links; otherwise, false. Default is false.", + "schema": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + } ], - "summary": "Creates user group. NOT IMPLEMENTED.", - "operationId": "CreateUserGroup", "responses": { - "201": { + "200": { "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/UserGroup" + "$ref": "#/components/schemas/EventProgress" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/UserGroup" + "$ref": "#/components/schemas/EventProgress" } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -8856,8 +8839,8 @@ } } }, - "403": { - "description": "Forbidden", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -8889,20 +8872,24 @@ } } }, - "/v3/UserGroups/{id}": { - "put": { + "/v3/Events/ByEventId/{EventId}": { + "get": { "tags": [ - "UserGroups" + "Events" ], - "summary": "Updates user group. NOT IMPLEMENTED.", - "operationId": "UpdateUserGroup", + "summary": "Gets the progress ID of the event with the specified event ID.", + "operationId": "GetEventByEventId", "parameters": [ { - "name": "id", + "name": "EventId", "in": "path", + "description": "The unique identifier of an event.", "required": true, "schema": { - "type": "string" + "maxLength": 255, + "minLength": 1, + "type": "string", + "description": "The unique identifier of an event." } } ], @@ -8912,33 +8899,18 @@ "content": { "application/json": { "schema": { - "type": "string" - } - }, - "text/json": { - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "$ref": "#/components/schemas/EventProgress" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "$ref": "#/components/schemas/EventProgress" } } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -8952,8 +8924,8 @@ } } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -8983,20 +8955,27 @@ } } } - }, - "delete": { + } + }, + "/v3/Events/ByDetailId/{DetailId}/Content": { + "get": { "tags": [ - "UserGroups" + "Events" ], - "summary": "Deletes user group. NOT IMPLEMENTED.", - "operationId": "DeleteUserGroup", + "summary": "Gets the contents of the event with the specified action/detail ID.", + "operationId": "GetEventContentByDetailId", "parameters": [ { - "name": "id", + "name": "DetailId", "in": "path", + "description": "The unique identifier of an event action/detail.", "required": true, "schema": { - "type": "string" + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The unique identifier of an event action/detail.", + "format": "int64" } } ], @@ -9004,35 +8983,16 @@ "200": { "description": "Success", "content": { - "application/json": { - "schema": { - "type": "string" - } - }, - "text/json": { - "schema": { - "type": "string" - } - } - } - }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { + "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "type": "string", + "format": "binary" } } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -9046,8 +9006,8 @@ } } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -9079,48 +9039,13 @@ } } }, - "/v3/Users/Get": { - "post": { + "/v3/Events/Groups": { + "get": { "tags": [ - "Users" + "Events" ], - "summary": "Gets all users in the repository that match the criteria given in the parameters.", - "operationId": "GetUserList", - "requestBody": { - "description": "Request object with the criteria in its properties.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/GetUserList" - } - ], - "description": "Request object to get all users in the repository that match the criteria given in the properties." - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/GetUserList" - } - ], - "description": "Request object to get all users in the repository that match the criteria given in the properties." - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/GetUserList" - } - ], - "description": "Request object to get all users in the repository that match the criteria given in the properties." - } - } - } - }, + "summary": "Gets the collection of all available event groups.", + "operationId": "GetEventGroups", "responses": { "200": { "description": "Success", @@ -9129,7 +9054,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/EventGroup" } } }, @@ -9137,7 +9062,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/EventGroup" } } } @@ -9176,27 +9101,18 @@ } } }, - "/v3/Users/{id}": { + "/v3/Folders/RootFolders": { "get": { "tags": [ - "Users" + "Folders" ], - "summary": "Gets a user in the repository that match the criteria given in the parameters.", - "operationId": "GetUser", + "summary": "Gets the set of root folders of the repository.", + "operationId": "GetRootFolderList", "parameters": [ - { - "name": "id", - "in": "path", - "description": "Identifier of the user.", - "required": true, - "schema": { - "type": "string" - } - }, { "name": "selectedProperties", "in": "query", - "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "description": "Selected properties to filter the properties. Default is Id.", "schema": { "allOf": [ { @@ -9209,7 +9125,7 @@ { "name": "fieldGroup", "in": "query", - "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "description": "Field group of Metadata fields. Default is None.", "schema": { "allOf": [ { @@ -9229,6 +9145,14 @@ "type": "string" } } + }, + { + "name": "includeLinks", + "in": "query", + "description": "`true` to include the links; otherwise, `false`. Default is `false`.", + "schema": { + "type": "boolean" + } } ], "responses": { @@ -9237,13 +9161,19 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "type": "array", + "items": { + "$ref": "#/components/schemas/Folder" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/User" - } + "type": "array", + "items": { + "$ref": "#/components/schemas/Folder" + } + } } } }, @@ -9262,21 +9192,6 @@ } } }, - "404": { - "description": "Not Found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - } - } - }, "default": { "description": "Error", "content": { @@ -9293,107 +9208,134 @@ } } } - }, - "put": { + } + }, + "/v3/Folders/{id}/Objects": { + "get": { "tags": [ - "Users" + "Folders" ], - "summary": "Update user with given id in the repository.", - "operationId": "UpdateUser", + "summary": "Gets the set of objects in the repository folder specified by the folder ID.", + "description": "Depending on which object type is specified, the following types can be returned:\r\n
Object typeReturned types
AnyFolders and contents
FoldersFolder, ReferenceFolder, PublicationFolder, MapFolder, TopicFolder, LibraryFolder, IllustrationFolder and OtherFolder
ContentsPublication, Map, Topic, Library, Illustration and Other
", + "operationId": "GetFolderObjectList", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier of the user.", + "description": "Card identifier of the folder whose objects will be returned, e.g. 25432.", "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "objectType", + "in": "query", + "description": "Specifies whether folders, contents or both will be returned. If not supplied, all types will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FolderObjectTypeFilter" + } + ], + "description": "Enumeration that lists possible folder item types." + } + }, + { + "name": "language", + "in": "query", + "description": "The language for which to retrieve document metadata fields, e.g. VLANGUAGEEN, en. If not supplied, the user language will be used.", "schema": { "type": "string" } - } - ], - "requestBody": { - "description": "Specifies fields that should be updated and values for them.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateUser" - } - ], - "description": "Represents an update user model." - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateUser" - } - ], - "description": "Represents an update user model." - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdateUser" - } - ], - "description": "Represents an update user model." - } + }, + { + "name": "resolution", + "in": "query", + "description": "The resolution for which to retrieve image metadata fields, e.g. VRESLOW, Low. If not supplied, the system resolution will be used.", + "schema": { + "type": "string" } - } - }, - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Message" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/Message" + }, + { + "name": "selectedProperties", + "in": "query", + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" } - } + ], + "description": "Enumeration holding the selected properties." } }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" - } - }, - "text/json": { - "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + { + "name": "fieldGroup", + "in": "query", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" } + ], + "description": "Groups of metadata fields." + } + }, + { + "name": "field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" } } }, - "403": { - "description": "Forbidden", + { + "name": "includeLinks", + "in": "query", + "description": "true to include the links; otherwise, false. Default is false.", + "schema": { + "type": "boolean" + } + }, + { + "name": "includePartialItems", + "in": "query", + "description": "true to include partial items when the version or language is missing; otherwise, false. Default is false.", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "type": "array", + "items": { + "$ref": "#/components/schemas/BaseObject" + } } }, "text/json": { "schema": { - "$ref": "#/components/schemas/InfoShareProblemDetails" + "type": "array", + "items": { + "$ref": "#/components/schemas/BaseObject" + } } } } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -9425,30 +9367,22 @@ } } }, - "/v3/Users/{id}/PreferenceSets/{setName}": { - "get": { + "/v3/Folders/{id}": { + "delete": { "tags": [ - "Users" + "Folders" ], - "summary": "Get preference set for the user.", - "operationId": "GetUserPreferences", + "summary": "Deletes the repository folder specified by the folder ID.", + "operationId": "DeleteFolder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier of the user.", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "setName", - "in": "path", - "description": "Name of the preference set to be retrieved, if the set name can not be found empty preference set is returned.", + "description": "ID of the folder to delete.", "required": true, "schema": { - "type": "string" + "type": "integer", + "format": "int64" } } ], @@ -9458,18 +9392,18 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PreferenceSet" + "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/PreferenceSet" + "$ref": "#/components/schemas/Message" } } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -9498,6 +9432,21 @@ } } }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, "default": { "description": "Error", "content": { @@ -9515,85 +9464,87 @@ } } }, - "put": { + "get": { "tags": [ - "Users" + "Folders" ], - "summary": "Set user preferences based on the specified parameters.", - "operationId": "SetUserPreferences", + "summary": "Gets the properties of the repository folder specified by the folder ID.", + "operationId": "GetFolder", "parameters": [ { "name": "id", "in": "path", - "description": "Identifier of the user.", + "description": "The identifier of the folder.", "required": true, "schema": { - "type": "string" + "type": "integer", + "format": "int64" } }, { - "name": "setName", - "in": "path", - "description": "Name of the preference set to be set.", - "required": true, + "name": "selectedProperties", + "in": "query", + "description": "Specifies which properties to return.", "schema": { - "type": "string" + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Enumeration holding the selected properties." } - } - ], - "requestBody": { - "description": "Update user preference set model.", - "content": { - "application/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdatePreferenceSet" - } - ], - "description": "Represents an update current user preference set model." - } - }, - "text/json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdatePreferenceSet" - } - ], - "description": "Represents an update current user preference set model." - } - }, - "application/*+json": { - "schema": { - "allOf": [ - { - "$ref": "#/components/schemas/UpdatePreferenceSet" - } - ], - "description": "Represents an update current user preference set model." + }, + { + "name": "fieldGroup", + "in": "query", + "description": "Specifies the group of metadata fields to return.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Groups of metadata fields." + } + }, + { + "name": "field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" } } + }, + { + "name": "includeLinks", + "in": "query", + "description": "`true` to include the links; otherwise, `false`. Default is `false`.", + "schema": { + "type": "boolean" + } } - }, + ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Message" + "$ref": "#/components/schemas/Folder" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/Message" + "$ref": "#/components/schemas/Folder" } } } }, - "400": { - "description": "Bad Request", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -9607,8 +9558,8 @@ } } }, - "403": { - "description": "Forbidden", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -9622,8 +9573,8 @@ } } }, - "404": { - "description": "Not Found", + "default": { + "description": "Error", "content": { "application/json": { "schema": { @@ -9636,9 +9587,80 @@ } } } + } + } + }, + "put": { + "tags": [ + "Folders" + ], + "summary": "Updates the repository folder specified by the folder ID.", + "operationId": "UpdateFolder", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of folder.", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "description": "The update folder model.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateFolder" + } + ], + "description": "Represents an update folder model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateFolder" + } + ], + "description": "Represents an update folder model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateFolder" + } + ], + "description": "Represents an update folder model." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } }, - "default": { - "description": "Error", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -9651,35 +9673,24 @@ } } } - } - } - } - }, - "/v3/Users": { - "post": { - "tags": [ - "Users" - ], - "summary": "Creates user. - NOT IMPLEMENTED.", - "operationId": "CreateUser", - "responses": { - "201": { - "description": "Success", + }, + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/InfoShareProblemDetails" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/InfoShareProblemDetails" } } } }, - "400": { - "description": "Bad Request", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -9693,8 +9704,8 @@ } } }, - "403": { - "description": "Forbidden", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -9724,31 +9735,68 @@ } } } - }, - "delete": { + } + }, + "/v3/Folders": { + "post": { "tags": [ - "Users" + "Folders" ], - "summary": "Deletes user. - NOT IMPLEMENTED.", - "operationId": "DeleteUser", + "summary": "Creates a repository folder in the specified parent folder.", + "operationId": "CreateFolder", + "requestBody": { + "description": "Model contains the property of the folder to be created.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateFolder" + } + ], + "description": "Represents a create folder model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateFolder" + } + ], + "description": "Represents a create folder model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateFolder" + } + ], + "description": "Represents a create folder model." + } + } + } + }, "responses": { - "200": { - "description": "Success", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/FolderDescriptor" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/FolderDescriptor" } } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -9762,8 +9810,8 @@ } } }, - "403": { - "description": "Forbidden", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -9777,8 +9825,8 @@ } } }, - "404": { - "description": "Not Found", + "409": { + "description": "Conflict", "content": { "application/json": { "schema": { @@ -9810,30 +9858,65 @@ } } }, - "/v3/Workflows/StatusDefinitions": { - "get": { + "/v3/Folders/Get": { + "post": { "tags": [ - "Workflows" + "Folders" ], - "summary": "Get all status definitions.", - "operationId": "GetStatusDefinitionList", - "responses": { - "200": { - "description": "Success", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/StatusDefinition" - } - } - }, + "summary": "Gets the set of repository folders with the specified folder IDs (and matching possible additional filter criteria).", + "operationId": "GetFolderList", + "requestBody": { + "description": "Request folders with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetFolderList" + } + ], + "description": "Request folder to get all folders in the repository that match the criteria given in the properties." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetFolderList" + } + ], + "description": "Request folder to get all folders in the repository that match the criteria given in the properties." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetFolderList" + } + ], + "description": "Request folder to get all folders in the repository that match the criteria given in the properties." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Folder" + } + } + }, "text/json": { "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/StatusDefinition" + "$ref": "#/components/schemas/Folder" } } } @@ -9870,66 +9953,68 @@ } } } - }, + } + }, + "/v3/Folders/MoveFolder": { "post": { "tags": [ - "Workflows" + "Folders" ], - "summary": "Create a status definition.", - "operationId": "CreateStatusDefinition", + "summary": "Moves a repository folder from one folder to another folder.", + "operationId": "MoveFolder", "requestBody": { - "description": "The create status definition model.", + "description": "Represents the model to move a folder.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CreateStatusDefinition" + "$ref": "#/components/schemas/MoveFolder" } ], - "description": "Represents a model for create status definition." + "description": "Represents a move folder model." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CreateStatusDefinition" + "$ref": "#/components/schemas/MoveFolder" } ], - "description": "Represents a model for create status definition." + "description": "Represents a move folder model." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/CreateStatusDefinition" + "$ref": "#/components/schemas/MoveFolder" } ], - "description": "Represents a model for create status definition." + "description": "Represents a move folder model." } } } }, "responses": { - "201": { + "200": { "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StatusDefinition" + "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/StatusDefinition" + "$ref": "#/components/schemas/Message" } } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -9943,8 +10028,38 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -9976,42 +10091,66 @@ } } }, - "/v3/Workflows/StatusDefinitions/{id}": { - "get": { + "/v3/Folders/MoveObject": { + "post": { "tags": [ - "Workflows" + "Folders" ], - "summary": "Get a status definition.", - "operationId": "GetStatusDefinition", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "The status definition id.", - "required": true, - "schema": { - "type": "string" + "summary": "Moves a repository object from one folder to another folder.", + "operationId": "MoveObjectToFolder", + "requestBody": { + "description": "Represents the model to move an object.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/MoveObject" + } + ], + "description": "Represents a move object model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/MoveObject" + } + ], + "description": "Represents a move object model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/MoveObject" + } + ], + "description": "Represents a move object model." + } } } - ], + }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/StatusDefinition" + "$ref": "#/components/schemas/Message" } }, "text/json": { "schema": { - "$ref": "#/components/schemas/StatusDefinition" + "$ref": "#/components/schemas/Message" } } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -10040,6 +10179,36 @@ } } }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, "default": { "description": "Error", "content": { @@ -10056,55 +10225,58 @@ } } } - }, - "put": { + } + }, + "/v3/Folders/{id}/Shortcuts": { + "delete": { "tags": [ - "Workflows" + "Folders" ], - "summary": "Update status definition.", - "operationId": "UpdateStatusDefinition", + "summary": "Removes a shortcut from the shortcut folder specified by the folder ID. The shortcut to remove is specified by logical ID in the model.", + "operationId": "RemoveShortcutFromFolder", "parameters": [ { "name": "id", "in": "path", - "description": "The identifier of the status definition.", + "description": "The identifier of the folder.", "required": true, "schema": { - "type": "string" + "type": "integer", + "format": "int64" } } ], "requestBody": { - "description": "Update status definition model.", + "description": "Represents logical identifier model of the document object or publication for which to remove a shortcut.", "content": { "application/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdateStatusDefinition" + "$ref": "#/components/schemas/RemoveShortcut" } ], - "description": "Represents an update status definition model." + "description": "Represents logical identifier model." } }, "text/json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdateStatusDefinition" + "$ref": "#/components/schemas/RemoveShortcut" } ], - "description": "Represents an update status definition model." + "description": "Represents logical identifier model." } }, "application/*+json": { "schema": { "allOf": [ { - "$ref": "#/components/schemas/UpdateStatusDefinition" + "$ref": "#/components/schemas/RemoveShortcut" } ], - "description": "Represents an update status definition model." + "description": "Represents logical identifier model." } } } @@ -10125,8 +10297,8 @@ } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -10140,8 +10312,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -10155,8 +10327,8 @@ } } }, - "404": { - "description": "Not Found", + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -10187,27 +10359,63 @@ } } }, - "delete": { + "put": { "tags": [ - "Workflows" + "Folders" ], - "summary": "Deletes a status definition by its identifier.", - "operationId": "DeleteStatusDefinition", + "summary": "Adds a shortcut to the shortcut folder specified by the folder ID. The shortcut to add is specified by logical ID in the model.", + "operationId": "AddShortcutToFolder", "parameters": [ { "name": "id", "in": "path", - "description": "The identifier of the status definition.", + "description": "Specifies the card identifier of the folder to which to add the shortcut.", "required": true, "schema": { - "type": "string" + "type": "integer", + "format": "int64" } } ], - "responses": { - "200": { - "description": "Success", - "content": { + "requestBody": { + "description": "Represents logical identifier model of the document object or publication for which to create a shortcut.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/AddShortcut" + } + ], + "description": "Represents logical identifier model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/AddShortcut" + } + ], + "description": "Represents logical identifier model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/AddShortcut" + } + ], + "description": "Represents logical identifier model." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" @@ -10220,8 +10428,8 @@ } } }, - "400": { - "description": "Bad Request", + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -10235,8 +10443,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Not Found", "content": { "application/json": { "schema": { @@ -10250,8 +10458,23 @@ } } }, - "404": { - "description": "Not Found", + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", "content": { "application/json": { "schema": { @@ -10282,1334 +10505,18842 @@ } } } - } - }, - "components": { - "schemas": { - "ActivityFilter": { - "enum": [ - "none", - "active", - "inactive" - ], - "type": "string", - "description": "Allows explicit filtering." - }, - "AddShortcut": { - "required": [ - "logicalId" + }, + "/v3/Folders/{id}/Location": { + "get": { + "tags": [ + "Folders" ], - "type": "object", - "properties": { - "logicalId": { - "minLength": 1, - "type": "string", - "description": "Specify logical identifier of the document object or publication for which to create a shortcut." - } - }, - "additionalProperties": false, - "description": "Represents logical identifier model." - }, - "AndSearchExpression": { - "type": "object", - "allOf": [ + "summary": "Gets the repository folder location of the folder with the specified folder ID.", + "operationId": "GetFolderLocation", + "parameters": [ { - "$ref": "#/components/schemas/GroupSearchExpression" - } - ], - "additionalProperties": false, - "description": "Represents collection of search expression to be evaluated with AND logical operator." - }, - "AnywhereSearchFieldValue": { - "required": [ - "value" - ], - "type": "object", - "allOf": [ + "name": "id", + "in": "path", + "description": "The identifier of the folder.", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, { - "$ref": "#/components/schemas/SearchExpression" - } - ], - "properties": { - "operator": { - "allOf": [ - { - "$ref": "#/components/schemas/FullTextSearchOperator" - } - ], - "description": "The search operator.", - "readOnly": true + "name": "selectedProperties", + "in": "query", + "description": "Specifies which properties to return.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Enumeration holding the selected properties." + } }, - "value": { - "minLength": 1, - "type": "string", - "description": "The value to search for." - } - }, - "additionalProperties": false, - "description": "Represents anywhere search field value." - }, - "BackgroundTask": { - "type": "object", - "properties": { - "taskId": { - "type": "integer", - "description": "The identifier of the task.", - "format": "int64" + { + "name": "fieldGroup", + "in": "query", + "description": "Specifies the group of metadata fields to return.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Groups of metadata fields." + } }, - "progressId": { - "type": "integer", - "description": "The progress id.", - "format": "int64" + { + "name": "field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } }, - "eventId": { - "type": "string", - "description": "The event id." - } - }, - "additionalProperties": false, - "description": "Represents a background task." - }, - "BaseFolder": { - "enum": [ - "none", - "data", - "system", - "favorites", - "editorTemplate" - ], - "type": "string", - "description": "Enumeration holding all base folders." - }, - "BaseItem": { - "required": [ - "type" - ], - "type": "object", - "allOf": [ { - "$ref": "#/components/schemas/RelatedInfo" + "name": "includeLinks", + "in": "query", + "description": "`true` to include the links; otherwise, `false`. Default is `false`.", + "schema": { + "type": "boolean" + } } ], - "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "string", - "description": "The identifier.", - "readOnly": true - }, - "title": { - "type": "string", - "description": "The title.", - "nullable": true + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Folder" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Folder" + } + } + } + } }, - "description": { - "type": "string", - "description": "The description.", - "nullable": true - } - }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Folders/ByFolderPath": { + "get": { + "tags": [ + "Folders" + ], + "summary": "Gets the properties of the repository folder specified by the folder path.", + "operationId": "GetFolderByFolderPath", + "parameters": [ + { + "name": "Path", + "in": "query", + "description": "The path of the folder.", + "required": true, + "schema": { + "minLength": 1, + "type": "string", + "description": "The path of the folder." + } + }, + { + "name": "FieldGroup", + "in": "query", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + } + }, + { + "name": "Fields", + "in": "query", + "description": "A collection of requested metadata fields.", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A collection of requested metadata fields." + } + }, + { + "name": "SelectedProperties", + "in": "query", + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + } + }, + { + "name": "IncludeLinks", + "in": "query", + "description": "true to include the links; otherwise, false. Default is false.", + "schema": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Folder" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Folder" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Inboxes/{id}/Objects/Get": { + "post": { + "tags": [ + "Inboxes" + ], + "summary": "Gets the set of document objects in the inbox specified by the inbox ID.", + "operationId": "GetInboxObjectList", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Specify the ID of the inbox.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetInboxObjectList" + } + ], + "description": "Represents an Inbox object list." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetInboxObjectList" + } + ], + "description": "Represents an Inbox object list." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetInboxObjectList" + } + ], + "description": "Represents an Inbox object list." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObject" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObject" + } + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Inboxes": { + "get": { + "tags": [ + "Inboxes" + ], + "summary": "Gets the set of inboxes.", + "operationId": "GetInboxList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Inbox" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Inbox" + } + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Lists/{id}/Values": { + "get": { + "tags": [ + "Lists" + ], + "summary": "Gets the values in the list of values (LOV) with the specified LOV ID.", + "operationId": "GetLovValueList", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of a list of values (e.g. DRESOLUTION).", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "activityFilter", + "in": "query", + "description": "The filter to limit the result of the active LovValues.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/ActivityFilter" + } + ], + "description": "Allows explicit filtering." + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LovValue" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LovValue" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "post": { + "tags": [ + "Lists" + ], + "summary": "Create a value in the list of values (LOV) with the specified LOV ID.", + "operationId": "CreateLovValue", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The list of values identifier (e.g. DRESOLUTION).", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateLovValue" + } + ], + "description": "Represents a create lov Value model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateLovValue" + } + ], + "description": "Represents a create lov Value model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateLovValue" + } + ], + "description": "Represents a create lov Value model." + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LovValue" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/LovValue" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Lists/{id}/Values/{valueId}": { + "put": { + "tags": [ + "Lists" + ], + "summary": "Updates the value with the specified value ID in the list of values (LOV) with the specified LOV ID.", + "operationId": "UpdateLovValue", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The list of values identifier (e.g. DRESOLUTION).", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "valueId", + "in": "path", + "description": "The lov value identifier.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Update Lov value model.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateLovValue" + } + ], + "description": "Represents an update lov Value model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateLovValue" + } + ], + "description": "Represents an update lov Value model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateLovValue" + } + ], + "description": "Represents an update lov Value model." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Lists" + ], + "summary": "Deletes the value with the specified value ID in the list of values (LOV) with the specified LOV ID.", + "operationId": "DeleteLovValue", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The list of values identifier (e.g. DRESOLUTION).", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "valueId", + "in": "path", + "description": "The lov value identifier.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "get": { + "tags": [ + "Lists" + ], + "summary": "Gets the value with the specified value ID from the list of values (LOV) with the specified LOV ID.", + "operationId": "GetLovValue", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of a list of values (e.g. DRESOLUTION).", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "valueId", + "in": "path", + "description": "The lov value identifier (e.g. VRESHIGH for DRESOLUTION).", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LovValue" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/LovValue" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Lists/Get": { + "post": { + "tags": [ + "Lists" + ], + "summary": "Gets the set of lists of values (LOVs).", + "operationId": "GetLovList", + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetLovList" + } + ], + "description": "Represents a get Lov list model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetLovList" + } + ], + "description": "Represents a get Lov list model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetLovList" + } + ], + "description": "Represents a get Lov list model." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LovList" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LovList" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/MetadataBinding/Fields/{fieldName}/Levels/{fieldLevel}/Tags/Get": { + "post": { + "tags": [ + "MetadataBinding" + ], + "summary": "Gets the list of metadata tags for the field of the specified name on the specified level (and matching possible additional filter criteria).", + "operationId": "GetMetadataBindingTagList", + "parameters": [ + { + "name": "fieldName", + "in": "path", + "description": "Element name of a field.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "fieldLevel", + "in": "path", + "description": "Level of an object.", + "required": true, + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/Level" + } + ], + "description": "Enumeration holding the visible InfoShare hierarchy levels." + } + } + ], + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetMetadataBindingTagList" + } + ], + "description": "Request object to get metadata bound tags that match the criteria given in the properties." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetMetadataBindingTagList" + } + ], + "description": "Request object to get metadata bound tags that match the criteria given in the properties." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetMetadataBindingTagList" + } + ], + "description": "Request object to get metadata bound tags that match the criteria given in the properties." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagList" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/TagList" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/MetadataBinding/Fields/{fieldName}/Levels/{fieldLevel}/TagStructure/Get": { + "post": { + "tags": [ + "MetadataBinding" + ], + "summary": "Gets the metadata tag structure for the field of the specified name on the specified level (and matching possible additional filter criteria).", + "operationId": "GetMetadataBindingTagStructure", + "parameters": [ + { + "name": "fieldName", + "in": "path", + "description": "Element name of a field.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "fieldLevel", + "in": "path", + "description": "Level of an object.", + "required": true, + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/Level" + } + ], + "description": "Enumeration holding the visible InfoShare hierarchy levels." + } + } + ], + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetMetadataBindingTagStructure" + } + ], + "description": "Request object to get metadata bound tags structure that match the criteria given in the properties." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetMetadataBindingTagStructure" + } + ], + "description": "Request object to get metadata bound tags structure that match the criteria given in the properties." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetMetadataBindingTagStructure" + } + ], + "description": "Request object to get metadata bound tags structure that match the criteria given in the properties." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TagStructure" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/TagStructure" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/MetadataBinding/SmartTags/Get": { + "post": { + "tags": [ + "MetadataBinding" + ], + "summary": "Gets the smart tags for the supplied content.", + "operationId": "GetMetadataBindingSmartTags", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "required": [ + "content", + "metadata" + ], + "type": "object", + "properties": { + "content": { + "type": "string", + "format": "binary" + }, + "metadata": { + "type": "GetMetadataBindingSmartTags", + "allOf": [ + { + "$ref": "#/components/schemas/GetMetadataBindingSmartTags" + } + ] + } + } + }, + "encoding": { + "content": { + "style": "form" + }, + "metadata": { + "style": "form" + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FieldTag" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FieldTag" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/My": { + "get": { + "tags": [ + "My" + ], + "summary": "Gets the current user.", + "operationId": "GetCurrentUser", + "parameters": [ + { + "name": "SelectedProperties", + "in": "query", + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + } + }, + { + "name": "FieldGroup", + "in": "query", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + } + }, + { + "name": "Field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + } + }, + { + "name": "IncludeLinks", + "in": "query", + "description": "true to include the links; otherwise, false. Default is false.", + "schema": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false." + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "put": { + "tags": [ + "My" + ], + "summary": "Updates the current user.", + "operationId": "UpdateCurrentUser", + "requestBody": { + "description": "Specifies fields that should be updated and values for them.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateUser" + } + ], + "description": "Represents an update user model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateUser" + } + ], + "description": "Represents an update user model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateUser" + } + ], + "description": "Represents an update user model." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/My/PreferenceSets/{SetName}": { + "get": { + "tags": [ + "My" + ], + "summary": "Gets the preference set with the specified set name for the current user.", + "operationId": "GetMyPreferences", + "parameters": [ + { + "name": "SetName", + "in": "path", + "description": "The name of the preference set to be retrieved, if the set name can not be found empty preference set is returned.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", + "type": "string", + "description": "The name of the preference set to be retrieved, if the set name can not be found empty preference set is returned." + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PreferenceSet" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/PreferenceSet" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "put": { + "tags": [ + "My" + ], + "summary": "Updates the preference set with the specified set name for the current user.", + "operationId": "SetMyPreferences", + "parameters": [ + { + "name": "SetName", + "in": "path", + "description": "The name of the preference set to be updated.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", + "type": "string", + "description": "The name of the preference set to be updated." + } + } + ], + "requestBody": { + "description": "Update current user preference set model.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdatePreferenceSet" + } + ], + "description": "Represents an update current user preference set model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdatePreferenceSet" + } + ], + "description": "Represents an update current user preference set model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdatePreferenceSet" + } + ], + "description": "Represents an update current user preference set model." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "delete": { + "tags": [ + "My" + ], + "summary": "Deletes the preference set with the specified set name for the current user.", + "operationId": "DeleteMyPreferences", + "parameters": [ + { + "name": "SetName", + "in": "path", + "description": "The name of the preference set to delete.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", + "type": "string", + "description": "The name of the preference set to delete." + } + }, + { + "name": "ItemName", + "in": "query", + "description": "The name of the preference item to delete.", + "schema": { + "maxLength": 255, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", + "type": "string", + "description": "The name of the preference item to delete.", + "nullable": true + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/My/Privileges": { + "get": { + "tags": [ + "My" + ], + "summary": "Gets the privileges of the current user.", + "operationId": "GetMyPrivileges", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LovValue" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LovValue" + } + } + } + } + } + } + } + }, + "/v3/Objects/{id}": { + "get": { + "tags": [ + "Objects" + ], + "summary": "Gets the type of the object with the specified ID.", + "operationId": "GetObject", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The object identifier (e.g. logical id GUID-..., language card, folder id 12345678, user id VUSERAUTHOR, user group id VUSERGROUPDEFAULTDEPARTMENT).", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BaseObject" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/BaseObject" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/OutputFormats/{Id}": { + "get": { + "tags": [ + "OutputFormats" + ], + "summary": "Gets the output format with the specified ID.", + "operationId": "GetOutputFormat", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "Identifier of the output format.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the output format." + } + }, + { + "name": "SelectedProperties", + "in": "query", + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + } + }, + { + "name": "FieldGroup", + "in": "query", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + } + }, + { + "name": "Field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + } + }, + { + "name": "IncludeLinks", + "in": "query", + "description": "true to include the links; otherwise, false. Default is false.", + "schema": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OutputFormat" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/OutputFormat" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "put": { + "tags": [ + "OutputFormats" + ], + "summary": "Updates the output format with the specified ID.", + "operationId": "UpdateOutputFormat", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "Identifier of the output format.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the output format." + } + } + ], + "requestBody": { + "description": "Request body with a list of the fields.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateOutputFormat" + } + ], + "description": "Represents an update output format model" + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateOutputFormat" + } + ], + "description": "Represents an update output format model" + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateOutputFormat" + } + ], + "description": "Represents an update output format model" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "delete": { + "tags": [ + "OutputFormats" + ], + "summary": "Deletes the output format with the specified ID.", + "operationId": "DeleteOutputFormat", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "Identifier of the output format.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the output format." + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/OutputFormats": { + "post": { + "tags": [ + "OutputFormats" + ], + "summary": "Creates an output format.", + "operationId": "CreateOutputFormat", + "requestBody": { + "description": "Request body with a list of the fields.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateOutputFormat" + } + ], + "description": "Represents a create output format model" + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateOutputFormat" + } + ], + "description": "Represents a create output format model" + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateOutputFormat" + } + ], + "description": "Represents a create output format model" + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OutputFormat" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/OutputFormat" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/OutputFormats/Get": { + "post": { + "tags": [ + "OutputFormats" + ], + "summary": "Gets the set of output formats.", + "operationId": "GetOutputFormatList", + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetOutputFormatList" + } + ], + "description": "Request object to get all output formats in the repository that match the criteria given in the properties." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetOutputFormatList" + } + ], + "description": "Request object to get all output formats in the repository that match the criteria given in the properties." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetOutputFormatList" + } + ], + "description": "Request object to get all output formats in the repository that match the criteria given in the properties." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OutputFormat" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/OutputFormat" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Projects/ByProjectId/{ProjectId}": { + "get": { + "tags": [ + "Projects" + ], + "summary": "Gets the project with the specified project ID.", + "operationId": "GetProjectByProjectId", + "parameters": [ + { + "name": "ProjectId", + "in": "path", + "description": "Identifier of a project.", + "required": true, + "schema": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of a project." + } + }, + { + "name": "SelectedProperties", + "in": "query", + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + } + }, + { + "name": "FieldGroup", + "in": "query", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + } + }, + { + "name": "Field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + } + }, + { + "name": "IncludeLinks", + "in": "query", + "description": "true to include the links; otherwise, false. Default is false.", + "schema": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Project" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Project" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "put": { + "tags": [ + "Projects" + ], + "summary": "Updates the project with the specified project ID.", + "operationId": "UpdateProject", + "parameters": [ + { + "name": "ProjectId", + "in": "path", + "description": "Identifier of a project.", + "required": true, + "schema": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of a project." + } + } + ], + "requestBody": { + "description": "Update project model.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateProject" + } + ], + "description": "Represents an update project model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateProject" + } + ], + "description": "Represents an update project model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateProject" + } + ], + "description": "Represents an update project model." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Projects" + ], + "summary": "Deletes the project with the specified project ID.", + "operationId": "DeleteProject", + "parameters": [ + { + "name": "ProjectId", + "in": "path", + "description": "Identifier of a project.", + "required": true, + "schema": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of a project." + } + } + ], + "requestBody": { + "description": "Delete project model.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/DeleteProject" + } + ], + "description": "Represents a delete project model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/DeleteProject" + } + ], + "description": "Represents a delete project model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/DeleteProject" + } + ], + "description": "Represents a delete project model." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Projects/ByAssigneeCardId/{AssigneeCardId}": { + "get": { + "tags": [ + "Projects" + ], + "summary": "Gets the project with the specified assignee card ID of the assignee who is assigned to the project.", + "operationId": "GetProjectByAssigneeCardId", + "parameters": [ + { + "name": "AssigneeCardId", + "in": "path", + "description": "The card identifier of the assignee.", + "required": true, + "schema": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The card identifier of the assignee.", + "format": "int64" + } + }, + { + "name": "SelectedProperties", + "in": "query", + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + } + }, + { + "name": "FieldGroup", + "in": "query", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + } + }, + { + "name": "Field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + } + }, + { + "name": "IncludeLinks", + "in": "query", + "description": "true to include the links; otherwise, false. Default is false.", + "schema": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Project" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Project" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "put": { + "tags": [ + "Projects" + ], + "summary": "Updates the assignee with the specified assignee card ID who is assigned to the project.", + "operationId": "UpdateProjectAssignee", + "parameters": [ + { + "name": "AssigneeCardId", + "in": "path", + "description": "Identifier of the project's assignee.", + "required": true, + "schema": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "Identifier of the project's assignee.", + "format": "int64" + } + } + ], + "requestBody": { + "description": "Update project's assignee model.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateProjectAssignee" + } + ], + "description": "Represent update project's assignee model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateProjectAssignee" + } + ], + "description": "Represent update project's assignee model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateProjectAssignee" + } + ], + "description": "Represent update project's assignee model." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Projects" + ], + "summary": "Deletes the assignee with the specified assignee card ID who is assigned to the project.", + "operationId": "DeleteProjectAssignee", + "parameters": [ + { + "name": "AssigneeCardId", + "in": "path", + "description": "Identifier of the project's assignee.", + "required": true, + "schema": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "Identifier of the project's assignee.", + "format": "int64" + } + } + ], + "requestBody": { + "description": "Delete project's assignee model.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/DeleteProjectAssignee" + } + ], + "description": "Represent delete project's assignee model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/DeleteProjectAssignee" + } + ], + "description": "Represent delete project's assignee model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/DeleteProjectAssignee" + } + ], + "description": "Represent delete project's assignee model." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Projects": { + "post": { + "tags": [ + "Projects" + ], + "summary": "Creates a project.", + "operationId": "CreateProject", + "requestBody": { + "description": "The create project model.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateProject" + } + ], + "description": "Represents a create project model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateProject" + } + ], + "description": "Represents a create project model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateProject" + } + ], + "description": "Represents a create project model." + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Project" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Project" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Projects/Get": { + "post": { + "tags": [ + "Projects" + ], + "summary": "Gets the set of projects that match the provided filter criteria.", + "operationId": "GetProjectList", + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetProjectList" + } + ], + "description": "Represents a get project list model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetProjectList" + } + ], + "description": "Represents a get project list model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetProjectList" + } + ], + "description": "Represents a get project list model." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Project" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Project" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Projects/ByProjectId/Get": { + "post": { + "tags": [ + "Projects" + ], + "summary": "Gets the set of projects with the provided project IDs (and matching possible additional filter criteria).", + "operationId": "GetProjectListByProjectId", + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetProjectListByProjectId" + } + ], + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetProjectListByProjectId" + } + ], + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetProjectListByProjectId" + } + ], + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Project" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Project" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Projects/Assignees": { + "post": { + "tags": [ + "Projects" + ], + "summary": "Creates a project assignee.", + "operationId": "CreateProjectAssignee", + "requestBody": { + "description": "The create project assignee model.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateProjectAssignee" + } + ], + "description": "Represents a create project assignee model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateProjectAssignee" + } + ], + "description": "Represents a create project assignee model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateProjectAssignee" + } + ], + "description": "Represents a create project assignee model." + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Project" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Project" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Publications": { + "post": { + "tags": [ + "Publications" + ], + "summary": "Creates a publication.", + "operationId": "CreatePublication", + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreatePublication" + } + ], + "description": "Represents a model to create a publication." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreatePublication" + } + ], + "description": "Represents a model to create a publication." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreatePublication" + } + ], + "description": "Represents a model to create a publication." + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Publication" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Publication" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Publications/Versions": { + "post": { + "tags": [ + "Publications" + ], + "summary": "Creates a version of a publication.", + "operationId": "CreatePublicationVersion", + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreatePublicationVersion" + } + ], + "description": "Represents a model to create a version of a publication." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreatePublicationVersion" + } + ], + "description": "Represents a model to create a version of a publication." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreatePublicationVersion" + } + ], + "description": "Represents a model to create a version of a publication." + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Publication" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Publication" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Publications/Languages": { + "post": { + "tags": [ + "Publications" + ], + "summary": "Creates a language of a publication.", + "operationId": "CreatePublicationLanguage", + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreatePublicationLanguage" + } + ], + "description": "Represents a model to create a language of a publication." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreatePublicationLanguage" + } + ], + "description": "Represents a model to create a language of a publication." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreatePublicationLanguage" + } + ], + "description": "Represents a model to create a language of a publication." + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Publication" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Publication" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Publications/ByLanguageCardId/{languageCardId}": { + "put": { + "tags": [ + "Publications" + ], + "summary": "Updates the publication output with the specified language card ID.", + "operationId": "UpdatePublicationByLanguageCardId", + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Language card identifier of the publication output.", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdatePublication" + } + ], + "description": "Represents an update model for publication." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdatePublication" + } + ], + "description": "Represents an update model for publication." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdatePublication" + } + ], + "description": "Represents an update model for publication." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Publications" + ], + "summary": "Deletes the publication output with the specified language card ID.", + "operationId": "DeletePublicationByLanguageCardId", + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "The language card identifier of the publication output.", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "description": "The parameters that will be used for delete operation.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/DeletePublicationByLanguageCardId" + } + ], + "description": "Request object to delete publication." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/DeletePublicationByLanguageCardId" + } + ], + "description": "Request object to delete publication." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/DeletePublicationByLanguageCardId" + } + ], + "description": "Request object to delete publication." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "get": { + "tags": [ + "Publications" + ], + "summary": "Gets the publication with the specified language card ID.", + "operationId": "GetPublicationByLanguageCardId", + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Language card identifier of the publication.", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + }, + { + "name": "selectedProperties", + "in": "query", + "description": "Selected properties to filter the properties. Default is Id.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Enumeration holding the selected properties." + } + }, + { + "name": "fieldGroup", + "in": "query", + "description": "Field group of metadata fields. Default is None.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Groups of metadata fields." + } + }, + { + "name": "field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "includeLinks", + "in": "query", + "description": "`true` to include the links; otherwise, `false`. Default is `false`.", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Publication" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Publication" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Publications/ByLogicalId/{logicalId}": { + "put": { + "tags": [ + "Publications" + ], + "summary": "Updates the publication with the specified logical ID (and matching possible additional filter criteria, such as version and output format).", + "operationId": "UpdatePublicationByLogicalId", + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "Logical identifier of the publication.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "version", + "in": "query", + "description": "The version of the publication to update.", + "schema": { + "type": "string" + } + }, + { + "name": "outputFormat", + "in": "query", + "description": "The output Format of the publication to update.", + "schema": { + "type": "string" + } + }, + { + "name": "languageCombination", + "in": "query", + "description": "The languageCombination of the publication to update.", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdatePublication" + } + ], + "description": "Represents an update model for publication." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdatePublication" + } + ], + "description": "Represents an update model for publication." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdatePublication" + } + ], + "description": "Represents an update model for publication." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Publications" + ], + "summary": "Deletes the publication with the specified logical ID (and matching possible additional filter criteria, such as version and output format).", + "operationId": "DeletePublicationByLogicalId", + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "The logical identifier of the publication.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "version", + "in": "query", + "description": "The version number.", + "schema": { + "type": "string" + } + }, + { + "name": "outputFormatId", + "in": "query", + "description": "The element name of the output format.", + "schema": { + "type": "string" + } + }, + { + "name": "languageCombination", + "in": "query", + "description": "The language combination of the PublicationOutput (e.g. en, en+fr+nl,...)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/DeletePublicationByLogicalId" + } + ], + "description": "Request object to delete publication." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/DeletePublicationByLogicalId" + } + ], + "description": "Request object to delete publication." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/DeletePublicationByLogicalId" + } + ], + "description": "Request object to delete publication." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "get": { + "tags": [ + "Publications" + ], + "summary": "Gets the publication with the specified logical ID (and matching possible additional filter criteria, such as version and output format).", + "operationId": "GetPublicationByLogicalId", + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "The logical identifier of the object.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "version", + "in": "query", + "description": "The version number.", + "schema": { + "type": "string" + } + }, + { + "name": "outputFormat", + "in": "query", + "description": "The label/name of the OutputFormat (e.g. Manual, Documentation Online,...).", + "schema": { + "type": "string" + } + }, + { + "name": "languageCombination", + "in": "query", + "description": "The language combination of the PublicationOutput (e.g. en, en+fr+nl,...).", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "selectedProperties", + "in": "query", + "description": "Selected properties to filter the properties. Default is Id.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Enumeration holding the selected properties." + } + }, + { + "name": "fieldGroup", + "in": "query", + "description": "Field group of metadata fields. Default is None.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Groups of metadata fields." + } + }, + { + "name": "field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "includeLinks", + "in": "query", + "description": "`true` to include the links; otherwise, `false`. Default is `false`.", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Publication" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Publication" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Publications/ByLanguageCardId/{languageCardId}/Release": { + "post": { + "tags": [ + "Publications" + ], + "summary": "Releases the publication output with the specified language card ID.", + "operationId": "ReleasePublication", + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Language card identifier of the publication output.", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/ReleasePublication" + } + ], + "description": "Represents a release model for publication." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/ReleasePublication" + } + ], + "description": "Represents a release model for publication." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/ReleasePublication" + } + ], + "description": "Represents a release model for publication." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Publications/ByLanguageCardId/{languageCardId}/Unrelease": { + "post": { + "tags": [ + "Publications" + ], + "summary": "Unreleases the publication output with the specified language card ID.", + "operationId": "UnreleasePublication", + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Language card identifier of the publication output.", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UnreleasePublication" + } + ], + "description": "Model representing parameters for unreleasing a publication" + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UnreleasePublication" + } + ], + "description": "Model representing parameters for unreleasing a publication" + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UnreleasePublication" + } + ], + "description": "Model representing parameters for unreleasing a publication" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Publications/ByLogicalId/Get": { + "post": { + "tags": [ + "Publications" + ], + "summary": "Gets the set of publications with the specified logical IDs (and matching possible additional filter criteria).", + "description": "Depending on which status filter is specified, the objects with following status types can be returned:\r\n
Status filterReturned status types
AllAll status types
LatestReleasedLatest released excluding out-of-date
DraftOrLatestReleasedDraft and latest released excluding out-of-date
AllReleasedAll released including out-of-date
", + "operationId": "GetPublicationListByLogicalId", + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetPublicationListByLogicalId" + } + ], + "description": "Request object to get all publications in the repository that match the criteria given in the properties." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetPublicationListByLogicalId" + } + ], + "description": "Request object to get all publications in the repository that match the criteria given in the properties." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetPublicationListByLogicalId" + } + ], + "description": "Request object to get all publications in the repository that match the criteria given in the properties." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Publication" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Publication" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Publications/ByLogicalId/ByVersionFilter/Get": { + "post": { + "tags": [ + "Publications" + ], + "summary": "Gets the set of publications with the specified logical IDs that have the specified version (and matching possible additional filter criteria).", + "description": "Depending on which status filter is specified, the objects with desired version can be returned:", + "operationId": "GetPublicationListByVersionFilter", + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetPublicationListByLogicalIdByVersionFilter" + } + ], + "description": "Request object to get all publications in the repository that match the criteria given in the properties." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetPublicationListByLogicalIdByVersionFilter" + } + ], + "description": "Request object to get all publications in the repository that match the criteria given in the properties." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetPublicationListByLogicalIdByVersionFilter" + } + ], + "description": "Request object to get all publications in the repository that match the criteria given in the properties." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Publication" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Publication" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Publications/Get": { + "post": { + "tags": [ + "Publications" + ], + "summary": "Gets the set of publications that match the provided filter criteria.", + "description": "Depending on which status filter is specified, the objects with following status types can be returned:\r\n
Status filterReturned status types
AllAll status types
LatestReleasedLatest released excluding out-of-date
DraftOrLatestReleasedDraft and latest released excluding out-of-date
AllReleasedAll released including out-of-date
", + "operationId": "GetPublicationList", + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetPublicationList" + } + ], + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetPublicationList" + } + ], + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetPublicationList" + } + ], + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Publication" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Publication" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Publications/ByLanguageCardId/Get": { + "post": { + "tags": [ + "Publications" + ], + "summary": "Gets the set of publications with the specified language card IDs (and matching possible additional filter criteria).", + "operationId": "GetPublicationListByLanguageCardId", + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetPublicationListByLanguageCardId" + } + ], + "description": "Request object to get all publications in the repository that match the criteria given in the properties." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetPublicationListByLanguageCardId" + } + ], + "description": "Request object to get all publications in the repository that match the criteria given in the properties." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetPublicationListByLanguageCardId" + } + ], + "description": "Request object to get all publications in the repository that match the criteria given in the properties." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Publication" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Publication" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Publications/ByLanguageCardId/{languageCardId}/Content": { + "get": { + "tags": [ + "Publications" + ], + "summary": "Gets the contents of the publication with the specified language card ID, in the form of a binary file.", + "operationId": "GetPublicationContentByLanguageCardId", + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Language card identifier of the publication.", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Publications/ByLogicalId/{logicalId}/Location": { + "get": { + "tags": [ + "Publications" + ], + "summary": "Gets the repository folder location of the publication with the specified logical ID. The response is an array of the folders that form the path to this location.", + "operationId": "GetPublicationLocation", + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "Logical identifier of the publication.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "selectedProperties", + "in": "query", + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Enumeration holding the selected properties." + } + }, + { + "name": "fieldGroup", + "in": "query", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Groups of metadata fields." + } + }, + { + "name": "field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "includeLinks", + "in": "query", + "description": "true to include the links; otherwise, false. Default is false.", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Folder" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Folder" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Publications/ByLanguageCardId/{languageCardId}/CancelPublish": { + "post": { + "tags": [ + "Publications" + ], + "summary": "Cancels the publishing of the publication output with the specified language card ID.", + "operationId": "CancelPublicationPublish", + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Language card identifier of the publication output.", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CancelPublicationPublish" + } + ], + "description": "Represents an update model for CancelPublicationPublish." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CancelPublicationPublish" + } + ], + "description": "Represents an update model for CancelPublicationPublish." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CancelPublicationPublish" + } + ], + "description": "Represents an update model for CancelPublicationPublish." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Publications/ByLanguageCardId/{languageCardId}/Publish": { + "post": { + "tags": [ + "Publications" + ], + "summary": "Publishes the publication output with the specified language card ID.", + "operationId": "PublishPublication", + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Language card identifier of the publication output.", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "description": "Required current metadata of the object.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/PublishPublication" + } + ], + "description": "Represents a publish model for publication." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/PublishPublication" + } + ], + "description": "Represents a publish model for publication." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/PublishPublication" + } + ], + "description": "Represents a publish model for publication." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EventProgress" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/EventProgress" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Publications/ByLanguageCardId/{languageCardId}/Unpublish": { + "post": { + "tags": [ + "Publications" + ], + "summary": "Unpublishes the publication output with the specified language card ID.", + "operationId": "UnpublishPublication", + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Language card identifier of the publication output.", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "description": "Required current metadata of the object.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UnpublishPublication" + } + ], + "description": "Represents an unpublish model for publication." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UnpublishPublication" + } + ], + "description": "Represents an unpublish model for publication." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UnpublishPublication" + } + ], + "description": "Represents an unpublish model for publication." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/EventProgress" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/EventProgress" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Publications/{LogicalId}/Versions/{Version}/DocumentObjects/Search": { + "post": { + "tags": [ + "Publications" + ], + "summary": "In the publication with the specified logical ID and version, searches all document objects against the criteria given in the parameters.", + "operationId": "SearchInPublication", + "parameters": [ + { + "name": "LogicalId", + "in": "path", + "description": "The publication logical identifier.", + "required": true, + "schema": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The publication logical identifier." + } + }, + { + "name": "Version", + "in": "path", + "description": "The version of the publication.", + "required": true, + "schema": { + "minLength": 1, + "type": "string", + "description": "The version of the publication." + } + } + ], + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SearchInPublicationRequest" + } + ], + "description": "Represents search request criteria to find document objects." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SearchInPublicationRequest" + } + ], + "description": "Represents search request criteria to find document objects." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SearchInPublicationRequest" + } + ], + "description": "Represents search request criteria to find document objects." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/SearchResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Publications/ByLanguageCardId/{languageCardId}/PublishReport": { + "get": { + "tags": [ + "Publications" + ], + "summary": "Gets the publish report for the publication output with the specified language card ID.", + "operationId": "GetPublicationPublishReport", + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Publication output language card identifier to get a report for.", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Message" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Message" + } + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Search": { + "post": { + "tags": [ + "Search" + ], + "summary": "Performs a repository search matching the criteria provided in the parameters, across all document object types.", + "operationId": "Search", + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SearchRequest" + } + ], + "description": "Represents search request criteria to find document objects." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SearchRequest" + } + ], + "description": "Represents search request criteria to find document objects." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SearchRequest" + } + ], + "description": "Represents search request criteria to find document objects." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SearchResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/SearchResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Settings": { + "get": { + "tags": [ + "Settings" + ], + "summary": "Gets the set of settings fields that match the criteria provided in the parameters.", + "operationId": "GetSettings", + "parameters": [ + { + "name": "Field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + } + }, + { + "name": "SelectedProperties", + "in": "query", + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + } + }, + { + "name": "FieldGroup", + "in": "query", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Setting" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Setting" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "put": { + "tags": [ + "Settings" + ], + "summary": "Updates the provided settings fields, provided that the conditions required for the fields are satisfied.", + "operationId": "UpdateSettings", + "requestBody": { + "description": "Update settings model.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateSettings" + } + ], + "description": "Represents an update settings model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateSettings" + } + ], + "description": "Represents an update settings model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateSettings" + } + ], + "description": "Represents an update settings model." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Settings/WorkflowReport": { + "get": { + "tags": [ + "Settings" + ], + "summary": "Gets the set of worfklow report settings.", + "operationId": "GetWorkflowReportSettings", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/WorkflowReportSettings" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/WorkflowReportSettings" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Settings/TranslationReport": { + "get": { + "tags": [ + "Settings" + ], + "summary": "Gets the set of translation report settings.", + "operationId": "GetTranslationReportSettings", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TranslationReportSettings" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/TranslationReportSettings" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Settings/FieldDefinitions": { + "get": { + "tags": [ + "Settings" + ], + "summary": "Gets the set of field definitions.", + "operationId": "GetFieldDefinitionsSettings", + "parameters": [ + { + "name": "ObjectTypes", + "in": "query", + "description": "A list of object type to retrieve field definition for. if not provided field definition for all types will be returned.", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ObjectType" + } + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/FieldSetup" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/FieldSetup" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Settings/TranslationStatuses": { + "get": { + "tags": [ + "Settings" + ], + "summary": "Gets the set of translation statuses.", + "operationId": "GetTranslationStatusListSettings", + "parameters": [ + { + "name": "DocumentObjectType", + "in": "query", + "description": "The document object type to retrieve translation statuses for.\r\nUndefined is not supported for this parameter.\r\n", + "required": true, + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/DocumentObjectType" + } + ], + "description": "The document object type to retrieve translation statuses for.\r\nUndefined is not supported for this parameter.\r\n" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TranslationStatus" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TranslationStatus" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/TranslationJobs/Get": { + "post": { + "tags": [ + "TranslationJobs" + ], + "summary": "Gets the set of translation jobs that match the provided filter criteria.", + "operationId": "GetTranslationJobList", + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetTranslationJobList" + } + ], + "description": "Request object to get all translation jobs in the repository that match the criteria given in the properties." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetTranslationJobList" + } + ], + "description": "Request object to get all translation jobs in the repository that match the criteria given in the properties." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetTranslationJobList" + } + ], + "description": "Request object to get all translation jobs in the repository that match the criteria given in the properties." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TranslationJob" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TranslationJob" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/TranslationJobs/{Id}": { + "get": { + "tags": [ + "TranslationJobs" + ], + "summary": "Gets the translation job with the specified ID.", + "operationId": "GetTranslationJob", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "Identifier of the translation job.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the translation job." + } + }, + { + "name": "SelectedProperties", + "in": "query", + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + } + }, + { + "name": "FieldGroup", + "in": "query", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + } + }, + { + "name": "Field", + "in": "query", + "description": "Specify one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specify one or more metadata fields to return." + } + }, + { + "name": "IncludeLinks", + "in": "query", + "description": "true to include the links; otherwise, false.", + "schema": { + "type": "boolean", + "description": "true to include the links; otherwise, false.", + "default": false + } + }, + { + "name": "IncludeWorkflow", + "in": "query", + "description": "true to include the list of workflows; otherwise, false.", + "schema": { + "type": "boolean", + "description": "true to include the list of workflows; otherwise, false.", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TranslationJob" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/TranslationJob" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "put": { + "tags": [ + "TranslationJobs" + ], + "summary": "Updates the translation job with the specified ID.", + "operationId": "UpdateTranslationJob", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "Identifier of the translation job.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the translation job." + } + } + ], + "requestBody": { + "description": "Request body with a list of the fields.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateTranslationJob" + } + ], + "description": "Request object to update the translation job." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateTranslationJob" + } + ], + "description": "Request object to update the translation job." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateTranslationJob" + } + ], + "description": "Request object to update the translation job." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "delete": { + "tags": [ + "TranslationJobs" + ], + "summary": "Deletes the translation job with the specified ID.", + "operationId": "DeleteTranslationJob", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "Identifier of the translation job.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the translation job." + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/TranslationJobs/{Id}/SourceObjects/Get": { + "post": { + "tags": [ + "TranslationJobs" + ], + "summary": "Gets all source objects of the translation job with the specified ID.", + "operationId": "GetTranslationJobSourceObjectList", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "The identifier of the translation job.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the translation job." + } + } + ], + "requestBody": { + "description": "Request body with a list of the fields, the field group and the selected properties level.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetTranslationJobSourceObjectList" + } + ], + "description": "Request object to get all source objects of a translation job in the repository that match the criteria given in the properties." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetTranslationJobSourceObjectList" + } + ], + "description": "Request object to get all source objects of a translation job in the repository that match the criteria given in the properties." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetTranslationJobSourceObjectList" + } + ], + "description": "Request object to get all source objects of a translation job in the repository that match the criteria given in the properties." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BaseObject" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BaseObject" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/TranslationJobs": { + "post": { + "tags": [ + "TranslationJobs" + ], + "summary": "Creates a translation job.", + "operationId": "CreateTranslationJob", + "requestBody": { + "description": "Request body with a list of the fields.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateTranslationJob" + } + ], + "description": "Represents a create translation job model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateTranslationJob" + } + ], + "description": "Represents a create translation job model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateTranslationJob" + } + ], + "description": "Represents a create translation job model." + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TranslationJob" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/TranslationJob" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/TranslationJobs/{Id}/Retry": { + "post": { + "tags": [ + "TranslationJobs" + ], + "summary": "Retries the translation job with the specified ID.", + "operationId": "RetryTranslationJob", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "The identifier of the translation job.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the translation job." + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/RetryTranslationJob" + } + ], + "description": "Represents a retry translation job model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/RetryTranslationJob" + } + ], + "description": "Represents a retry translation job model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/RetryTranslationJob" + } + ], + "description": "Represents a retry translation job model." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/TranslationJobs/{Id}/Cancel": { + "post": { + "tags": [ + "TranslationJobs" + ], + "summary": "Cancels the translation job with the specified ID.", + "operationId": "CancelTranslationJob", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "The identifier of the translation job.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the translation job." + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CancelTranslationJob" + } + ], + "description": "Represents a cancel translation job model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CancelTranslationJob" + } + ], + "description": "Represents a cancel translation job model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CancelTranslationJob" + } + ], + "description": "Represents a cancel translation job model." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/TranslationJobs/{Id}/SendToTranslation": { + "post": { + "tags": [ + "TranslationJobs" + ], + "summary": "Sends the translation job with the specified ID to translation.", + "operationId": "SendTranslationJobToTranslation", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "The identifier of the translation job.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the translation job." + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SendTranslationJobToTranslation" + } + ], + "description": "Represents a send translation job for translation model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SendTranslationJobToTranslation" + } + ], + "description": "Represents a send translation job for translation model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SendTranslationJobToTranslation" + } + ], + "description": "Represents a send translation job for translation model." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/TranslationJobs/{Id}/TargetObjects": { + "get": { + "tags": [ + "TranslationJobs" + ], + "summary": "Gets all target objects of the translation job with the specified ID that match the provided parameters.", + "operationId": "GetTranslationJobTargetObjectList", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "Identifier of the translation job.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the translation job." + } + }, + { + "name": "LanguageFilter", + "in": "query", + "description": "Specify the language filter for which to return the target objects.", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specify the language filter for which to return the target objects." + } + }, + { + "name": "ObjectTypes", + "in": "query", + "description": "Specify the object types for which to filter the returned objects.", + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObjectTypeFilter" + }, + "description": "Specify the object types for which to filter the returned objects.", + "default": [ + "any" + ] + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TranslationJobTargetObject" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TranslationJobTargetObject" + } + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/TranslationJobs/{Id}/AddSourceObjects": { + "post": { + "tags": [ + "TranslationJobs" + ], + "summary": "Adds the provided source objects to the translation job with the specified ID.", + "operationId": "AddTranslationJobSourceObjects", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "The translation object identifier.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The translation object identifier." + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/AddTranslationJobSourceObjects" + } + ], + "description": "Represents source objects to be added to the translation job." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/AddTranslationJobSourceObjects" + } + ], + "description": "Represents source objects to be added to the translation job." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/AddTranslationJobSourceObjects" + } + ], + "description": "Represents source objects to be added to the translation job." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/TranslationJobs/{Id}/SourceObjects/{LogicalId}": { + "delete": { + "tags": [ + "TranslationJobs" + ], + "summary": "Removes the provided source object, specified by the logical ID, from the translation job with the specified ID.", + "operationId": "DeleteTranslationJobSourceObject", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "The translation object identifier.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The translation object identifier." + } + }, + { + "name": "LogicalId", + "in": "path", + "description": "The source object logical identifier.", + "required": true, + "schema": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The source object logical identifier." + } + }, + { + "name": "Version", + "in": "query", + "description": "The version number of the source object.", + "schema": { + "type": "string", + "description": "The version number of the source object.", + "nullable": true + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/TranslationTemplates": { + "get": { + "tags": [ + "TranslationTemplates" + ], + "summary": "Gets the set of translation templates.", + "operationId": "GetTranslationTemplateList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TranslationTemplate" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TranslationTemplate" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/UserGroups/{Id}": { + "get": { + "tags": [ + "UserGroups" + ], + "summary": "Gets the user group with the specified ID.", + "operationId": "GetUserGroup", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "Identifier of the group.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the group." + } + }, + { + "name": "SelectedProperties", + "in": "query", + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + } + }, + { + "name": "FieldGroup", + "in": "query", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + } + }, + { + "name": "Field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + } + }, + { + "name": "IncludeLinks", + "in": "query", + "description": "true to include the links; otherwise, false. Default is false.", + "schema": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserGroup" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserGroup" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "put": { + "tags": [ + "UserGroups" + ], + "summary": "Updates the user group with the specified ID.", + "operationId": "UpdateUserGroup", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "Identifier of the group.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the group." + } + } + ], + "requestBody": { + "description": "Request body with a list of the fields.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateUserGroup" + } + ], + "description": "Represents an update user group model" + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateUserGroup" + } + ], + "description": "Represents an update user group model" + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateUserGroup" + } + ], + "description": "Represents an update user group model" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "delete": { + "tags": [ + "UserGroups" + ], + "summary": "Deletes the user group with the specified ID.", + "operationId": "DeleteUserGroup", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "Identifier of the user group.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the user group." + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/UserGroups/Get": { + "post": { + "tags": [ + "UserGroups" + ], + "summary": "Gets the set of user groups that match the provided filter criteria.", + "operationId": "GetUserGroupList", + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetUserGroupList" + } + ], + "description": "Request object to get all user groups in the repository that match the criteria given in the properties." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetUserGroupList" + } + ], + "description": "Request object to get all user groups in the repository that match the criteria given in the properties." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetUserGroupList" + } + ], + "description": "Request object to get all user groups in the repository that match the criteria given in the properties." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserGroup" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserGroup" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/UserGroups": { + "post": { + "tags": [ + "UserGroups" + ], + "summary": "Creates a user group.", + "operationId": "CreateUserGroup", + "requestBody": { + "description": "Request body with a list of the fields.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateUserGroup" + } + ], + "description": "Represents a create user group model" + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateUserGroup" + } + ], + "description": "Represents a create user group model" + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateUserGroup" + } + ], + "description": "Represents a create user group model" + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserGroup" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserGroup" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/UserRoles/{Id}": { + "get": { + "tags": [ + "UserRoles" + ], + "summary": "Gets the user role with the specified ID.", + "operationId": "GetUserRole", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "Identifier of the role.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the role." + } + }, + { + "name": "SelectedProperties", + "in": "query", + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + } + }, + { + "name": "FieldGroup", + "in": "query", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + } + }, + { + "name": "Field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + } + }, + { + "name": "IncludeLinks", + "in": "query", + "description": "true to include the links; otherwise, false. Default is false.", + "schema": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserRole" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserRole" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "put": { + "tags": [ + "UserRoles" + ], + "summary": "Updates the user role with the specified ID.", + "operationId": "UpdateUserRole", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "Identifier of the role.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the role." + } + } + ], + "requestBody": { + "description": "Request body with a list of the fields.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateUserRole" + } + ], + "description": "Represents an update user role model" + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateUserRole" + } + ], + "description": "Represents an update user role model" + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateUserRole" + } + ], + "description": "Represents an update user role model" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "delete": { + "tags": [ + "UserRoles" + ], + "summary": "Deletes the user role with the specified ID.", + "operationId": "DeleteUserRole", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "Identifier of the user role.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the user role." + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/UserRoles": { + "post": { + "tags": [ + "UserRoles" + ], + "summary": "Creates a user role.", + "operationId": "CreateUserRole", + "requestBody": { + "description": "Request body with a list of the fields.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateUserRole" + } + ], + "description": "Represents a create user role model" + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateUserRole" + } + ], + "description": "Represents a create user role model" + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateUserRole" + } + ], + "description": "Represents a create user role model" + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserRole" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserRole" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/UserRoles/Get": { + "post": { + "tags": [ + "UserRoles" + ], + "summary": "Gets the set of user roles that match the provided filter criteria.", + "operationId": "GetUserRoleList", + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetUserRoleList" + } + ], + "description": "Request object to get all user roles in the repository that match the criteria given in the properties." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetUserRoleList" + } + ], + "description": "Request object to get all user roles in the repository that match the criteria given in the properties." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetUserRoleList" + } + ], + "description": "Request object to get all user roles in the repository that match the criteria given in the properties." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserRole" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserRole" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Users/Get": { + "post": { + "tags": [ + "Users" + ], + "summary": "Gets the set of users that match the provided filter criteria.", + "operationId": "GetUserList", + "requestBody": { + "description": "Request object with the criteria in its properties.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetUserList" + } + ], + "description": "Request object to get all users in the repository that match the criteria given in the properties." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetUserList" + } + ], + "description": "Request object to get all users in the repository that match the criteria given in the properties." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetUserList" + } + ], + "description": "Request object to get all users in the repository that match the criteria given in the properties." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Users/{Id}": { + "get": { + "tags": [ + "Users" + ], + "summary": "Gets the user with the specified ID.", + "operationId": "GetUser", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "The identifier of the user.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the user." + } + }, + { + "name": "SelectedProperties", + "in": "query", + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + } + }, + { + "name": "FieldGroup", + "in": "query", + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + } + }, + { + "name": "Field", + "in": "query", + "description": "Specifies one or more metadata fields to return.", + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + } + }, + { + "name": "IncludeLinks", + "in": "query", + "description": "true to include the links; otherwise, false. Default is false.", + "schema": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "put": { + "tags": [ + "Users" + ], + "summary": "Updates the user with the specified ID.", + "operationId": "UpdateUser", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "The identifier of the user.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the user." + } + } + ], + "requestBody": { + "description": "Request body with a list of the fields.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateUser" + } + ], + "description": "Represents an update user model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateUser" + } + ], + "description": "Represents an update user model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateUser" + } + ], + "description": "Represents an update user model." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Users" + ], + "summary": "Deletes the user with the specified ID.", + "operationId": "DeleteUser", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "Identifier of the user.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the user." + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Users": { + "post": { + "tags": [ + "Users" + ], + "summary": "Creates a user.", + "operationId": "CreateUser", + "requestBody": { + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateUser" + } + ], + "description": "Represents an create user model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateUser" + } + ], + "description": "Represents an create user model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateUser" + } + ], + "description": "Represents an create user model." + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Users/{Id}/PreferenceSets/{SetName}": { + "get": { + "tags": [ + "Users" + ], + "summary": "Gets the preference set with the specified set name for the user with the specified ID.", + "operationId": "GetUserPreferences", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "The identifier of the user.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the user." + } + }, + { + "name": "SetName", + "in": "path", + "description": "The name of the preference set to be retrieved, if the set name can not be found empty preference set is returned.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", + "type": "string", + "description": "The name of the preference set to be retrieved, if the set name can not be found empty preference set is returned." + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PreferenceSet" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/PreferenceSet" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "put": { + "tags": [ + "Users" + ], + "summary": "Sets the user preferences in the preference set with the specified set name for the user with the specified ID.", + "operationId": "SetUserPreferences", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "The identifier of the user.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the user." + } + }, + { + "name": "SetName", + "in": "path", + "description": "The name of the preference set to be updated.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", + "type": "string", + "description": "The name of the preference set to be updated." + } + } + ], + "requestBody": { + "description": "Request body with a preference list.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdatePreferenceSet" + } + ], + "description": "Represents an update current user preference set model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdatePreferenceSet" + } + ], + "description": "Represents an update current user preference set model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdatePreferenceSet" + } + ], + "description": "Represents an update current user preference set model." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Users" + ], + "summary": "Deletes the preference set with the specified set name for the user with the specified ID.", + "operationId": "DeleteUserPreferences", + "parameters": [ + { + "name": "Id", + "in": "path", + "description": "The identifier of the user.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the user." + } + }, + { + "name": "SetName", + "in": "path", + "description": "The name of the preference set to be deleted.", + "required": true, + "schema": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", + "type": "string", + "description": "The name of the preference set to be deleted." + } + }, + { + "name": "ItemName", + "in": "query", + "description": "The item name of the preference item which need to be deleted from the set; if null or empty - the entire set with all the items will be deleted.", + "schema": { + "maxLength": 255, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", + "type": "string", + "description": "The item name of the preference item which need to be deleted from the set; if null or empty - the entire set with all the items will be deleted.", + "nullable": true + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Variables/{Variable}/UsedInDocumentObjects/Get": { + "post": { + "tags": [ + "Variables" + ], + "summary": "Gets the list of document objects that use the specified variable.", + "operationId": "GetDocumentObjectListUsingVariable", + "parameters": [ + { + "name": "Variable", + "in": "path", + "description": "The identifier of the variable.", + "required": true, + "schema": { + "maxLength": 1333, + "minLength": 1, + "type": "string", + "description": "The identifier of the variable." + } + } + ], + "requestBody": { + "description": "Request body containing filter criteria.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetDocumentObjectListUsingVariable" + } + ], + "description": "Request object to get all document objects in the repository where the variable is used." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetDocumentObjectListUsingVariable" + } + ], + "description": "Request object to get all document objects in the repository where the variable is used." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/GetDocumentObjectListUsingVariable" + } + ], + "description": "Request object to get all document objects in the repository where the variable is used." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObject" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObject" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Workflows/StatusDefinitions": { + "get": { + "tags": [ + "Workflows" + ], + "summary": "Gets the set of all workflow status definitions.", + "operationId": "GetStatusDefinitionList", + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusDefinition" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusDefinition" + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "post": { + "tags": [ + "Workflows" + ], + "summary": "Creates a workflow status definition.", + "operationId": "CreateStatusDefinition", + "requestBody": { + "description": "The create status definition model.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateStatusDefinition" + } + ], + "description": "Represents a model for create status definition." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateStatusDefinition" + } + ], + "description": "Represents a model for create status definition." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/CreateStatusDefinition" + } + ], + "description": "Represents a model for create status definition." + } + } + } + }, + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StatusDefinition" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/StatusDefinition" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + }, + "/v3/Workflows/StatusDefinitions/{id}": { + "get": { + "tags": [ + "Workflows" + ], + "summary": "Gets the workflow status definition with the specified ID.", + "operationId": "GetStatusDefinition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The status definition id.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StatusDefinition" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/StatusDefinition" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "put": { + "tags": [ + "Workflows" + ], + "summary": "Updates the workflow status definition with the specified ID.", + "operationId": "UpdateStatusDefinition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of the status definition.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "Update status definition model.", + "content": { + "application/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateStatusDefinition" + } + ], + "description": "Represents an update status definition model." + } + }, + "text/json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateStatusDefinition" + } + ], + "description": "Represents an update status definition model." + } + }, + "application/*+json": { + "schema": { + "allOf": [ + { + "$ref": "#/components/schemas/UpdateStatusDefinition" + } + ], + "description": "Represents an update status definition model." + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "409": { + "description": "Conflict", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Workflows" + ], + "summary": "Deletes the workflow status definition with the specified ID.", + "operationId": "DeleteStatusDefinition", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier of the status definition.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + }, + "default": { + "description": "Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/InfoShareProblemDetails" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "ActivityFilter": { + "enum": [ + "none", + "active", + "inactive" + ], + "type": "string", + "description": "Allows explicit filtering." + }, + "AddShortcut": { + "required": [ + "logicalId" + ], + "type": "object", + "properties": { + "logicalId": { + "minLength": 1, + "type": "string", + "description": "Specify logical identifier of the document object or publication for which to create a shortcut." + } + }, + "additionalProperties": false, + "description": "Represents logical identifier model." + }, + "AddTranslationJobSourceObjects": { + "required": [ + "translationJobSourceObjects" + ], + "type": "object", + "properties": { + "translationJobSourceObjects": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/TranslationJobSourceObject" + }, + "description": "Source object to be added." + } + }, + "additionalProperties": false, + "description": "Represents source objects to be added to the translation job." + }, + "AddTranslationJobSourceObjectsParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The translation object identifier." + } + }, + "additionalProperties": false, + "description": "Represents a translation job to where source object to be added." + }, + "AndSearchExpression": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GroupSearchExpression" + } + ], + "additionalProperties": false, + "description": "Represents collection of search expression to be evaluated with AND logical operator." + }, + "Annotation": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + } + ], + "properties": { + "annotationId": { + "type": "string", + "description": "The annotation identifier." + }, + "replyCardId": { + "type": "integer", + "description": "An annotation reply identifier.", + "format": "int64", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents an annotation." + }, + "AnnotationMetadata": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + } + ], + "properties": { + "annotationId": { + "type": "string", + "description": "Gets or sets the unique identifier for the annotation." + }, + "annotationReplyMetadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AnnotationReplyMetadata" + }, + "description": "Gets or sets the collection of metadata associated with annotation replies.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents metadata associated with an annotation, including its unique identifier and related replies." + }, + "AnnotationReplyMetadata": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + } + ], + "properties": { + "annotationId": { + "type": "string", + "description": "Gets or sets the unique identifier for the annotation." + }, + "replyCardId": { + "type": "integer", + "description": "Gets or sets the unique identifier of the reply card associated with the current entity.", + "format": "int64" + } + }, + "additionalProperties": false, + "description": "Represents metadata associated with a reply to an annotation." + }, + "AnywhereSearchFieldValue": { + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SearchExpression" + } + ], + "properties": { + "operator": { + "allOf": [ + { + "$ref": "#/components/schemas/FullTextSearchOperator" + } + ], + "description": "The search operator." + }, + "value": { + "minLength": 1, + "type": "string", + "description": "The value to search for." + } + }, + "additionalProperties": false, + "description": "Represents anywhere search field value." + }, + "BackgroundTask": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + } + ], + "properties": { + "taskId": { + "type": "integer", + "description": "The identifier of the task.", + "format": "int64" + }, + "historyId": { + "type": "integer", + "description": "The identifier of the background task history record.", + "format": "int64", + "nullable": true + }, + "progressId": { + "type": "integer", + "description": "The progress id.", + "format": "int64", + "nullable": true + }, + "eventId": { + "type": "string", + "description": "The event id.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents a background task." + }, + "BaseFolder": { + "enum": [ + "none", + "data", + "system", + "favorites", + "editorTemplate" + ], + "type": "string", + "description": "Enumeration holding all base folders." + }, + "BaseItem": { + "required": [ + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/RelatedInfo" + } + ], + "properties": { + "type": { + "type": "string" + }, + "id": { + "type": "string", + "description": "The identifier." + }, + "title": { + "type": "string", + "description": "The title.", + "nullable": true + }, + "description": { + "type": "string", + "description": "The description.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents an item.", + "discriminator": { + "propertyName": "type", + "mapping": { + "User": "#/components/schemas/User", + "UserRole": "#/components/schemas/UserRole", + "UserGroup": "#/components/schemas/UserGroup", + "TranslationJob": "#/components/schemas/TranslationJob", + "LanguageGroup": "#/components/schemas/LanguageGroup", + "LovValueWithIcon": "#/components/schemas/LovValueWithIcon", + "Setting": "#/components/schemas/Setting", + "InContextDocumentObject": "#/components/schemas/InContextDocumentObject", + "Publication": "#/components/schemas/Publication", + "Project": "#/components/schemas/Project", + "OutputFormat": "#/components/schemas/OutputFormat", + "BaseObject": "#/components/schemas/BaseObject", + "LovList": "#/components/schemas/LovList", + "LovValue": "#/components/schemas/LovValue", + "RevisionInfo": "#/components/schemas/RevisionInfo", + "Tag": "#/components/schemas/Tag", + "SearchObject": "#/components/schemas/SearchObject", + "FormFieldOperator": "#/components/schemas/FormFieldOperator", + "FullTextSearchFormFieldOperator": "#/components/schemas/FullTextSearchFormFieldOperator", + "MetadataFilterFormFieldOperator": "#/components/schemas/MetadataFilterFormFieldOperator", + "Folder": "#/components/schemas/Folder", + "EventProgress": "#/components/schemas/EventProgress", + "ElectronicDocumentType": "#/components/schemas/ElectronicDocumentType", + "DocumentObject": "#/components/schemas/DocumentObject", + "RevisionHistoryItem": "#/components/schemas/RevisionHistoryItem", + "Baseline": "#/components/schemas/Baseline", + "BackgroundTask": "#/components/schemas/BackgroundTask", + "Annotation": "#/components/schemas/Annotation", + "AnnotationMetadata": "#/components/schemas/AnnotationMetadata", + "AnnotationReplyMetadata": "#/components/schemas/AnnotationReplyMetadata" + } + } + }, + "BaseObject": { + "required": [ + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseItem" + } + ], + "properties": { + "type": { + "type": "string" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FieldValue" + }, + "description": "The list of field values.", + "nullable": true + }, + "links": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Link" + }, + "description": "A list of actions or links that are allowed on the object.", + "nullable": true + }, + "messages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Message" + }, + "description": "A list of messages related to the object. The messages can contain warnings and errors.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Base definition for objects.", + "discriminator": { + "propertyName": "type", + "mapping": { + "User": "#/components/schemas/User", + "UserRole": "#/components/schemas/UserRole", + "UserGroup": "#/components/schemas/UserGroup", + "TranslationJob": "#/components/schemas/TranslationJob", + "Setting": "#/components/schemas/Setting", + "InContextDocumentObject": "#/components/schemas/InContextDocumentObject", + "Publication": "#/components/schemas/Publication", + "Project": "#/components/schemas/Project", + "OutputFormat": "#/components/schemas/OutputFormat", + "RevisionInfo": "#/components/schemas/RevisionInfo", + "SearchObject": "#/components/schemas/SearchObject", + "Folder": "#/components/schemas/Folder", + "EventProgress": "#/components/schemas/EventProgress", + "ElectronicDocumentType": "#/components/schemas/ElectronicDocumentType", + "DocumentObject": "#/components/schemas/DocumentObject", + "RevisionHistoryItem": "#/components/schemas/RevisionHistoryItem", + "Baseline": "#/components/schemas/Baseline", + "BackgroundTask": "#/components/schemas/BackgroundTask", + "Annotation": "#/components/schemas/Annotation", + "AnnotationMetadata": "#/components/schemas/AnnotationMetadata", + "AnnotationReplyMetadata": "#/components/schemas/AnnotationReplyMetadata" + } + } + }, + "BaseSearchSortField": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "readOnly": true + }, + "sortOrder": { + "allOf": [ + { + "$ref": "#/components/schemas/SearchSortOrder" + } + ], + "description": "The sort order type." + } + }, + "additionalProperties": false, + "description": "Represents Base Search Sort Fields", + "discriminator": { + "propertyName": "type", + "mapping": { + "ScoreSearchSortField": "#/components/schemas/ScoreSearchSortField", + "SearchSortField": "#/components/schemas/SearchSortField" + } + } + }, + "Baseline": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + } + ], + "additionalProperties": false, + "description": "Represents a baseline." + }, + "BaselineAutoCompleteMode": { + "enum": [ + "none", + "firstVersion", + "latestReleased", + "latestAvailable" + ], + "type": "string", + "description": "Indicates which auto complete mode must be used to select the version in the baseline report." + }, + "BaselineEntry": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "id": { + "type": "string", + "description": "The unique element name of the card on the logical level" + }, + "source": { + "allOf": [ + { + "$ref": "#/components/schemas/BaselineEntrySource" + } + ], + "description": "Who or what is responsible for the current version number of the object in the baseline." + }, + "version": { + "type": "string", + "description": "The version number of the version card.", + "nullable": true + }, + "author": { + "allOf": [ + { + "$ref": "#/components/schemas/User" + } + ], + "description": "The Author of the object.", + "nullable": true + }, + "creationDate": { + "type": "string", + "description": "The creation date of the object.", + "format": "date-time", + "nullable": true + }, + "modificationDate": { + "type": "string", + "description": "The last modification date of the object.", + "format": "date-time", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents a baseline entry.", + "discriminator": { + "propertyName": "type", + "mapping": { + "BaselineEntry": "#/components/schemas/BaselineEntry", + "BaselineReportEntry": "#/components/schemas/BaselineReportEntry" + } + } + }, + "BaselineEntrySource": { + "enum": [ + "none", + "manual", + "expandLatestAvailable", + "expandLatestReleased", + "expandByBaseline", + "expandCandidate", + "expandFirstVersion", + "expandNone", + "saveManual", + "saveLatestAvailable", + "saveLatestReleased", + "saveByBaseline", + "saveCandidate", + "saveFirstVersion", + "saveCopy", + "saveCreateReuse" + ], + "type": "string", + "description": "Enumeration holding all values for the BaselineEntry source" + }, + "BaselineFreezeReport": { + "type": "object", + "properties": { + "baseline": { + "allOf": [ + { + "$ref": "#/components/schemas/Baseline" + } + ], + "description": "Baseline that freeze report belongs to." + }, + "publicationFreezeReports": { + "type": "array", + "items": { + "$ref": "#/components/schemas/PublicationFreezeReport" + }, + "description": "A list of freeze status per publication.", + "nullable": true + }, + "isFrozen": { + "type": "boolean", + "description": "Flag to indicate if baseline froze can be frozen or not." + } + }, + "additionalProperties": false, + "description": "Represents the freeze status of baseline." + }, + "BaselineReportEntry": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaselineEntry" + } + ], + "properties": { + "versionCardId": { + "type": "integer", + "description": "The version of the baseline report entry.", + "format": "int64", + "nullable": true + }, + "documentObjectType": { + "allOf": [ + { + "$ref": "#/components/schemas/DocumentObjectType" + } + ], + "description": "The document object type of the baseline report entry." + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/BaselineReportItem" + }, + "description": "The items of the baseline report entry.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents a baseline report entry." + }, + "BaselineReportItem": { + "type": "object", + "properties": { + "reportLanguage": { + "allOf": [ + { + "$ref": "#/components/schemas/LovValue" + } + ], + "description": "The reporting language of the baseline" + }, + "reportResolution": { + "allOf": [ + { + "$ref": "#/components/schemas/LovValue" + } + ], + "description": "The resolution of the illustration. For non-illustration object, the resolution is an empty string." + }, + "reportResult": { + "allOf": [ + { + "$ref": "#/components/schemas/BaselineReportResult" + } + ], + "description": "The result of the report." + }, + "languageCardId": { + "type": "integer", + "description": "The language card id of the baseline report item.", + "format": "int64", + "nullable": true + }, + "sourceLanguage": { + "allOf": [ + { + "$ref": "#/components/schemas/LovValue" + } + ], + "description": "Source language of the baseline report item.", + "nullable": true + }, + "languages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LovValue" + }, + "description": "The list of languages of the baseline report item.\r\n\r\n For Topics, this property would contain a single language.\r\n For Illustrations, it may contain multiple languages.\r\n", + "nullable": true + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/LovValue" + } + ], + "description": "The status of the baseline report item.", + "nullable": true + }, + "links": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The links of the baseline report item.", + "nullable": true + }, + "imageLinks": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The image links of the baseline report item.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents a baseline report item." + }, + "BaselineReportResult": { + "enum": [ + "ok", + "languageVersionMissing", + "notInUse", + "notReleased", + "noValidVersionFound", + "objectMissing", + "objectMissingInBaseline", + "versionMissing" + ], + "type": "string", + "description": "Enumeration holding the possible values for the baseline report result." + }, + "CancelPublicationPublish": { + "type": "object", + "properties": { + "requiredCurrentFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to update the Trisoft.InfoShare.WebApi.V30.Publications.Models.Publication", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents an update model for CancelPublicationPublish." + }, + "CancelTranslationJob": { + "type": "object", + "properties": { + "requiredCurrentFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to update the Trisoft.InfoShare.WebApi.V30.TranslationJobs.Models.TranslationJob." + } + }, + "additionalProperties": false, + "description": "Represents a cancel translation job model." + }, + "CancelTranslationJobParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the translation job." + } + }, + "additionalProperties": false, + "description": "The request object to cancel the translation job by its identifier." + }, + "CardFieldValue": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/FieldValue" + } + ], + "properties": { + "value": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + } + ], + "description": "Base definition for objects.", + "nullable": true + } + }, + "additionalProperties": false + }, + "CardFilterFieldValue": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/FilterFieldValue" + } + ], + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetBaseObject" + }, + "description": "The filter field value." + } + }, + "additionalProperties": false + }, + "CardLikeFilterFieldValue": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/FilterFieldValue" + } + ], + "properties": { + "value": { + "type": "string", + "description": "The filter field value.", + "nullable": true + } + }, + "additionalProperties": false + }, + "CardSearchFieldValue": { + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SearchFieldValue" + } + ], + "properties": { + "value": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/SetBaseObject" + }, + "description": "Collection of values to search for." + } + }, + "additionalProperties": false, + "description": "Represents search field value of type System.Collections.Generic.IList`1." + }, + "CheckInDocumentObject": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "The list of field values to be changed." + }, + "requiredCurrentFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to update the Trisoft.InfoShare.WebApi.V30.DocumentObjects.Models.DocumentObject" + } + }, + "additionalProperties": false, + "description": "Request object to check in object content in the repository that match the criteria given in the properties." + }, + "CheckInDocumentObjectParameters": { + "required": [ + "languageCardId" + ], + "type": "object", + "properties": { + "languageCardId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" + } + }, + "additionalProperties": false, + "description": "Request parameters to check in the document object specified by the language card identifier." + }, + "CheckOutDocumentObject": { + "type": "object", + "properties": { + "requiredCurrentFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to check out the Trisoft.InfoShare.WebApi.V30.DocumentObjects.Models.DocumentObject" + } + }, + "additionalProperties": false, + "description": "Represents model to check out a document" + }, + "CheckOutDocumentObjectParameters": { + "required": [ + "languageCardId" + ], + "type": "object", + "properties": { + "languageCardId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" + } + }, + "additionalProperties": false, + "description": "Request parameters to check out the document object specified by the language card identifier." + }, + "CleanUpBaselineParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the baseline." + } + }, + "additionalProperties": false, + "description": "The request object to clean up baseline that match the criteria given in the properties." + }, + "CompleteBaseline": { + "type": "object", + "properties": { + "extendId": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Specify the element name of the Baseline that will be used to complete the Baseline.", + "nullable": true + }, + "autoCompleteMode": { + "allOf": [ + { + "$ref": "#/components/schemas/BaselineAutoCompleteMode" + } + ], + "description": "Specify the auto complete mode that must be used to select the versions in the Baseline.", + "default": "none" + }, + "startLogicalIds": { + "type": "array", + "items": { + "maxLength": 100, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string" + }, + "description": "Specify a list of logical identifiers of the root map or objects in the outline of the root map that will be used as the starting point for the baseline calculation." + }, + "startResourceLogicalIds": { + "type": "array", + "items": { + "maxLength": 100, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string" + }, + "description": "Specify a list of logical identifiers of resources that will be used as the starting point for the Baseline calculation." + }, + "languages": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of languages." + }, + "illustrationLanguages": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of fallback languages for illustrations." + }, + "resourceLanguages": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of fallback languages for resources." + }, + "resolutions": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of resolutions." + }, + "depth": { + "type": "integer", + "description": "Specify how many levels should be returned. If no value is provided all levels will be returned.\r\nNegative Depth means unlimited recursion. Depth 0 means just return the baseline entries for the supplied logical ids.", + "format": "int32", + "default": -1 + }, + "persist": { + "type": "boolean", + "description": "Specify if the results of the operation needs to be saved in the database or not.", + "default": false + } + }, + "additionalProperties": false, + "description": "The model contains the parameters which will be used to expand and complete the baseline starting from the incoming logicalIds using the extend baseline and/or the autocomplete mode." + }, + "CompleteBaselineParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the baseline." + } + }, + "additionalProperties": false, + "description": "The request object to complete baseline that match the criteria given in the properties." + }, + "CompleteReport": { + "required": [ + "entries", + "extendId" + ], + "type": "object", + "properties": { + "entries": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/SetBaselineEntry" + }, + "description": "Baseline report to extend." + }, + "extendId": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Specify the element name of the Baseline that will be used to complete the Baseline." + }, + "autoCompleteMode": { + "allOf": [ + { + "$ref": "#/components/schemas/BaselineAutoCompleteMode" + } + ], + "description": "Specify the element name of the Baseline that will be used to complete the Baseline." + }, + "startLogicalIds": { + "type": "array", + "items": { + "maxLength": 100, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string" + }, + "description": "Specify a list of logical identifiers of the root map or objects in the outline of the root map that will be used as the starting point for the baseline calculation." + }, + "startResourceLogicalIds": { + "type": "array", + "items": { + "maxLength": 100, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string" + }, + "description": "Specify a list of logical identifiers of resources that will be used as the starting point for the Baseline calculation." + }, + "languages": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of languages." + }, + "illustrationLanguages": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of fallback languages for illustrations." + }, + "resourceLanguages": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of fallback languages for resources." + }, + "resolutions": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of resolutions." + }, + "depth": { + "type": "integer", + "description": "Specify how many levels should be returned. If no value is provided all levels will be returned.\r\nNegative Depth means unlimited recursion. Depth 0 means just return the baseline entries for the supplied logical ids.", + "format": "int32", + "default": -1 + } + }, + "additionalProperties": false, + "description": "The model contains the parameters which will be used to expand the baseline starting from the incoming logicalIds using candidates for the baseline." + }, + "ContentInfo": { + "type": "object", + "properties": { + "ishDataRef": { + "type": "integer", + "description": "The unique identifier of the ED [ishdataref].", + "format": "int64" + }, + "size": { + "type": "integer", + "description": "The size of content data in bytes.", + "format": "int64" + }, + "mimeType": { + "type": "string", + "description": "The MimeType of the document." + }, + "fileExtension": { + "type": "string", + "description": "The FileExtension of the document." + }, + "revisionId": { + "type": "string", + "description": "The element name of the revision level." + }, + "languageCardId": { + "type": "integer", + "description": "The unique identifier of language level.", + "format": "int64" + }, + "edtId": { + "type": "string", + "description": "The element name of the EDT." + } + }, + "additionalProperties": false, + "description": "Represents revision information of content." + }, + "CopyBaseline": { + "required": [ + "id", + "title" + ], + "type": "object", + "properties": { + "title": { + "minLength": 1, + "type": "string", + "description": "The title of the new baseline." + }, + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the baseline." + } + }, + "additionalProperties": false, + "description": "Represents the information required for copying baseline." + }, + "CreateAnnotation": { + "required": [ + "fields" + ], + "type": "object", + "properties": { + "fields": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "The list of field values." + } + }, + "additionalProperties": false, + "description": "Represents a create annotation model." + }, + "CreateAnnotationReply": { + "required": [ + "annotationId", + "fields" + ], + "type": "object", + "properties": { + "annotationId": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "An annotation identifier." + }, + "fields": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "The list of field values." + } + }, + "additionalProperties": false, + "description": "Represents a create annotation reply model." + }, + "CreateBackgroundTask": { + "required": [ + "eventType" + ], + "type": "object", + "properties": { + "eventType": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", + "type": "string", + "description": "Type of event/background task." + }, + "progressId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "Unique identifier of the event log for this background task. If no progressId is provided, a new event log will be created.", + "format": "int64", + "nullable": true + }, + "eventDescription": { + "maxLength": 255, + "type": "string", + "description": "Description of the background task. This will only be used while creating a new event log.", + "nullable": true + }, + "hashId": { + "maxLength": 80, + "pattern": "^[a-zA-Z0-9+!:|&=\\\\/#@%?~._-]+$", + "type": "string", + "description": "The hashId that will be used to skip older background task for the same action. For instance, synchronizing the same language object only once to SDL LiveContent.", + "nullable": true + }, + "startAfter": { + "type": "string", + "description": "DateTime in UTC indicating that the background task should not be started before the specified time.\r\nIf the background task service is still processing other background tasks, the background task will not start at the specified time but later.", + "format": "date-time", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents the information required for creating background task." + }, + "CreateBackgroundTaskForDocumentObjectByLanguageCardId": { + "required": [ + "eventType", + "languageCardIds" + ], + "type": "object", + "properties": { + "eventType": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", + "type": "string", + "description": "Specify the type of event to be created." + }, + "languageCardIds": { + "minItems": 1, + "type": "array", + "items": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "format": "int64" + }, + "description": "Language card identifiers of the objects." + } + }, + "additionalProperties": false, + "description": "Request object to create background task for language card identifiers." + }, + "CreateBaseline": { + "required": [ + "title" + ], + "type": "object", + "properties": { + "title": { + "minLength": 1, + "type": "string", + "description": "The title of the baseline." + } + }, + "additionalProperties": false, + "description": "Represents the information required for creating baseline." + }, + "CreateDocumentObject": { + "required": [ + "folderId" + ], + "type": "object", + "properties": { + "folderId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "Specify the card identifier of the folder where to create the new object.", + "format": "int64" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Specify the fields of the object." + } + }, + "additionalProperties": false, + "description": "Request object to create document object." + }, + "CreateDocumentObjectLanguage": { + "required": [ + "logicalId" + ], + "type": "object", + "properties": { + "logicalId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Specify the logical card identifier of the object where to create the new language." + }, + "version": { + "type": "string", + "description": "Specify the version of the object where to create the new language.\r\nDefault: Latest.", + "nullable": true + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Specify the fields of the object." + } + }, + "additionalProperties": false, + "description": "Request object to create a new language of document object." + }, + "CreateDocumentObjectVersion": { + "required": [ + "logicalId" + ], + "type": "object", + "properties": { + "logicalId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Specify the logical card identifier of the object where to create the new version." + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Specify the fields of the object." + } + }, + "additionalProperties": false, + "description": "Request object to create a new version of document object." + }, + "CreateElectronicDocumentType": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "The list of field values." + } + }, + "additionalProperties": false, + "description": "The request object to create an electronic document type." + }, + "CreateEvent": { + "required": [ + "description", + "eventType" + ], + "type": "object", + "properties": { + "eventType": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", + "type": "string", + "description": "Type of event you want to log information for." + }, + "description": { + "minLength": 1, + "type": "string", + "description": "Description of the event." + }, + "maximumProgress": { + "minimum": 0, + "type": "integer", + "description": "The maximum progress you expect for this type of event.", + "format": "int32", + "default": 100 + }, + "parentProgressId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The identifier of the main event, if the event belongs to a cluster of smaller events.", + "format": "int64", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents a create event model." + }, + "CreateEventDetail": { + "required": [ + "action", + "description", + "eventLevel", + "progressId", + "status" + ], + "type": "object", + "properties": { + "progressId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The unique identifier of an event.", + "format": "int64" + }, + "eventLevel": { + "allOf": [ + { + "$ref": "#/components/schemas/EventLevel" + } + ], + "description": "The event level." + }, + "action": { + "minLength": 1, + "type": "string", + "description": "The action that is being logged." + }, + "description": { + "minLength": 1, + "type": "string", + "description": "Description of the action that is being logged." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/DetailStatus" + } + ], + "description": "Status of the event detail." + }, + "dataType": { + "allOf": [ + { + "$ref": "#/components/schemas/EventDataType" + } + ], + "description": "Type of the blob attached to this event detail.", + "default": "none", + "nullable": true + }, + "currentProgress": { + "minimum": 0, + "type": "integer", + "description": "The current position within the progress range.", + "format": "int32", + "nullable": true + }, + "maximumProgress": { + "minimum": 0, + "type": "integer", + "description": "The maximum progress you expect for this type of event.", + "format": "int32", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Create event detail request model." + }, + "CreateFolder": { + "required": [ + "parentId" + ], + "type": "object", + "properties": { + "parentId": { + "minLength": 1, + "type": "string", + "description": "The identifier of parent folder (e.g. 34567)." + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "The list of field values." + } + }, + "additionalProperties": false, + "description": "Represents a create folder model." + }, + "CreateLovValue": { + "required": [ + "title" + ], + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The lov value identifier", + "nullable": true + }, + "title": { + "minLength": 1, + "type": "string", + "description": "The lov value title" + }, + "description": { + "type": "string", + "description": "The lov value description", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents a create lov Value model." + }, + "CreateOutputFormat": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "The list of field values." + } + }, + "additionalProperties": false, + "description": "Represents a create output format model" + }, + "CreateProject": { + "type": "object", + "properties": { + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetUser" + }, + "description": "List with users that should be assigned.", + "nullable": true + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Specify the fields of the object." + } + }, + "additionalProperties": false, + "description": "Represents a create project model." + }, + "CreateProjectAssignee": { + "type": "object", + "properties": { + "projectId": { + "type": "string", + "description": "The project identifier." + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Specify the fields of the assignee." + } + }, + "additionalProperties": false, + "description": "Represents a create project assignee model." + }, + "CreatePublication": { + "required": [ + "folderId" + ], + "type": "object", + "properties": { + "folderId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "Specify the folder to create publication in by its id.", + "format": "int64" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Specify the fields of the object." + } + }, + "additionalProperties": false, + "description": "Represents a model to create a publication." + }, + "CreatePublicationLanguage": { + "required": [ + "logicalId" + ], + "type": "object", + "properties": { + "logicalId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Specify the logical identifier of the object." + }, + "version": { + "type": "string", + "description": "Specify the version.", + "nullable": true + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Specify the fields of the object." + } + }, + "additionalProperties": false, + "description": "Represents a model to create a language of a publication." + }, + "CreatePublicationVersion": { + "required": [ + "logicalId" + ], + "type": "object", + "properties": { + "logicalId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Specify the logical identifier of the object." + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Specify the fields of the object." + } + }, + "additionalProperties": false, + "description": "Represents a model to create a version of a publication." + }, + "CreateStatusDefinition": { + "required": [ + "title" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The lov value identifier", + "nullable": true + }, + "title": { + "maxLength": 255, + "minLength": 1, + "type": "string", + "description": "The lov value title" + }, + "description": { + "maxLength": 1000, + "type": "string", + "description": "The lov value description", + "nullable": true + }, + "statusType": { + "allOf": [ + { + "$ref": "#/components/schemas/StatusType" + } + ], + "description": "StatusType: Type of the status described in Trisoft.InfoShare.WebApi.V30.Workflows.Models.CreateStatusDefinition.StatusType.", + "default": "draft" + } + }, + "additionalProperties": false, + "description": "Represents a model for create status definition." + }, + "CreateTranslationJob": { + "required": [ + "fields", + "workflows" + ], + "type": "object", + "properties": { + "targetFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Specify the target fields of the object.", + "nullable": true + }, + "fields": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Specify the fields of the object." + }, + "workflows": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/SetTranslationWorkflow" + }, + "description": "Specify the workflows of the object." + } + }, + "additionalProperties": false, + "description": "Represents a create translation job model." + }, + "CreateUser": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "The list of field values." + } + }, + "additionalProperties": false, + "description": "Represents an create user model." + }, + "CreateUserGroup": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "The list of field values." + } + }, + "additionalProperties": false, + "description": "Represents a create user group model" + }, + "CreateUserRole": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "The list of field values." + } + }, + "additionalProperties": false, + "description": "Represents a create user role model" + }, + "DateTimeFieldValue": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/FieldValue" + } + ], + "properties": { + "value": { + "type": "string", + "format": "date-time", + "nullable": true + } + }, + "additionalProperties": false + }, + "DateTimeFilterFieldValue": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/FilterFieldValue" + } + ], + "properties": { + "value": { + "type": "array", + "items": { + "type": "string", + "format": "date-time" + }, + "description": "The filter field value." + } + }, + "additionalProperties": false + }, + "DateTimeSearchFieldValue": { + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SearchFieldValue" + } + ], + "properties": { + "value": { + "minItems": 1, + "type": "array", + "items": { + "type": "string", + "format": "date-time" + }, + "description": "Collection of values to search for." + } + }, + "additionalProperties": false, + "description": "Represents search field value of type System.Collections.Generic.IList`1." + }, + "DeleteAnnotationByAnnotationIdParameters": { + "required": [ + "annotationId" + ], + "type": "object", + "properties": { + "annotationId": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The annotation identifier." + } + }, + "additionalProperties": false, + "description": "The request object to delete the annotation by the annotation identifier." + }, + "DeleteAnnotationByReplyCardIdParameters": { + "required": [ + "replyCardId" + ], + "type": "object", + "properties": { + "replyCardId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "Reply card identifier.", + "format": "int64" + } + }, + "additionalProperties": false, + "description": "The request object to Delete the annotation reply by the annotation reply identifier." + }, + "DeleteBaselineParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the baseline." + } + }, + "additionalProperties": false, + "description": "The request object to delete baseline that match the criteria given in the properties." + }, + "DeleteDocumentObjectByLanguageCardId": { + "type": "object", + "properties": { + "requiredCurrentFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "The fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to delete the Trisoft.InfoShare.WebApi.V30.DocumentObjects.Models.DocumentObject" + } + }, + "additionalProperties": false, + "description": "Request object to delete document object." + }, + "DeleteDocumentObjectByLanguageCardIdParameters": { + "required": [ + "languageCardId" + ], + "type": "object", + "properties": { + "languageCardId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" + } + }, + "additionalProperties": false, + "description": "Request parameters to delete the document object specified by the language card identifier." + }, + "DeleteDocumentObjectByLogicalId": { + "type": "object", + "properties": { + "requiredCurrentFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "The fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to delete the Trisoft.InfoShare.WebApi.V30.DocumentObjects.Models.DocumentObject" + } + }, + "additionalProperties": false, + "description": "Request object to delete document object." + }, + "DeleteDocumentObjectByLogicalIdParameters": { + "required": [ + "logicalId" + ], + "type": "object", + "properties": { + "logicalId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The logical identifier of the document object." + }, + "version": { + "type": "string", + "description": "The version of the document object.", + "nullable": true + }, + "language": { + "maxLength": 255, + "type": "string", + "description": "The language of the document object.", + "nullable": true + }, + "resolution": { + "maxLength": 255, + "type": "string", + "description": "The resolution of the document object.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Request parameters to delete the document object specified by the logical identifier, version, language or resolution." + }, + "DeleteElectronicDocumentTypeParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the electronic document type." + } + }, + "additionalProperties": false, + "description": "Represents the delete electronic document type model." + }, + "DeleteEvent": { + "type": "object", + "properties": { + "deleteFailedEvents": { + "type": "boolean", + "description": "`true` to delete events for which the status is Trisoft.InfoShare.WebApi.V30.Models.Enumerations.ProgressStatus.Failed; otherwise, `false`.", + "default": false + }, + "deleteBusyEvents": { + "type": "boolean", + "description": "`true` to delete events for which the status is Trisoft.InfoShare.WebApi.V30.Models.Enumerations.ProgressStatus.Busy; otherwise, `false`.", + "default": false + } + }, + "additionalProperties": false, + "description": "Represents a delete event model." + }, + "DeleteEventParameters": { + "required": [ + "progressId" + ], + "type": "object", + "properties": { + "progressId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "format": "int64" + } + }, + "additionalProperties": false, + "description": "Request parameters identifying the event." + }, + "DeleteMyPreferencesParameters": { + "required": [ + "setName" + ], + "type": "object", + "properties": { + "setName": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", + "type": "string", + "description": "The name of the preference set to delete." + }, + "itemName": { + "maxLength": 255, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", + "type": "string", + "description": "The name of the preference item to delete.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents a delete preference set model for the current user." + }, + "DeleteOutputFormatParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the output format." + } + }, + "additionalProperties": false, + "description": "Represents the delete output format model." + }, + "DeletePreferencesParameters": { + "required": [ + "id", + "setName" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the user." + }, + "setName": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", + "type": "string", + "description": "The name of the preference set to be deleted." + }, + "itemName": { + "maxLength": 255, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", + "type": "string", + "description": "The item name of the preference item which need to be deleted from the set; if null or empty - the entire set with all the items will be deleted.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "The request object to delete user preferences that match the criteria given in the properties." + }, + "DeleteProject": { + "type": "object", + "properties": { + "requiredCurrentFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to delete the Trisoft.InfoShare.WebApi.V30.Projects.Models.Project", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents a delete project model." + }, + "DeleteProjectAssignee": { + "type": "object", + "properties": { + "requiredCurrentFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to delete the assignee.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represent delete project's assignee model." + }, + "DeleteProjectAssigneeParameters": { + "required": [ + "assigneeCardId" + ], + "type": "object", + "properties": { + "assigneeCardId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "Identifier of the project's assignee.", + "format": "int64" + } + }, + "additionalProperties": false, + "description": "Represents the delete project's assignee model." + }, + "DeleteProjectParameters": { + "required": [ + "projectId" + ], + "type": "object", + "properties": { + "projectId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of a project." + } + }, + "additionalProperties": false, + "description": "Represents the delete project model." + }, + "DeletePublicationByLanguageCardId": { + "type": "object", + "properties": { + "requiredCurrentFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "The fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to delete the Trisoft.InfoShare.WebApi.V30.Publications.Models.Publication", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Request object to delete publication." + }, + "DeletePublicationByLogicalId": { + "type": "object", + "properties": { + "requiredCurrentFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "The fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to delete the Trisoft.InfoShare.WebApi.V30.Publications.Models.Publication", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Request object to delete publication." + }, + "DeleteTranslationJobParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the translation job." + } + }, + "additionalProperties": false, + "description": "Represents the delete translation job model." + }, + "DeleteTranslationJobSourceObjectParameters": { + "required": [ + "id", + "logicalId" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The translation object identifier." + }, + "logicalId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The source object logical identifier." + }, + "version": { + "type": "string", + "description": "The version number of the source object.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents a model for deleting source object from a translation job." + }, + "DeleteUserById": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the user." + } + }, + "additionalProperties": false, + "description": "Represents an delete user model." + }, + "DeleteUserGroupParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the user group." + } + }, + "additionalProperties": false, + "description": "Represents the delete user group model." + }, + "DeleteUserRoleParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the user role." + } + }, + "additionalProperties": false, + "description": "Represents the delete user role model." + }, + "DetailStatus": { + "enum": [ + "success", + "warning", + "failed" + ], + "type": "string", + "description": "Indicates the result of an action within an event." + }, + "DocumentObject": { + "required": [ + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + } + ], + "properties": { + "type": { + "type": "string" + }, + "documentObjectType": { + "allOf": [ + { + "$ref": "#/components/schemas/DocumentObjectType" + } + ], + "description": "The document object type." + }, + "languageCardId": { + "type": "integer", + "description": "The language card identifier.", + "format": "int64", + "nullable": true + }, + "versionCardId": { + "type": "integer", + "description": "The version card identifier.", + "format": "int64", + "nullable": true + }, + "logicalId": { + "type": "string", + "description": "The logical identifier." + }, + "version": { + "type": "string", + "description": "The version.", + "nullable": true + }, + "languageId": { + "type": "string", + "description": "The language identifier.", + "nullable": true + }, + "resolutionId": { + "type": "string", + "description": "The resolution identifier.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents a document.", + "discriminator": { + "propertyName": "type", + "mapping": { + "DocumentObject": "#/components/schemas/DocumentObject", + "InContextDocumentObject": "#/components/schemas/InContextDocumentObject" + } + } + }, + "DocumentObjectLink": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/RelatedInfo" + } + ], + "properties": { + "linkType": { + "allOf": [ + { + "$ref": "#/components/schemas/DocumentObjectLinkType" + } + ], + "description": "The type of the link." + }, + "target": { + "type": "string", + "description": "The reference to the contents that the link targets." + }, + "endTarget": { + "type": "string", + "description": "Reference to the last element in the range when a range of elements inside the contents is referenced.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents a link to a node in the contents of a document object." + }, + "DocumentObjectLinkType": { + "enum": [ + "contentReference", + "hyperlink", + "link", + "variable" + ], + "type": "string", + "description": "Defines the type of a link in the contents of a document object." + }, + "DocumentObjectParseError": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/RelatedInfo" + } + ], + "properties": { + "reason": { + "type": "string", + "description": "Message describing the current error.", + "nullable": true + }, + "lineNumber": { + "type": "integer", + "description": "The line number indicating where the error occurred. Line numbers start at 1.", + "format": "int32", + "nullable": true + }, + "linePosition": { + "type": "integer", + "description": "The line position indicating where the error occurred. Line position starts at 1.", + "format": "int32", + "nullable": true + }, + "errorCode": { + "type": "string", + "description": "The error code.", + "nullable": true + }, + "sourceText": { + "type": "string", + "description": "The text of the content that causes the error.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Returns detailed information about a parsing error in the contents of a document object." + }, + "DocumentObjectType": { + "enum": [ + "undefined", + "illustration", + "library", + "map", + "other", + "topic" + ], + "type": "string", + "description": "Enumeration holding the type of document." + }, + "DocumentObjectTypeFilter": { + "enum": [ + "any", + "illustration", + "library", + "map", + "other", + "topic" + ], + "type": "string", + "description": "Enumeration holding the type of document for filtering." + }, + "ElectronicDocumentType": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + } + ], + "additionalProperties": false, + "description": "Represents a edt." + }, + "Error": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/Message" + } + ], + "additionalProperties": false, + "description": "An error message." + }, + "EventDataType": { + "enum": [ + "none", + "string", + "list", + "xml", + "sendEventData", + "logObject", + "statusReport", + "commandOutput", + "ditaotLogFile", + "other" + ], + "type": "string", + "description": "Indicates the data type of the event data content." + }, + "EventGroup": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the group." + }, + "title": { + "type": "string", + "description": "The title of the group." + }, + "description": { + "type": "string", + "description": "The description of the group." + }, + "eventTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The event types for the group." + } + }, + "additionalProperties": false, + "description": "Represents a group of events." + }, + "EventLevel": { + "enum": [ + "exception", + "warning", + "configuration", + "information", + "verbose", + "debug" + ], + "type": "string", + "description": "Identifies the level of an event detail." + }, + "EventProgress": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + } + ], + "properties": { + "progressId": { + "type": "integer", + "description": "The progress id.", + "format": "int64" + }, + "detailId": { + "type": "integer", + "description": "The detail id.", + "format": "int64", + "nullable": true + }, + "eventId": { + "type": "string", + "description": "The event id.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents an event." + }, + "ExpandBaseline": { + "type": "object", + "properties": { + "startLogicalIds": { + "type": "array", + "items": { + "maxLength": 100, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string" + }, + "description": "Specify a list of logical identifiers of the root map or objects in the outline of the root map that will be used as the starting point for the Baseline calculation." + }, + "startResourceLogicalIds": { + "type": "array", + "items": { + "maxLength": 100, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string" + }, + "description": "Specify a list of logical identifiers of resources that will be used as the starting point for the Baseline calculation." + }, + "languages": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of languages." + }, + "illustrationLanguages": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of fallback languages for illustrations." + }, + "resourceLanguages": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of fallback languages for resources." + }, + "resolutions": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of resolutions." + }, + "depth": { + "type": "integer", + "description": "Specify how many levels should be returned. If no value is provided all levels will be returned. Valid values are greater than or equal to 1.", + "format": "int32", + "default": -1 + } + }, + "additionalProperties": false, + "description": "Represents a ExpandBaseline." + }, + "ExpandBaselineParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the baseline." + } + }, + "additionalProperties": false, + "description": "The request object to expand baseline report that match the criteria given in the properties." + }, + "ExpandReport": { + "required": [ + "entries" + ], + "type": "object", + "properties": { + "entries": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/SetBaselineEntry" + }, + "description": "Baseline report to extend." + }, + "startLogicalIds": { + "type": "array", + "items": { + "maxLength": 100, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string" + }, + "description": "Specify a list of logical identifiers of the root map or objects in the outline of the root map that will be used as the starting point for the baseline calculation." + }, + "startResourceLogicalIds": { + "type": "array", + "items": { + "maxLength": 100, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string" + }, + "description": "Specify a list of logical identifiers of resources that will be used as the starting point for the Baseline calculation." + }, + "languages": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of languages." + }, + "illustrationLanguages": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of fallback languages for illustrations." + }, + "resourceLanguages": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of fallback languages for resources." + }, + "resolutions": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of resolutions." + }, + "depth": { + "type": "integer", + "description": "Specify how many levels should be returned. If no value is provided all levels will be returned.\r\nNegative Depth means unlimited recursion. Depth 0 means just return the baseline entries for the supplied logical ids.", + "format": "int32", + "default": -1 + } + }, + "additionalProperties": false, + "description": "The model contains the parameters which will be used to expand the baseline starting from the incoming logicalIds using candidates for the baseline." + }, + "ExtendBaselineReportByBaseline": { + "required": [ + "entries", + "extendId" + ], + "type": "object", + "properties": { + "entries": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/SetBaselineEntry" + }, + "description": "Baseline report to extend." + }, + "extendId": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Specify the element name of the Baseline that will be used to complete the Baseline." + }, + "startLogicalIds": { + "type": "array", + "items": { + "maxLength": 100, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string" + }, + "description": "Specify a list of logical identifiers of the root map or objects in the outline of the root map that will be used as the starting point for the baseline calculation." + }, + "startResourceLogicalIds": { + "type": "array", + "items": { + "maxLength": 100, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string" + }, + "description": "Specify a list of logical identifiers of resources that will be used as the starting point for the Baseline calculation." + }, + "languages": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of languages." + }, + "illustrationLanguages": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of fallback languages for illustrations." + }, + "resourceLanguages": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of fallback languages for resources." + }, + "resolutions": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of resolutions." + }, + "depth": { + "type": "integer", + "description": "Specify how many levels should be returned. If no value is provided all levels will be returned.\r\nNegative Depth means unlimited recursion. Depth 0 means just return the baseline entries for the supplied logical ids.", + "format": "int32", + "default": -1 + } + }, + "additionalProperties": false, + "description": "The model contains the parameters which will be used to expand the baseline starting from the incoming logicalIds using the extend baseline." + }, + "ExtendBaselineReportByCandidate": { + "required": [ + "entries", + "extendId" + ], + "type": "object", + "properties": { + "entries": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/SetBaselineEntry" + }, + "description": "Baseline report to extend." + }, + "extendId": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Specify the element name of the Baseline that will be used to complete the Baseline." + }, + "startLogicalIds": { + "type": "array", + "items": { + "maxLength": 100, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string" + }, + "description": "Specify a list of logical identifiers of the root map or objects in the outline of the root map that will be used as the starting point for the baseline calculation." + }, + "startResourceLogicalIds": { + "type": "array", + "items": { + "maxLength": 100, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string" + }, + "description": "Specify a list of logical identifiers of resources that will be used as the starting point for the Baseline calculation." + }, + "languages": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of languages." + }, + "illustrationLanguages": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of fallback languages for illustrations." + }, + "resourceLanguages": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of fallback languages for resources." + }, + "resolutions": { + "type": "array", + "items": { + "maxLength": 255, + "type": "string" + }, + "description": "Specify a list of resolutions." + }, + "depth": { + "type": "integer", + "description": "Specify how many levels should be returned. If no value is provided all levels will be returned.\r\nNegative Depth means unlimited recursion. Depth 0 means just return the baseline entries for the supplied logical ids.", + "format": "int32", + "default": -1 + } + }, + "additionalProperties": false, + "description": "The model contains the parameters which will be used to expand the baseline starting from the incoming logicalIds using candidates for the baseline." + }, + "FieldCardReference": { + "type": "object", + "properties": { + "objectType": { + "allOf": [ + { + "$ref": "#/components/schemas/ObjectType" + } + ], + "description": "Gets the object type." + }, + "level": { + "allOf": [ + { + "$ref": "#/components/schemas/Level" + } + ], + "description": "Gets the InfoShare level of the field." + } + }, + "additionalProperties": false, + "description": "Represents a field card reference." + }, + "FieldGroup": { + "enum": [ + "none", + "basic", + "descriptive", + "system", + "all" + ], + "type": "string", + "description": "Groups of metadata fields." + }, + "FieldSetup": { + "type": "object", + "properties": { + "typeDefinitions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TypeDefinition" + }, + "description": "Gets a list of type definitions.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents a field setup." + }, + "FieldTag": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/TagList" + } + ], + "properties": { + "ishField": { + "allOf": [ + { + "$ref": "#/components/schemas/IshField" + } + ], + "description": "Gets or sets the field with information the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." + } + }, + "additionalProperties": false, + "description": "Represents a tag list with an field." + }, + "FieldType": { + "enum": [ + "string", + "longText", + "dateTime", + "number", + "card", + "lov", + "tag", + "long" + ], + "type": "string", + "description": "Enumeration that lists possible field types." + }, + "FieldValue": { + "required": [ + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/RelatedInfo" + } + ], + "properties": { + "type": { + "type": "string" + }, + "name": { + "type": "string" + }, + "ishField": { + "allOf": [ + { + "$ref": "#/components/schemas/IshField" + } + ], + "description": "The field with information the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." + }, + "title": { + "type": "string", + "description": "The user-friendly title of the field.", + "nullable": true + }, + "description": { + "type": "string", + "description": "The description of the field.", + "nullable": true + }, + "isModified": { + "type": "boolean", + "description": "Indicates whether the value has been modified by the metadata\r\nconfiguration since the object was created or its metadata was last set.", + "nullable": true + }, + "messages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Message" + }, + "description": "A list of messages related to the field value.\r\nThe messages can contain warnings and errors.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents a field value that contains information to access a field, and the value associated with the field.", + "discriminator": { + "propertyName": "type", + "mapping": { + "CardFieldValue": "#/components/schemas/CardFieldValue", + "DateTimeFieldValue": "#/components/schemas/DateTimeFieldValue", + "LongFieldValue": "#/components/schemas/LongFieldValue", + "LovFieldValue": "#/components/schemas/LovFieldValue", + "MultiCardFieldValue": "#/components/schemas/MultiCardFieldValue", + "MultiDateTimeFieldValue": "#/components/schemas/MultiDateTimeFieldValue", + "MultiLovFieldValue": "#/components/schemas/MultiLovFieldValue", + "MultiNumberFieldValue": "#/components/schemas/MultiNumberFieldValue", + "MultiStringFieldValue": "#/components/schemas/MultiStringFieldValue", + "MultiTagFieldValue": "#/components/schemas/MultiTagFieldValue", + "MultiVersionFieldValue": "#/components/schemas/MultiVersionFieldValue", + "NumberFieldValue": "#/components/schemas/NumberFieldValue", + "ObjectFieldValue": "#/components/schemas/ObjectFieldValue", + "StringFieldValue": "#/components/schemas/StringFieldValue", + "TagFieldValue": "#/components/schemas/TagFieldValue", + "VersionFieldValue": "#/components/schemas/VersionFieldValue" + } + } + }, + "FilterFieldValue": { + "required": [ + "ishField", + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the current object.", + "readOnly": true + }, + "ishField": { + "allOf": [ + { + "$ref": "#/components/schemas/IshField" + } + ], + "description": "The field with information about the name/label of the field in the Repository (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." + }, + "operator": { + "allOf": [ + { + "$ref": "#/components/schemas/MetadataFilterOperator" + } + ], + "description": "The filter operator (e.g. equal, not in, like).", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents a filter field that contains information to access a field, and the value associated with the field.", + "discriminator": { + "propertyName": "type", + "mapping": { + "CardFilterFieldValue": "#/components/schemas/CardFilterFieldValue", + "CardLikeFilterFieldValue": "#/components/schemas/CardLikeFilterFieldValue", + "DateTimeFilterFieldValue": "#/components/schemas/DateTimeFilterFieldValue", + "LongFilterFieldValue": "#/components/schemas/LongFilterFieldValue", + "LovFilterFieldValue": "#/components/schemas/LovFilterFieldValue", + "LovLikeFilterFieldValue": "#/components/schemas/LovLikeFilterFieldValue", + "NumberFilterFieldValue": "#/components/schemas/NumberFilterFieldValue", + "StringFilterFieldValue": "#/components/schemas/StringFilterFieldValue", + "TagFilterFieldValue": "#/components/schemas/TagFilterFieldValue" + } + } + }, + "Folder": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + } + ], + "properties": { + "folderType": { + "allOf": [ + { + "$ref": "#/components/schemas/FolderType" + } + ], + "description": "The type of the folder (e.g. ReferenceFolder, PublicationFolder, TopicFolder)." + }, + "baseFolder": { + "allOf": [ + { + "$ref": "#/components/schemas/BaseFolder" + } + ], + "description": "The type of the base folder (e.g. Data, System, Favorites, EditorTemplate)." + } + }, + "additionalProperties": false, + "description": "Represents a folder." + }, + "FolderDescriptor": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identifier (e.g. 34567)." + }, + "folderType": { + "allOf": [ + { + "$ref": "#/components/schemas/FolderType" + } + ], + "description": "The type of the folder (e.g. ReferenceFolder, PublicationFolder, TopicFolder)." + } + }, + "additionalProperties": false, + "description": "Represents a folder descriptor model." + }, + "FolderObjectTypeFilter": { + "enum": [ + "any", + "contents", + "folders" + ], + "type": "string", + "description": "Enumeration that lists possible folder item types." + }, + "FolderType": { + "enum": [ + "folder", + "illustrationFolder", + "libraryFolder", + "mapFolder", + "otherFolder", + "publicationFolder", + "referenceFolder", + "topicFolder" + ], + "type": "string", + "description": "Enumeration holding the type of a folder." + }, + "FormFieldOperator": { + "required": [ + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/LovValue" + } + ], + "properties": { + "type": { + "type": "string" + } + }, + "additionalProperties": false, + "description": "Represents an operator on a Trisoft.InfoShare.WebApi.V30.Models.Forms.FormField.", + "discriminator": { + "propertyName": "type", + "mapping": { + "FullTextSearchFormFieldOperator": "#/components/schemas/FullTextSearchFormFieldOperator", + "MetadataFilterFormFieldOperator": "#/components/schemas/MetadataFilterFormFieldOperator" + } + } + }, + "FreezeBaselineParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the baseline." + } + }, + "additionalProperties": false, + "description": "The request object to freeze baseline that match the criteria given in the properties." + }, + "FullTextSearchFormFieldOperator": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/FormFieldOperator" + } + ], + "properties": { + "operator": { + "allOf": [ + { + "$ref": "#/components/schemas/FullTextSearchOperator" + } + ], + "description": "Search operator that will be used in search operations.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents a full text search operator on a Trisoft.InfoShare.WebApi.V30.Models.Forms.FormField." + }, + "FullTextSearchOperator": { + "enum": [ + "equal", + "notEqual", + "lessThan", + "greaterThan", + "lessThanOrEqual", + "greaterThanOrEqual", + "contains" + ], + "type": "string", + "description": "Enumeration holding search operator options." + }, + "GetAnnotationByAnnotationIdParameters": { + "required": [ + "annotationId" + ], + "type": "object", + "properties": { + "annotationId": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the annotation." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "field": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z|])[a-zA-Z|0-9.-]*$", + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "The request object to get an annotation from the repository that match the criteria given in the properties." + }, + "GetAnnotationByReplyCardIdParameters": { + "required": [ + "replyCardId" + ], + "type": "object", + "properties": { + "replyCardId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "Reply card identifier.", + "format": "int64" + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "field": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z|])[a-zA-Z|0-9.-]*$", + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "The request object to get an annotation by reply card identifier from the repository that match the criteria given in the properties." + }, + "GetAnnotationList": { + "type": "object", + "properties": { + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field." + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "Specifies one or more metadata fields to return." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request object to get all annotations in the repository that match the criteria given in the properties." + }, + "GetAnnotationListByAnnotationId": { + "type": "object", + "properties": { + "annotationIds": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string" + }, + "description": "List of annotation identifiers." + }, + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field." + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "Specifies one or more metadata fields to return." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + }, + "GetBackgroundTaskContentParameters": { + "required": [ + "dataRef" + ], + "type": "object", + "properties": { + "dataRef": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "Identifier of the background task content.", + "format": "int64" + } + }, + "additionalProperties": false, + "description": "Request object to get the background task content in the repository that match the criteria given in the properties." + }, + "GetBackgroundTaskList": { + "type": "object", + "properties": { + "modifiedSince": { + "type": "string", + "description": "A System.DateTime limiting the background task that will be retrieved based on the last modification date of the background task.", + "format": "date-time", + "nullable": true + }, + "userFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/UserFilter" + } + ], + "description": "One of the enumeration values limiting the background task that will be retrieved based on the user associated with the background task." + }, + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field." + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "Specify one or more metadata fields to return." + } + }, + "additionalProperties": false, + "description": "Request object to get all background tasks in the repository that match the criteria given in the properties." + }, + "GetBackgroundTaskParameters": { + "required": [ + "taskId" + ], + "type": "object", + "properties": { + "taskId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "Identifier of the background task.", + "format": "int64" + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "field": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + } + }, + "additionalProperties": false, + "description": "Request parameters to get the metadata of the background task by its identifier." + }, + "GetBaselineEntriesParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the baseline." + } + }, + "additionalProperties": false, + "description": "The request object to get baseline entries that match the criteria given in the properties." + }, + "GetBaselineList": { + "type": "object", + "properties": { + "ids": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string" + }, + "description": "List with baselineIds which can be used to limit the result to baselines within this list that match the other filters.\r\nIf not supplied, all the baselines will be returned." + }, + "activityFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/ActivityFilter" + } + ], + "description": "Filter of activity that limits the baselines to only the active or inactive ones. If not supplied, all the baselines will be returned.", + "default": "none" + }, + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request object to get all baselines in the repository that match the criteria given in the properties." + }, + "GetBaselineParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the baseline." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "field": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z|])[a-zA-Z|0-9.-]*$", + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request object to get baseline in the repository that match the criteria given in the properties." + }, + "GetDocumentObjectByLanguageCardIdParameters": { + "required": [ + "languageCardId" + ], + "type": "object", + "properties": { + "languageCardId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "field": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z|])[a-zA-Z|0-9.-]*$", + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request parameters to get the metadata of the document object by the language card identifier." + }, + "GetDocumentObjectByLogicalIdParameters": { + "required": [ + "logicalId" + ], + "type": "object", + "properties": { + "logicalId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The logical identifier of the document object." + }, + "version": { + "type": "string", + "description": "The version of the document object.", + "nullable": true + }, + "language": { + "maxLength": 255, + "type": "string", + "description": "The language of the document object.", + "nullable": true + }, + "resolution": { + "maxLength": 255, + "type": "string", + "description": "The resolution of the document object.", + "nullable": true + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "field": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z|])[a-zA-Z|0-9.-]*$", + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request parameters to get the metadata of the document object specified by the logical identifier, version and language." + }, + "GetDocumentObjectContentByLanguageCardIdParameters": { + "required": [ + "languageCardId" + ], + "type": "object", + "properties": { + "languageCardId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" + } + }, + "additionalProperties": false, + "description": "Request parameters to get the content of the document object specified by the language card identifier." + }, + "GetDocumentObjectContentByLogicalIdParameters": { + "required": [ + "logicalId" + ], + "type": "object", + "properties": { + "logicalId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The logical identifier of the document object." + }, + "version": { + "type": "string", + "description": "The version of the document object.", + "nullable": true + }, + "language": { + "maxLength": 255, + "type": "string", + "description": "The language of the document object.", + "nullable": true + }, + "resolution": { + "maxLength": 255, + "type": "string", + "description": "The resolution of the document object.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Request parameters to get the content of the document object specified by the logical identifier, version and language." + }, + "GetDocumentObjectContentInfoByLanguageCardIdParameters": { + "required": [ + "languageCardId" + ], + "type": "object", + "properties": { + "languageCardId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" + } + }, + "additionalProperties": false, + "description": "Request parameters to get the content info of the document object specified by the language card identifier." + }, + "GetDocumentObjectList": { + "type": "object", + "properties": { + "objectTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObjectTypeFilter" + }, + "description": "Type of the document. If not supplied, all the type of documents will be returned.", + "default": [ + "any" + ] + }, + "statusFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/StatusFilter" + } + ], + "description": "Filtering on a type of status using status settings.", + "default": "all" + }, + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + }, + "GetDocumentObjectListByLanguageCardId": { + "required": [ + "languageCardIds" + ], + "type": "object", + "properties": { + "objectTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObjectTypeFilter" + }, + "description": "Type of the document. If not supplied, all the type of documents will be returned.", + "default": [ + "any" + ] + }, + "languageCardIds": { + "minItems": 1, + "type": "array", + "items": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "format": "int64" + }, + "description": "Language card identifiers of the objects." + }, + "statusFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/StatusFilter" + } + ], + "description": "Filtering on a type of status using status settings.", + "default": "all" + }, + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + }, + "GetDocumentObjectListByLogicalId": { + "required": [ + "logicalIds" + ], + "type": "object", + "properties": { + "objectTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObjectTypeFilter" + }, + "description": "Type of the document. If not supplied, all the type of documents will be returned.", + "default": [ + "any" + ] + }, + "logicalIds": { + "minItems": 1, + "type": "array", + "items": { + "maxLength": 2048, + "pattern": "^[a-zA-Z0-9+!:|&=\\\\/#@%?~._-]+$", + "type": "string" + }, + "description": "Logical ids of the objects." + }, + "statusFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/StatusFilter" + } + ], + "description": "Filtering on a type of status using status settings.", + "default": "all" + }, + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + }, + "includePartialItems": { + "type": "boolean", + "description": "true to include partial items when the version or language is missing; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + }, + "GetDocumentObjectListUsingConditionName": { + "type": "object", + "properties": { + "objectTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObjectTypeFilter" + }, + "description": "Type of the document. If not supplied, all the type of documents will be returned.", + "default": [ + "any" + ] + }, + "statusFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/StatusFilter" + } + ], + "description": "Filtering on a type of status using status settings.", + "default": "all" + }, + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field." + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "A collection of requested metadata fields." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request object to get all document objects in the repository where the condition name is used." + }, + "GetDocumentObjectListUsingConditionNameParameters": { + "required": [ + "conditionName" + ], + "type": "object", + "properties": { + "conditionName": { + "maxLength": 1333, + "minLength": 1, + "pattern": "^[^<>=!(),:\\ ]+$", + "type": "string", + "description": "The name of the condition." + } + }, + "additionalProperties": false, + "description": "Request parameters to get all document objects in the Repository where the condition name is used." + }, + "GetDocumentObjectListUsingConditionValue": { + "type": "object", + "properties": { + "objectTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObjectTypeFilter" + }, + "description": "Type of the document. If not supplied, all the type of documents will be returned.", + "default": [ + "any" + ] + }, + "statusFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/StatusFilter" + } + ], + "description": "Filtering on a type of status using status settings.", + "default": "all" + }, + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field." + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "A collection of requested metadata fields." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request object to get all document objects in the repository where the condition name and value are used." + }, + "GetDocumentObjectListUsingConditionValueParameters": { + "required": [ + "conditionName", + "conditionValue" + ], + "type": "object", + "properties": { + "conditionName": { + "maxLength": 1333, + "minLength": 1, + "pattern": "^[^<>=!(),:\\ ]+$", + "type": "string", + "description": "The name of the condition." + }, + "conditionValue": { + "maxLength": 1333, + "minLength": 1, + "pattern": "^[^,:]+$", + "type": "string", + "description": "The value of the condition." + } + }, + "additionalProperties": false, + "description": "Request parameters to get all document objects in the Repository where the condition name and value are used." + }, + "GetDocumentObjectListUsingDocumentObject": { + "type": "object", + "properties": { + "linkType": { + "allOf": [ + { + "$ref": "#/components/schemas/LinkType" + } + ], + "description": "The type of the link.", + "default": "all" + }, + "objectTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObjectTypeFilter" + }, + "description": "Type of the document. If not supplied, all the type of documents will be returned.", + "default": [ + "any" + ] + }, + "statusFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/StatusFilter" + } + ], + "description": "Filtering on a type of status using status settings.", + "default": "all" + }, + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field." + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "A collection of requested metadata fields." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request object to get all objects in the repository that are referencing the given logical id." + }, + "GetDocumentObjectListUsingDocumentObjectParameters": { + "required": [ + "logicalId" + ], + "type": "object", + "properties": { + "logicalId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The logical identifier of the referenced document object." + } + }, + "additionalProperties": false, + "description": "Request parameters to get all document objects in the Repository that are referencing a document object specified by the logical identifier." + }, + "GetDocumentObjectListUsingVariable": { + "type": "object", + "properties": { + "objectTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObjectTypeFilter" + }, + "description": "Type of the document. If not supplied, all the type of documents will be returned.", + "default": [ + "any" + ] + }, + "statusFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/StatusFilter" + } + ], + "description": "Filtering on a type of status using status settings.", + "default": "all" + }, + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field." + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "A collection of requested metadata fields." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request object to get all document objects in the repository where the variable is used." + }, + "GetDocumentObjectListUsingVariableParameters": { + "required": [ + "variable" + ], + "type": "object", + "properties": { + "variable": { + "maxLength": 1333, + "minLength": 1, + "type": "string", + "description": "The identifier of the variable." + } + }, + "additionalProperties": false, + "description": "Request parameters to get all document objects in the Repository where the variable is used." + }, + "GetDocumentObjectLocationParameters": { + "required": [ + "logicalId" + ], + "type": "object", + "properties": { + "logicalId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The logical identifier of the document object." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "field": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z|])[a-zA-Z|0-9.-]*$", + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request parameters to get the location of the document object specified by the logical identifier in the folder structure." + }, + "GetDocumentObjectPossibleTargetStatusesByLanguageCardIdParameters": { + "required": [ + "languageCardId" + ], + "type": "object", + "properties": { + "languageCardId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" + }, + "activityFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/ActivityFilter" + } + ], + "description": "Filter of activity that limits the possible target statuses to only the active or inactive ones. If not supplied, only the active ones will be returned.", + "default": "active" + } + }, + "additionalProperties": false, + "description": "Request parameters to get the possible target statuses for the document object specified by the language card identifier." + }, + "GetDocumentObjectReferencesParameters": { + "required": [ + "languageCardId" + ], + "type": "object", + "properties": { + "languageCardId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" + }, + "linkType": { + "allOf": [ + { + "$ref": "#/components/schemas/LinkType" + } + ], + "description": "The enumeration indicating which link fields must be used.", + "default": "all" + } + }, + "additionalProperties": false, + "description": "Request parameters to retrieve the logical identifiers of all document objects referenced by the document object specified by the language card identifier." + }, + "GetDocumentObjectSmartTagsByLanguageCardId": { + "type": "object", + "properties": { + "fieldTags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldTag" + }, + "description": "Specifies one or more metadata fields to with their current tag values." + } + }, + "additionalProperties": false, + "description": "Request parameters to get smart tags of an object." + }, + "GetDocumentObjectSmartTagsByLanguageCardIdParameters": { + "required": [ + "languageCardId" + ], + "type": "object", + "properties": { + "languageCardId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" + } + }, + "additionalProperties": false, + "description": "Request parameters to retrieve smart tags for the document object specified by the language card identifier." + }, + "GetDocumentObjectsByLogicalIdVersionAndLanguageFilter": { + "required": [ + "logicalIds", + "version" + ], + "type": "object", + "properties": { + "objectTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObjectTypeFilter" + }, + "description": "Type of the document. If not supplied, all the type of documents will be returned.", + "default": [ + "any" + ] + }, + "logicalIds": { + "minItems": 1, + "type": "array", + "items": { + "maxLength": 2048, + "pattern": "^[a-zA-Z0-9+!:|&=\\\\/#@%?~._-]+$", + "type": "string" + }, + "description": "Logical ids of the objects." + }, + "version": { + "minLength": 1, + "type": "string", + "description": "The version of the document object." + }, + "languages": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The language of the document object." + }, + "resolutions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The resolution of the document object." + }, + "statusFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/StatusFilter" + } + ], + "description": "Filtering on a type of status using status settings.", + "default": "all" + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request parameters to retrieve document objects by combination of logical identifier, version and language." + }, + "GetDocumentObjectsByLogicalIdVersionFilter": { + "required": [ + "logicalIds", + "version" + ], + "type": "object", + "properties": { + "objectTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObjectTypeFilter" + }, + "description": "Type of the document. If not supplied, all the type of documents will be returned.", + "default": [ + "any" + ] + }, + "logicalIds": { + "minItems": 1, + "type": "array", + "items": { + "maxLength": 2048, + "pattern": "^[a-zA-Z0-9+!:|&=\\\\/#@%?~._-]+$", + "type": "string" + }, + "description": "Logical ids of the objects." + }, + "version": { + "minLength": 1, + "type": "string", + "description": "The version of the document object." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request parameters to retrieve document objects by combination of logical identifier and version." + }, + "GetElectronicDocumentTypeList": { + "type": "object", + "properties": { + "ids": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string" + }, + "description": "List with IDs of an electronic document types which can be used to limit the result to EDTs within this list that match the other filters.\r\nIf not supplied, all the electronic document types will be returned." + }, + "activityFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/ActivityFilter" + } + ], + "description": "Filter of activity that limits the electronic document types to only the active or inactive ones. If not supplied, all the EDTs will be returned.", + "default": "none" + }, + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request object to get all electronic document types in the repository that match the criteria given in the properties." + }, + "GetElectronicDocumentTypeParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the electronic document type." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "field": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z|])[a-zA-Z|0-9.-]*$", + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "The request object to get an electronic document type in the repository that match the criteria given in the properties." + }, + "GetEventByProgressIdParameters": { + "required": [ + "progressId" + ], + "type": "object", + "properties": { + "progressId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "Identifier of an event.", + "format": "int64" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "field": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request parameters to get the metadata of the event by the event progress identifier." + }, + "GetEventListByParentProgressId": { + "required": [ + "parentProgressIds" + ], + "type": "object", + "properties": { + "parentProgressIds": { + "minItems": 1, + "type": "array", + "items": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "format": "int64" + }, + "description": "A list of event identifiers." + }, + "levelFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/EventLevel" + } + ], + "description": "The enumeration value that specifies the event level at which to retrieve event actions/details.", + "default": "information" + }, + "lastDetailId": { + "type": "integer", + "description": "Identifier of the last event action/detail that was retrieved during a previous attempt.", + "format": "int64", + "nullable": true + }, + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field." + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "FieldGroup allows to add a group of fields to the requested metadata.", + "default": "none" + }, + "requestedMetadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "The requested metadata." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + }, + "GetEventListByProgressId": { + "required": [ + "progressIds" + ], + "type": "object", + "properties": { + "progressIds": { + "minItems": 1, + "type": "array", + "items": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "format": "int64" + }, + "description": "A list of event identifiers." + }, + "levelFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/EventLevel" + } + ], + "description": "The enumeration value that specifies the event level at which to retrieve event actions/details.", + "default": "information" + }, + "lastDetailId": { + "type": "integer", + "description": "Identifier of the last event action/detail that was retrieved during a previous attempt.", + "format": "int64", + "nullable": true + }, + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field." + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "FieldGroup allows to add a group of fields to the requested metadata.", + "default": "none" + }, + "requestedMetadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "The requested metadata." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + }, + "GetEventOverview": { + "type": "object", + "properties": { + "eventTypes": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", + "type": "string" + }, + "description": "A list of strings containing the event types to retrieve." + }, + "statusFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/ProgressStatusFilter" + } + ], + "description": "The enumeration value limiting the events that will be retrieved based on the status of the events.", + "default": "busy" + }, + "modifiedSince": { + "type": "string", + "description": "A System.DateTime limiting the events that will be retrieved based on the last modification date of the events.", + "format": "date-time", + "nullable": true + }, + "userFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/UserFilter" + } + ], + "description": "The enumeration value limiting the events that will be retrieved based on the user associated with the events.", + "default": "all" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "FieldGroup allows to add a group of fields to the requested metadata.", + "default": "none" + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + }, + "requestedMetadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "The requested metadata." + } + }, + "additionalProperties": false, + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + }, + "GetEventOverviewByProgressId": { + "required": [ + "progressIds" + ], + "type": "object", + "properties": { + "progressIds": { + "minItems": 1, + "type": "array", + "items": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "format": "int64" + }, + "description": "A list of event identifiers." + }, + "statusFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/ProgressStatusFilter" + } + ], + "description": "The enumeration value limiting the events that will be retrieved based on the status of the events.", + "default": "busy" + }, + "modifiedSince": { + "type": "string", + "description": "A System.DateTime limiting the events that will be retrieved based on the last modification date of the events.", + "format": "date-time", + "nullable": true + }, + "userFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/UserFilter" + } + ], + "description": "The enumeration value limiting the events that will be retrieved based on the user associated with the events.", + "default": "all" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "FieldGroup allows to add a group of fields to the requested metadata.", + "default": "none" + }, + "requestedMetadata": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "The requested metadata." + } + }, + "additionalProperties": false, + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + }, + "GetEventProgressByDetailIdParameters": { + "required": [ + "detailId" + ], + "type": "object", + "properties": { + "detailId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The unique identifier of an event action/detail.", + "format": "int64" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "field": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z|])[a-zA-Z|0-9.-]*$", + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request object to get the event progress in the repository that match the criteria given in the properties." + }, + "GetEventProgressByEventIdParameters": { + "required": [ + "eventId" + ], + "type": "object", + "properties": { + "eventId": { + "maxLength": 255, + "minLength": 1, + "type": "string", + "description": "The unique identifier of an event." + } + }, + "additionalProperties": false, + "description": "Request object to get the event progress in the repository that match the criteria given in the properties." + }, + "GetEventProgressContentByDetailIdParameters": { + "required": [ + "detailId" + ], + "type": "object", + "properties": { + "detailId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The unique identifier of an event action/detail.", + "format": "int64" + } + }, + "additionalProperties": false, + "description": "Request object to get the event progress content in the repository that match the criteria given in the properties." + }, + "GetFolderByFolderPathParameters": { + "required": [ + "path" + ], + "type": "object", + "properties": { + "path": { + "minLength": 1, + "type": "string", + "description": "The path of the folder." + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z|])[a-zA-Z|0-9.-]*$", + "type": "string" + }, + "description": "A collection of requested metadata fields." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + }, + "GetFolderList": { + "required": [ + "ids" + ], + "type": "object", + "properties": { + "ids": { + "minItems": 1, + "type": "array", + "items": { + "type": "string" + }, + "description": "List with folderIds which can be used to limit the result to folders within this list that match the other filters." + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "Specifies one or more metadata fields to return.", + "nullable": true + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request folder to get all folders in the repository that match the criteria given in the properties." + }, + "GetInboxObjectList": { + "type": "object", + "properties": { + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "Specifies one or more metadata fields to return.", + "nullable": true + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Represents an Inbox object list." + }, + "GetLovList": { + "type": "object", + "properties": { + "ids": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The identifiers of list of values", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents a get Lov list model." + }, + "GetMetadataBindingSmartTags": { + "required": [ + "contentLanguage" + ], + "type": "object", + "properties": { + "fieldTags": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldTag" + }, + "description": "Specifies one or more metadata fields to with their current tag values." + }, + "contentLanguage": { + "minLength": 1, + "type": "string", + "description": "Specifies the language of the content." + } + }, + "additionalProperties": false, + "description": "Request parameters to get smart tags of given content." + }, + "GetMetadataBindingTagList": { + "type": "object", + "properties": { + "inputFilter": { + "type": "string", + "description": "String used to filter the possible tags.", + "nullable": true + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Specify some fields of the object which might impact the possible tags.\r\nFor instance FTESTCOUNTRIES with value \"Netherlands\" will limit the result to \"Amsterdam\"", + "nullable": true + }, + "maxTagsToReturn": { + "minimum": 0, + "exclusiveMinimum": true, + "type": "integer", + "description": "Maximum number of tags that should be returned.", + "format": "int64", + "default": 20 + } + }, + "additionalProperties": false, + "description": "Request object to get metadata bound tags that match the criteria given in the properties." + }, + "GetMetadataBindingTagStructure": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Specify some fields of the object which might impact the possible tags structure.\r\nFor instance FTESTCOUNTRIES with value \"Netherlands\" will limit the result to \"Amsterdam\"", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Request object to get metadata bound tags structure that match the criteria given in the properties." + }, + "GetMyPreferencesParameters": { + "required": [ + "setName" + ], + "type": "object", + "properties": { + "setName": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", + "type": "string", + "description": "The name of the preference set to be retrieved, if the set name can not be found empty preference set is returned." + } + }, + "additionalProperties": false, + "description": "The request object to get current user preferences that match the criteria given in the properties." + }, + "GetMyUserParameters": { + "type": "object", + "properties": { + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "field": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z|])[a-zA-Z|0-9.-]*$", + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false." + } + }, + "additionalProperties": false, + "description": "The request object to get a current user in the repository that match the criteria given in the properties." + }, + "GetOutputFormatList": { + "type": "object", + "properties": { + "ids": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string" + }, + "description": "List with outputFormatIds which can be used to limit the result to output formats within this list that match the other filters.\r\nIf not supplied, all the output formats will be returned." + }, + "activityFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/ActivityFilter" + } + ], + "description": "Filter of activity that limits the output formats to only the active or inactive ones. If not supplied, all the output formats will be returned.", + "default": "none" + }, + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request object to get all output formats in the repository that match the criteria given in the properties." + }, + "GetOutputFormatParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the output format." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "field": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z|])[a-zA-Z|0-9.-]*$", + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, "additionalProperties": false, - "description": "Represents an item.", - "discriminator": { - "propertyName": "type", - "mapping": { - "User": "#/components/schemas/User", - "UserGroup": "#/components/schemas/UserGroup", - "TranslationObject": "#/components/schemas/TranslationObject", - "Setting": "#/components/schemas/Setting", - "SearchObject": "#/components/schemas/SearchObject", - "Publication": "#/components/schemas/Publication", - "BaseObject": "#/components/schemas/BaseObject", - "LovList": "#/components/schemas/LovList", - "LovValue": "#/components/schemas/LovValue", - "OutputFormat": "#/components/schemas/OutputFormat", - "RevisionInfo": "#/components/schemas/RevisionInfo", - "Tag": "#/components/schemas/Tag", - "FormFieldOperator": "#/components/schemas/FormFieldOperator", - "FullTextSearchFormFieldOperator": "#/components/schemas/FullTextSearchFormFieldOperator", - "MetadataFilterFormFieldOperator": "#/components/schemas/MetadataFilterFormFieldOperator", - "Folder": "#/components/schemas/Folder", - "ElectronicDocumentType": "#/components/schemas/ElectronicDocumentType", - "DocumentObject": "#/components/schemas/DocumentObject", - "RevisionHistoryItem": "#/components/schemas/RevisionHistoryItem", - "Baseline": "#/components/schemas/Baseline" + "description": "Request object to get output format in the repository that match the criteria given in the properties." + }, + "GetPreferencesParameters": { + "required": [ + "id", + "setName" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the user." + }, + "setName": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", + "type": "string", + "description": "The name of the preference set to be retrieved, if the set name can not be found empty preference set is returned." + } + }, + "additionalProperties": false, + "description": "The request object to get user preferences that match the criteria given in the properties." + }, + "GetProjectByAssigneeCardIdParameters": { + "required": [ + "assigneeCardId" + ], + "type": "object", + "properties": { + "assigneeCardId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The card identifier of the assignee.", + "format": "int64" + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "field": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z|])[a-zA-Z|0-9.-]*$", + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request parameters to get the metadata of the project by the assignee card identifier." + }, + "GetProjectByProjectIdParameters": { + "required": [ + "projectId" + ], + "type": "object", + "properties": { + "projectId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of a project." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "field": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z|])[a-zA-Z|0-9.-]*$", + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request parameters to get the metadata of the project by the project identifier." + }, + "GetProjectList": { + "type": "object", + "properties": { + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field.", + "nullable": true + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "Specify one or more metadata fields to return.", + "nullable": true + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Represents a get project list model." + }, + "GetProjectListByProjectId": { + "required": [ + "projectIds" + ], + "type": "object", + "properties": { + "projectIds": { + "minItems": 1, + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string" + }, + "description": "Logical ids of the projects." + }, + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field.", + "nullable": true + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "Specify one or more metadata fields to return.", + "nullable": true + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request object to get all objects in the repository that match the criteria given in the properties." + }, + "GetPublicationList": { + "type": "object", + "properties": { + "statusFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/StatusFilter" + } + ], + "description": "Filtering on a type of status using status settings.", + "default": "all" + }, + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field.", + "nullable": true + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "Specifies one or more metadata fields to return.", + "nullable": true + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false } - } + }, + "additionalProperties": false, + "description": "Request object to get all objects in the repository that match the criteria given in the properties." }, - "Baseline": { + "GetPublicationListByLanguageCardId": { + "required": [ + "languageCardIds" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "properties": { + "languageCardIds": { + "minItems": 1, + "type": "array", + "items": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "format": "int64" + }, + "description": "Logical ids of the objects." + }, + "statusFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/StatusFilter" + } + ], + "description": "Filtering on a type of status using status settings.", + "default": "all" + }, + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field.", + "nullable": true + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "Specifies one or more metadata fields to return.", + "nullable": true + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false } - ], + }, "additionalProperties": false, - "description": "Represents a baseline." - }, - "BaselineAutoCompleteMode": { - "enum": [ - "none", - "firstVersion", - "latestReleased", - "latestAvailable" - ], - "type": "string" + "description": "Request object to get all publications in the repository that match the criteria given in the properties." }, - "BaselineEntry": { + "GetPublicationListByLogicalId": { "required": [ - "type" + "logicalIds" ], "type": "object", "properties": { - "type": { - "type": "string" - }, - "id": { - "type": "string", - "description": "The unique element name of the card on the logical level" + "logicalIds": { + "minItems": 1, + "type": "array", + "items": { + "type": "string" + }, + "description": "Logical ids of the objects." }, - "source": { - "type": "string", - "description": "Who or what is responsible for the current version number of the object in the baseline." + "statusFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/StatusFilter" + } + ], + "description": "Filtering on a type of status using status settings.", + "default": "all" }, - "version": { - "type": "string", - "description": "The version number of the version card.", + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field.", "nullable": true }, - "author": { + "selectedProperties": { "allOf": [ { - "$ref": "#/components/schemas/User" + "$ref": "#/components/schemas/SelectedProperties" } ], - "description": "The Author of the object.", - "nullable": true + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" }, - "creationDate": { - "type": "string", - "description": "The creation date of the object.", - "format": "date-time", - "nullable": true + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" }, - "modificationDate": { - "type": "string", - "description": "The last modification date of the object.", - "format": "date-time", + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "Specifies one or more metadata fields to return.", "nullable": true + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + }, + "includePartialItems": { + "type": "boolean", + "description": "true to include the partial items; otherwise, false. Default is false.", + "default": false } }, "additionalProperties": false, - "description": "Represents a baseline entry.", - "discriminator": { - "propertyName": "type", - "mapping": { - "BaselineEntry": "#/components/schemas/BaselineEntry", - "BaselineReportEntry": "#/components/schemas/BaselineReportEntry" - } - } + "description": "Request object to get all publications in the repository that match the criteria given in the properties." }, - "BaselineReportEntry": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaselineEntry" - } + "GetPublicationListByLogicalIdByVersionFilter": { + "required": [ + "logicalIds", + "version" ], + "type": "object", "properties": { - "versionCardId": { - "type": "integer", - "description": "The version of the baseline report entry.", - "format": "int64", - "nullable": true + "version": { + "minLength": 1, + "type": "string", + "description": "The version of the document object." }, - "documentObjectType": { + "selectedProperties": { "allOf": [ { - "$ref": "#/components/schemas/DocumentObjectType" + "$ref": "#/components/schemas/SelectedProperties" } ], - "description": "The document type of the baseline report entry." + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" }, - "items": { + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { "type": "array", "items": { - "$ref": "#/components/schemas/BaselineReportItem" + "$ref": "#/components/schemas/RequestedField" + }, + "description": "Specifies one or more metadata fields to return.", + "nullable": true + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + }, + "logicalIds": { + "minItems": 1, + "type": "array", + "items": { + "maxLength": 2048, + "pattern": "^[a-zA-Z0-9+!:|&=\\\\/#@%?~._-]+$", + "type": "string" }, - "description": "The items of the baseline report entry.", - "nullable": true + "description": "Logical ids of the objects." + }, + "includePartialItems": { + "type": "boolean", + "description": "true to include the partial items; otherwise, false. Default is false.", + "default": false } }, "additionalProperties": false, - "description": "Represents a baseline report entry." + "description": "Request object to get all publications in the repository that match the criteria given in the properties." }, - "BaselineReportItem": { + "GetPublicationListUsingBaselineParameters": { + "required": [ + "id" + ], "type": "object", "properties": { - "reportLanguage": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the baseline." + } + }, + "additionalProperties": false, + "description": "The request object to get publication list using baseline that match the criteria given in the properties." + }, + "GetPublicationListUsingDocumentObject": { + "type": "object", + "properties": { + "fieldGroup": { "allOf": [ { - "$ref": "#/components/schemas/LovValue" + "$ref": "#/components/schemas/FieldGroup" } ], - "description": "The reporting language of the baseline" + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" }, - "reportResolution": { - "allOf": [ - { - "$ref": "#/components/schemas/LovValue" - } - ], - "description": "The resolution of the illustration. For non-illustration object, the resolution is an empty string." + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RequestedField" + }, + "description": "A collection of requested metadata fields." }, - "reportResult": { + "selectedProperties": { "allOf": [ { - "$ref": "#/components/schemas/BaselineReportResult" + "$ref": "#/components/schemas/SelectedProperties" } ], - "description": "The result of the report." - }, - "languageCardId": { - "type": "integer", - "description": "The language card id of the baseline report item.", - "format": "int64", - "nullable": true + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" }, - "sourceLanguage": { - "allOf": [ - { - "$ref": "#/components/schemas/LovValue" - } - ], - "description": "Source language of the baseline report item.", - "nullable": true + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request body to get all publications in the Repository that are referencing a document object specified by the logical identifier and version." + }, + "GetPublicationListUsingDocumentObjectParameters": { + "required": [ + "logicalId", + "version" + ], + "type": "object", + "properties": { + "logicalId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The logical identifier of the referenced document object." }, - "languages": { + "version": { + "minLength": 1, + "type": "string", + "description": "The version of the referenced document object." + } + }, + "additionalProperties": false, + "description": "Request parameters to get all publications in the Repository that are referencing a document object specified by the logical identifier and version." + }, + "GetSettingsParameters": { + "type": "object", + "properties": { + "field": { "type": "array", "items": { - "$ref": "#/components/schemas/LovValue" + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z|])[a-zA-Z|0-9.-]*$", + "type": "string" }, - "description": "The list of languages of the baseline report item.\r\n\r\n For Topics, this property would contain a single language.\r\n For Illustrations, it may contain multiple languages.\r\n", - "nullable": true + "description": "Specifies one or more metadata fields to return." }, - "status": { + "selectedProperties": { "allOf": [ { - "$ref": "#/components/schemas/LovValue" + "$ref": "#/components/schemas/SelectedProperties" } ], - "description": "The status of the baseline report item.", - "nullable": true - }, - "links": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The links of the baseline report item.", - "nullable": true + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" }, - "imageLinks": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The image links of the baseline report item.", - "nullable": true + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" } }, "additionalProperties": false, - "description": "Represents a baseline report item." - }, - "BaselineReportResult": { - "enum": [ - "ok", - "languageVersionMissing", - "notInUse", - "notReleased", - "noValidVersionFound", - "objectMissing", - "objectMissingInBaseline", - "versionMissing" - ], - "type": "string", - "description": "Enumeration holding the possible values for the baseline report result." + "description": "Request object to get settings in the repository that match the criteria given in the properties." }, - "BaseObject": { - "required": [ - "type" - ], + "GetTranslationJobList": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseItem" - } - ], "properties": { - "type": { - "type": "string" - }, - "fields": { + "ids": { "type": "array", "items": { - "$ref": "#/components/schemas/FieldValue" + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string" }, - "description": "The list of field values.", - "nullable": true + "description": "List of translation job ids." }, - "links": { + "filterFields": { "type": "array", "items": { - "$ref": "#/components/schemas/Link" + "$ref": "#/components/schemas/FilterFieldValue" }, - "description": "A list of actions or links that are allowed on the object.", - "nullable": true + "description": "The filter fields that contain information to access a field, and the value associated with the field." }, - "messages": { + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { "type": "array", "items": { - "$ref": "#/components/schemas/Message" + "$ref": "#/components/schemas/RequestedField" }, - "description": "A list of messages related to the object. The messages can contain warnings and errors.", - "nullable": true + "description": "Specify one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false } }, "additionalProperties": false, - "description": "Base definition for objects.", - "discriminator": { - "propertyName": "type", - "mapping": { - "User": "#/components/schemas/User", - "UserGroup": "#/components/schemas/UserGroup", - "TranslationObject": "#/components/schemas/TranslationObject", - "Setting": "#/components/schemas/Setting", - "SearchObject": "#/components/schemas/SearchObject", - "Publication": "#/components/schemas/Publication", - "OutputFormat": "#/components/schemas/OutputFormat", - "RevisionInfo": "#/components/schemas/RevisionInfo", - "Folder": "#/components/schemas/Folder", - "ElectronicDocumentType": "#/components/schemas/ElectronicDocumentType", - "DocumentObject": "#/components/schemas/DocumentObject", - "RevisionHistoryItem": "#/components/schemas/RevisionHistoryItem", - "Baseline": "#/components/schemas/Baseline" - } - } + "description": "Request object to get all translation jobs in the repository that match the criteria given in the properties." }, - "BaseSearchSortField": { + "GetTranslationJobParameters": { "required": [ - "type" + "id" ], "type": "object", "properties": { - "type": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", "type": "string", - "readOnly": true + "description": "Identifier of the translation job." }, - "sortOrder": { + "selectedProperties": { "allOf": [ { - "$ref": "#/components/schemas/SearchSortOrder" + "$ref": "#/components/schemas/SelectedProperties" } ], - "description": "The sort order type." - } - }, - "additionalProperties": false, - "description": "Represents Base Search Sort Fields", - "discriminator": { - "propertyName": "type", - "mapping": { - "ScoreSearchSortField": "#/components/schemas/ScoreSearchSortField", - "SearchSortField": "#/components/schemas/SearchSortField" - } - } - }, - "CancelPublicationPublish": { - "type": "object", - "properties": { - "requiredCurrentFields": { + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "field": { "type": "array", "items": { - "$ref": "#/components/schemas/SetFieldValue" + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z|])[a-zA-Z|0-9.-]*$", + "type": "string" }, - "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to update the Trisoft.InfoShare.WebApi.V30.Publications.Models.Publication", - "nullable": true + "description": "Specify one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false.", + "default": false + }, + "includeWorkflow": { + "type": "boolean", + "description": "true to include the list of workflows; otherwise, false.", + "default": false } }, "additionalProperties": false, - "description": "Represents an update model for CancelPublicationPublish." + "description": "Request object to get the translation job in the repository that match the criteria given in the properties." }, - "CardFieldValue": { + "GetTranslationJobSourceObjectList": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/FieldValue" - } - ], "properties": { - "value": { + "selectedProperties": { "allOf": [ { - "$ref": "#/components/schemas/BaseObject" + "$ref": "#/components/schemas/SelectedProperties" } ], - "description": "Base definition for objects.", - "nullable": true - } - }, - "additionalProperties": false - }, - "CardFilterFieldValue": { - "required": [ - "value" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/FilterFieldValue" - } - ], - "properties": { - "value": { - "minItems": 1, + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { "type": "array", "items": { - "$ref": "#/components/schemas/SetBaseObject" - } + "$ref": "#/components/schemas/RequestedField" + }, + "description": "Specify one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Request object to get all source objects of a translation job in the repository that match the criteria given in the properties." }, - "CardLikeFilterFieldValue": { + "GetTranslationJobSourceObjectListParameters": { "required": [ - "value" + "id" ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/FilterFieldValue" - } - ], "properties": { - "value": { + "id": { + "maxLength": 255, "minLength": 1, - "type": "string" + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the translation job." } }, - "additionalProperties": false + "additionalProperties": false, + "description": "The request object to get the source objects of a translation job by its identifier." }, - "CheckInDocumentObject": { + "GetTranslationJobTargetObjectListParameters": { + "required": [ + "id" + ], "type": "object", "properties": { - "fields": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the translation job." + }, + "languageFilter": { "type": "array", "items": { - "$ref": "#/components/schemas/SetFieldValue" + "type": "string" }, - "description": "The list of field values to be changed.", - "nullable": true + "description": "Specify the language filter for which to return the target objects." }, - "requiredCurrentFields": { + "objectTypes": { "type": "array", "items": { - "$ref": "#/components/schemas/SetFieldValue" + "$ref": "#/components/schemas/DocumentObjectTypeFilter" }, - "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to update the Trisoft.InfoShare.WebApi.V30.DocumentObjects.Models.DocumentObject", - "nullable": true + "description": "Specify the object types for which to filter the returned objects.", + "default": [ + "any" + ] } }, "additionalProperties": false, - "description": "Request object to check in object content in the repository that match the criteria given in the properties." + "description": "Request object to get the target objects in the translation object that match the criteria given in the properties." }, - "CheckOutDocumentObject": { + "GetTranslationStatusListParameters": { + "required": [ + "documentObjectType" + ], "type": "object", "properties": { - "requiredCurrentFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SetFieldValue" - }, - "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to check out the Trisoft.InfoShare.WebApi.V30.DocumentObjects.Models.DocumentObject", - "nullable": true + "documentObjectType": { + "allOf": [ + { + "$ref": "#/components/schemas/DocumentObjectType" + } + ], + "description": "The document object type to retrieve translation statuses for.\r\nUndefined is not supported for this parameter.\r\n" } }, "additionalProperties": false, - "description": "Represents model to check out a document" + "description": "Request object to get all objects in the repository that match the criteria given in the properties." }, - "CompleteBaseline": { + "GetUserGroupList": { "type": "object", "properties": { - "extendId": { - "type": "string", - "description": "Specify the element name of the Baseline that will be used to complete the Baseline.", - "nullable": true + "ids": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string" + }, + "description": "List with userGroupIds which can be used to limit the result to user groups within this list that match the other filters.\r\nIf not supplied, all the user groups will be returned." }, - "autoCompleteMode": { + "activityFilter": { "allOf": [ { - "$ref": "#/components/schemas/BaselineAutoCompleteMode" + "$ref": "#/components/schemas/ActivityFilter" } ], - "description": "Specify the auto complete mode that must be used to select the versions in the Baseline.", - "nullable": true + "description": "Filter of activity that limits the user groups to only the active or inactive ones. If not supplied, all the user groups will be returned.", + "default": "none" }, - "startLogicalIds": { + "filterFields": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/FilterFieldValue" }, - "description": "Specify a list of logical identifiers of the root map or objects in the outline of the root map that will be used as the starting point for the baseline calculation.", - "nullable": true + "description": "The filter fields that contain information to access a field, and the value associated with the field." }, - "startResourceLogicalIds": { + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/RequestedField" }, - "description": "Specify a list of logical identifiers of resources that will be used as the starting point for the Baseline calculation.", - "nullable": true + "description": "Specifies one or more metadata fields to return." }, - "languages": { + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request object to get all user groups in the repository that match the criteria given in the properties." + }, + "GetUserGroupParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the group." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "field": { "type": "array", "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z|])[a-zA-Z|0-9.-]*$", "type": "string" }, - "description": "Specify a list of languages.", - "nullable": true + "description": "Specifies one or more metadata fields to return." }, - "illustrationLanguages": { + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false + } + }, + "additionalProperties": false, + "description": "Request object to get user group in the repository that match the criteria given in the properties." + }, + "GetUserList": { + "type": "object", + "properties": { + "ids": { "type": "array", "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", "type": "string" }, - "description": "Specify a list of fallback languages for illustrations.", - "nullable": true + "description": "List with userIds which can be used to limit the result to users within this list that match the other filters.\r\nIf not supplied, all the users will be returned." }, - "resourceLanguages": { + "activityFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/ActivityFilter" + } + ], + "description": "Filter of activity that limits the users to only the active or inactive ones. If not supplied, all the users will be returned.", + "default": "none" + }, + "filterFields": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/FilterFieldValue" }, - "description": "Specify a list of fallback languages for resources.", - "nullable": true + "description": "The filter fields that contain information to access a field, and the value associated with the field." }, - "resolutions": { + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "fields": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/RequestedField" }, - "description": "Specify a list of resolutions.", - "nullable": true + "description": "Specifies one or more metadata fields to return." }, - "depth": { - "type": "integer", - "description": "Specify how many levels should be returned. If no value is provided all levels will be returned.\r\nNegative Depth means unlimited recursion. Depth 0 means just return the baseline entries for the supplied logical ids.", - "format": "int32", - "default": -1, - "nullable": true + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false } }, "additionalProperties": false, - "description": "The model contains the parameters which will be used to expand and complete the baseline starting from the incoming logicalIds using the extend baseline and/or the autocomplete mode." + "description": "Request object to get all users in the repository that match the criteria given in the properties." }, - "CreateBackgroundTask": { + "GetUserParameters": { "required": [ - "eventType" + "id" ], "type": "object", "properties": { - "eventType": { + "id": { "maxLength": 255, "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", "type": "string", - "description": "Type of event/background task." + "description": "The identifier of the user." }, - "progressId": { - "type": "integer", - "description": "Unique identifier of the event log for this background task. If no progressId is provided, a new event log will be created.", - "format": "int64", - "nullable": true + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" }, - "eventDescription": { - "maxLength": 255, - "type": "string", - "description": "Description of the background task. This will only be used while creating a new event log.", - "nullable": true + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" }, - "hashId": { - "maxLength": 80, - "type": "string", - "description": "The hashId that will be used to skip older background task for the same action. For instance, synchronizing the same language object only once to SDL LiveContent.", - "nullable": true + "field": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z|])[a-zA-Z|0-9.-]*$", + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." }, - "startAfter": { - "type": "string", - "description": "DateTime in UTC indicating that the background task should not be started before the specified time.\r\nIf the background task service is still processing other background tasks, the background task will not start at the specified time but later.", - "format": "date-time", - "nullable": true + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false } }, "additionalProperties": false, - "description": "Represents the information required for creating background task." + "description": "The request object to get a user in the repository that match the criteria given in the properties." }, - "CreateFolder": { + "GetUserRoleList": { "type": "object", "properties": { - "parentId": { - "minimum": -1, - "exclusiveMinimum": true, - "type": "string", - "description": "The identifier of parent folder (e.g. 34567)." + "ids": { + "type": "array", + "items": { + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string" + }, + "description": "List with userRoleIds which can be used to limit the result to user roles within this list that match the other filters.\r\nIf not supplied, all the user roles will be returned." + }, + "activityFilter": { + "allOf": [ + { + "$ref": "#/components/schemas/ActivityFilter" + } + ], + "description": "Filter of activity that limits the user roles to only the active or inactive ones. If not supplied, all the user roles will be returned.", + "default": "none" + }, + "filterFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FilterFieldValue" + }, + "description": "The filter fields that contain information to access a field, and the value associated with the field." + }, + "selectedProperties": { + "allOf": [ + { + "$ref": "#/components/schemas/SelectedProperties" + } + ], + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" + }, + "fieldGroup": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldGroup" + } + ], + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" }, "fields": { "type": "array", "items": { - "$ref": "#/components/schemas/SetFieldValue" + "$ref": "#/components/schemas/RequestedField" }, - "description": "The list of field values." + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false } }, "additionalProperties": false, - "description": "Represents a create folder model." + "description": "Request object to get all user roles in the repository that match the criteria given in the properties." }, - "CreateLovValue": { + "GetUserRoleParameters": { "required": [ - "title" + "id" ], "type": "object", "properties": { "id": { - "type": "string", - "description": "The lov value identifier", - "nullable": true - }, - "title": { + "maxLength": 255, "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", "type": "string", - "description": "The lov value title" + "description": "Identifier of the role." }, - "description": { - "type": "string", - "description": "The lov value description", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Represents a create lov Value model." - }, - "CreateStatusDefinition": { - "type": "object", - "properties": { - "lovValue": { + "selectedProperties": { "allOf": [ { - "$ref": "#/components/schemas/CreateLovValue" + "$ref": "#/components/schemas/SelectedProperties" } ], - "description": "Represents the creation of a Trisoft.InfoShare.WebApi.V30.Workflows.Models.CreateStatusDefinition.LovValue model." + "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", + "default": "id" }, - "statusType": { + "fieldGroup": { "allOf": [ { - "$ref": "#/components/schemas/StatusType" + "$ref": "#/components/schemas/FieldGroup" } ], - "description": "StatusType: Type of the status described in Trisoft.InfoShare.WebApi.V30.Workflows.Models.CreateStatusDefinition.StatusType." - } - }, - "additionalProperties": false, - "description": "Represents a model for create status definition." - }, - "DateTimeFieldValue": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/FieldValue" - } - ], - "properties": { - "value": { - "type": "string", - "format": "date-time", - "nullable": true - } - }, - "additionalProperties": false - }, - "DateTimeFilterFieldValue": { - "required": [ - "value" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/FilterFieldValue" - } - ], - "properties": { - "value": { - "minItems": 1, + "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", + "default": "none" + }, + "field": { "type": "array", "items": { - "type": "string", - "format": "date-time" - } + "maxLength": 255, + "pattern": "^(?=.*[a-zA-Z|])[a-zA-Z|0-9.-]*$", + "type": "string" + }, + "description": "Specifies one or more metadata fields to return." + }, + "includeLinks": { + "type": "boolean", + "description": "true to include the links; otherwise, false. Default is false.", + "default": false } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Request object to get user role in the repository that match the criteria given in the properties." }, - "DateTimeSearchFieldValue": { + "GroupSearchExpression": { "required": [ - "value" + "type" ], "type": "object", "allOf": [ { - "$ref": "#/components/schemas/SearchFieldValue" + "$ref": "#/components/schemas/SearchExpression" } ], "properties": { - "value": { - "minItems": 1, - "type": "array", - "items": { - "type": "string", - "format": "date-time" - }, - "description": "Collection of values to search for." - } - }, - "additionalProperties": false, - "description": "Represents search field value of type System.Collections.Generic.IList`1." - }, - "DeleteDocumentObjectByLanguageCardId": { - "type": "object", - "properties": { - "requiredCurrentFields": { + "type": { + "type": "string" + }, + "expressions": { "type": "array", "items": { - "$ref": "#/components/schemas/SetFieldValue" + "$ref": "#/components/schemas/SearchExpression" }, - "description": "The fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to delete the Trisoft.InfoShare.WebApi.V30.DocumentObjects.Models.DocumentObject", - "nullable": true + "description": "Collection of search expressions." } }, "additionalProperties": false, - "description": "Request object to delete document object." - }, - "DeleteDocumentObjectByLogicalId": { - "type": "object", - "properties": { - "requiredCurrentFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SetFieldValue" - }, - "description": "The fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to delete the Trisoft.InfoShare.WebApi.V30.DocumentObjects.Models.DocumentObject", - "nullable": true + "description": "Represents a search expression group.", + "discriminator": { + "propertyName": "type", + "mapping": { + "AndSearchExpression": "#/components/schemas/AndSearchExpression", + "OrSearchExpression": "#/components/schemas/OrSearchExpression" } - }, - "additionalProperties": false, - "description": "Request object to delete document object." + } }, - "DocumentObject": { + "InContextDocumentObject": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/BaseObject" + "$ref": "#/components/schemas/DocumentObject" } ], "properties": { - "documentObjectType": { - "allOf": [ - { - "$ref": "#/components/schemas/DocumentObjectType" - } - ], - "description": "The document type." - }, - "languageCardId": { - "type": "integer", - "description": "The language card identifier.", - "format": "int64", - "nullable": true - }, - "versionCardId": { - "type": "integer", - "description": "The version card identifier.", - "format": "int64", + "content": { + "type": "string", + "description": "Represents the XML content of the document.", "nullable": true }, - "logicalId": { - "type": "string", - "description": "The logical identifier." + "targetStatuses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LovValue" + }, + "description": "The target statuses of the document.", + "nullable": true }, - "version": { + "revisionId": { "type": "string", - "description": "The version.", + "description": "The unique identifier of the document object revision.", "nullable": true }, - "languageId": { - "type": "string", - "description": "The language identifier.", + "referencedIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of referenced identifiers.", "nullable": true }, - "resolutionId": { - "type": "string", - "description": "The resolution identifier.", + "logicalCardId": { + "type": "integer", + "description": "Gets or sets the logical card identifier of the document object.", + "format": "int64", "nullable": true } }, "additionalProperties": false, - "description": "Represents a document." + "description": "Represents a document in the context of a publication." }, - "DocumentObjectLink": { + "Inbox": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/RelatedInfo" - } - ], "properties": { - "linkType": { - "allOf": [ - { - "$ref": "#/components/schemas/DocumentObjectLinkType" - } - ], - "description": "The type of the link." - }, - "target": { + "name": { "type": "string", - "description": "The reference to the contents that the link targets." + "description": "The name of the inbox definition." }, - "endTarget": { + "id": { "type": "string", - "description": "Reference to the last element in the range when a range of elements inside the contents is referenced.", + "description": "The id of the inbox definition." + }, + "toStatuses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ToStatus" + }, + "description": "The list of to-statuses.", + "nullable": true + }, + "documentObjectTypes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/DocumentObjectType" + }, + "description": "Gets or sets document object types list for the inbox definition.", "nullable": true } }, "additionalProperties": false, - "description": "Represents a link to a node in the contents of a document object." - }, - "DocumentObjectLinkType": { - "enum": [ - "contentReference", - "hyperlink", - "link", - "variable" - ], - "type": "string", - "description": "Defines the type of a link in the contents of a document object." + "description": "Represents an Inbox definition." }, - "DocumentObjectParseError": { + "InfoShareProblemDetails": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/RelatedInfo" + "$ref": "#/components/schemas/ProblemDetails" } ], "properties": { - "reason": { - "type": "string", - "description": "Message describing the current error.", - "nullable": true - }, - "lineNumber": { + "eventId": { "type": "integer", - "description": "The line number indicating where the error occurred. Line numbers start at 1.", - "format": "int32", - "nullable": true + "description": "The event identifier specific to this occurrence of the problem..", + "format": "int32" }, - "linePosition": { - "type": "integer", - "description": "The line position indicating where the error occurred. Line position starts at 1.", - "format": "int32", + "eventName": { + "type": "string", + "description": "The even name specific to this occurrence of the problem.", "nullable": true }, - "errorCode": { - "type": "string", - "description": "The error code.", + "errors": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Error" + }, + "description": "A list of errors related to this occurrence of the problem.", "nullable": true }, - "sourceText": { - "type": "string", - "description": "The text of the content that causes the error.", + "relatedInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RelatedInfo" + }, + "description": "A list of additional information related to this occurrence of the problem.", "nullable": true } }, - "additionalProperties": false, - "description": "Returns detailed information about a parsing error in the contents of a document object." - }, - "DocumentObjectType": { - "enum": [ - "undefined", - "illustration", - "library", - "map", - "other", - "topic" - ], - "type": "string", - "description": "Enumeration holding the type of document." - }, - "DocumentObjectTypeFilter": { - "enum": [ - "any", - "illustration", - "library", - "map", - "other", - "topic" - ], - "type": "string", - "description": "Enumeration holding the type of document for filtering." + "additionalProperties": {} }, - "ElectronicDocumentType": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - } + "IshField": { + "required": [ + "name" ], - "additionalProperties": false, - "description": "Represents a edt." - }, - "Error": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/Message" - } - ], "properties": { - "severity": { + "name": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The name/label of the InfoShare field (e.g. FTITLE)." + }, + "level": { "allOf": [ { - "$ref": "#/components/schemas/SeverityLevel" + "$ref": "#/components/schemas/Level" } ], - "description": "List of Severity Levels", - "readOnly": true + "description": "The level of the InfoShare field (e.g. logical, version, language).", + "nullable": true } }, "additionalProperties": false, - "description": "An error message." + "description": "Represents a field that contains information to access a field." }, - "EventProgress": { + "LanguageGroup": { "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseItem" + } + ], "properties": { - "progressId": { - "type": "integer", - "description": "The progress id.", - "format": "int64" - }, - "eventId": { - "type": "string", - "description": "The event id." + "languages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LovValue" + }, + "description": "The collection of languages in a group." } }, "additionalProperties": false, - "description": "Represents an event." + "description": "Represents the language group." }, - "ExpandBaseline": { + "Level": { + "enum": [ + "none", + "annotation", + "backgroundTask", + "backgroundTaskHistory", + "compute", + "data", + "eventProgressDetail", + "language", + "logical", + "object", + "eventProgress", + "project", + "projectAssignee", + "reply", + "version" + ], + "type": "string", + "description": "Enumeration holding the visible InfoShare hierarchy levels." + }, + "Link": { "type": "object", "properties": { - "startLogicalIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specify a list of logical identifiers of the root map or objects in the outline of the root map that will be used as the starting point for the Baseline calculation.", - "nullable": true - }, - "startResourceLogicalIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specify a list of logical identifiers of resources that will be used as the starting point for the Baseline calculation.", - "nullable": true - }, - "languages": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specify a list of languages.", - "nullable": true - }, - "illustrationLanguages": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specify a list of fallback languages for illustrations.", - "nullable": true - }, - "resourceLanguages": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specify a list of fallback languages for resources.", + "href": { + "type": "string", + "description": "Gets or sets the URL for this Trisoft.Utilities.WebApi.Links.Link.", "nullable": true }, - "resolutions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specify a list of resolutions.", + "rel": { + "type": "string", + "description": "Gets or sets the relation for this Trisoft.Utilities.WebApi.Links.Link.", "nullable": true - }, - "depth": { - "type": "integer", - "description": "Specify how many levels should be returned. If no value is provided all levels will be returned. Valid values are greater than or equal to 1.", - "format": "int32", + }, + "type": { + "type": "string", + "description": "Gets or sets the HTTP method for this Trisoft.Utilities.WebApi.Links.Link.", "nullable": true } }, "additionalProperties": false, - "description": "Represents a ExpandBaseline." + "description": "Represents a HATEOAS link model." }, - "FieldGroup": { + "LinkType": { "enum": [ - "none", - "basic", - "descriptive", - "system", + "contentLink", + "hyperLink", "all" ], "type": "string", - "description": "Groups of metadata fields." + "description": "Indicates which link fields must be used in the GetParents/GetChildren methods." }, - "FieldValue": { - "required": [ - "type" - ], + "LongFieldValue": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/RelatedInfo" + "$ref": "#/components/schemas/FieldValue" } ], "properties": { - "type": { - "type": "string" - }, - "name": { - "type": "string", - "readOnly": true - }, - "ishField": { - "allOf": [ - { - "$ref": "#/components/schemas/IshField" - } - ], - "description": "The field with information the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng).", - "readOnly": true - }, - "title": { - "type": "string", - "description": "The user-friendly title of the field.", - "nullable": true - }, - "description": { - "type": "string", - "description": "The description of the field.", + "value": { + "type": "integer", + "format": "int64", "nullable": true - }, - "isModified": { - "type": "boolean", - "description": "Indicates whether the value has been modified by the metadata\r\nconfiguration since the object was created or its metadata was last set.", - "nullable": true, - "readOnly": true - }, - "messages": { + } + }, + "additionalProperties": false + }, + "LongFilterFieldValue": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/FilterFieldValue" + } + ], + "properties": { + "value": { "type": "array", "items": { - "$ref": "#/components/schemas/Message" + "type": "integer", + "format": "int64" }, - "description": "A list of messages related to the field value.\r\nThe messages can contain warnings and errors.", - "nullable": true + "description": "The filter field value." } }, - "additionalProperties": false, - "description": "Represents a field value that contains information to access a field, and the value associated with the field.", - "discriminator": { - "propertyName": "type", - "mapping": { - "CardFieldValue": "#/components/schemas/CardFieldValue", - "DateTimeFieldValue": "#/components/schemas/DateTimeFieldValue", - "LovFieldValue": "#/components/schemas/LovFieldValue", - "MultiCardFieldValue": "#/components/schemas/MultiCardFieldValue", - "MultiDateTimeFieldValue": "#/components/schemas/MultiDateTimeFieldValue", - "MultiLovFieldValue": "#/components/schemas/MultiLovFieldValue", - "MultiNumberFieldValue": "#/components/schemas/MultiNumberFieldValue", - "MultiStringFieldValue": "#/components/schemas/MultiStringFieldValue", - "MultiTagFieldValue": "#/components/schemas/MultiTagFieldValue", - "MultiVersionFieldValue": "#/components/schemas/MultiVersionFieldValue", - "NumberFieldValue": "#/components/schemas/NumberFieldValue", - "ObjectFieldValue": "#/components/schemas/ObjectFieldValue", - "StringFieldValue": "#/components/schemas/StringFieldValue", - "TagFieldValue": "#/components/schemas/TagFieldValue", - "VersionFieldValue": "#/components/schemas/VersionFieldValue" - } - } + "additionalProperties": false }, - "FilterFieldValue": { - "required": [ - "type" - ], + "LovFieldValue": { "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/FieldValue" + } + ], "properties": { - "type": { - "type": "string", - "description": "The type of the current object.", - "readOnly": true - }, - "name": { - "type": "string", - "description": "The name of the filter field.", - "nullable": true - }, - "ishField": { - "allOf": [ - { - "$ref": "#/components/schemas/IshField" - } - ], - "description": "The field with information about the name/label of the field in the Repository (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." - }, - "operator": { + "value": { "allOf": [ { - "$ref": "#/components/schemas/MetadataFilterOperator" + "$ref": "#/components/schemas/LovValue" } ], - "description": "The filter operator (e.g. equal, not in, like).", + "description": "Represents an item in a value list.", "nullable": true } }, - "additionalProperties": false, - "description": "Represents a filter field that contains information to access a field, and the value associated with the field.", - "discriminator": { - "propertyName": "type", - "mapping": { - "CardFilterFieldValue": "#/components/schemas/CardFilterFieldValue", - "CardLikeFilterFieldValue": "#/components/schemas/CardLikeFilterFieldValue", - "DateTimeFilterFieldValue": "#/components/schemas/DateTimeFilterFieldValue", - "LovFilterFieldValue": "#/components/schemas/LovFilterFieldValue", - "LovLikeFilterFieldValue": "#/components/schemas/LovLikeFilterFieldValue", - "NumberFilterFieldValue": "#/components/schemas/NumberFilterFieldValue", - "StringFilterFieldValue": "#/components/schemas/StringFilterFieldValue", - "TagFilterFieldValue": "#/components/schemas/TagFilterFieldValue" - } - } + "additionalProperties": false }, - "Folder": { + "LovFilterFieldValue": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/BaseObject" + "$ref": "#/components/schemas/FilterFieldValue" } ], "properties": { - "folderType": { - "allOf": [ - { - "$ref": "#/components/schemas/FolderType" - } - ], - "description": "The type of the folder (e.g. ReferenceFolder, PublicationFolder, TopicFolder)." - }, - "baseFolder": { - "allOf": [ - { - "$ref": "#/components/schemas/BaseFolder" - } - ], - "description": "The type of the base folder (e.g. Data, System, Favorites, EditorTemplate).", - "default": "none" + "value": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetLovValue" + }, + "description": "The filter field value." } }, - "additionalProperties": false, - "description": "Represents a folder." + "additionalProperties": false }, - "FolderDescriptor": { + "LovLikeFilterFieldValue": { "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/FilterFieldValue" + } + ], "properties": { - "id": { + "value": { "type": "string", - "description": "The identifier (e.g. 34567)." - }, - "folderType": { - "allOf": [ - { - "$ref": "#/components/schemas/FolderType" - } - ], - "description": "The type of the folder (e.g. ReferenceFolder, PublicationFolder, TopicFolder)." + "description": "The filter field value.", + "nullable": true } }, + "additionalProperties": false + }, + "LovList": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseItem" + } + ], "additionalProperties": false, - "description": "Represents a folder descriptor model." + "description": "Represents an item in a list of list of values." }, - "FolderObjectTypeFilter": { - "enum": [ - "any", - "contents", - "folders" + "LovSearchFieldValue": { + "required": [ + "value" ], - "type": "string", - "description": "Enumeration that lists possible folder item types." + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SearchFieldValue" + } + ], + "properties": { + "value": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/SetLovValue" + }, + "description": "Collection of values to search for." + } + }, + "additionalProperties": false, + "description": "Represents search field value of type System.Collections.Generic.IList`1." }, - "FolderType": { - "enum": [ - "folder", - "illustrationFolder", - "libraryFolder", - "mapFolder", - "otherFolder", - "publicationFolder", - "referenceFolder", - "topicFolder" + "LovValue": { + "required": [ + "type" ], - "type": "string", - "description": "Enumeration holding the type of a folder." + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseItem" + } + ], + "properties": { + "type": { + "type": "string" + }, + "active": { + "type": "boolean", + "description": "The active value.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents an item in a value list.", + "discriminator": { + "propertyName": "type", + "mapping": { + "LovValue": "#/components/schemas/LovValue", + "LovValueWithIcon": "#/components/schemas/LovValueWithIcon", + "FormFieldOperator": "#/components/schemas/FormFieldOperator", + "FullTextSearchFormFieldOperator": "#/components/schemas/FullTextSearchFormFieldOperator", + "MetadataFilterFormFieldOperator": "#/components/schemas/MetadataFilterFormFieldOperator" + } + } }, - "FormFieldOperator": { - "required": [ - "type" - ], + "LovValueWithIcon": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/LovValue" } ], + "properties": { + "icon": { + "type": "string", + "description": "Gets or sets the icon" + } + }, + "additionalProperties": false, + "description": "LovValueWithIcon type is an LovValue extended by an icon attribute." + }, + "Message": { + "required": [ + "type" + ], + "type": "object", "properties": { "type": { - "type": "string" + "type": "string", + "description": "The type of the current object.", + "nullable": true, + "readOnly": true + }, + "title": { + "type": "string", + "description": "A short, human-readable summary of the event message.", + "nullable": true + }, + "detail": { + "type": "string", + "description": "A human-readable explanation specific to this occurrence of the event message.", + "nullable": true + }, + "severity": { + "allOf": [ + { + "$ref": "#/components/schemas/SeverityLevel" + } + ], + "description": "The severity level of the event message." + }, + "eventId": { + "type": "integer", + "description": "The identifier of the corresponding event.", + "format": "int32", + "nullable": true + }, + "eventName": { + "type": "string", + "description": "The name of the corresponding event.", + "nullable": true + }, + "logId": { + "type": "integer", + "description": "The identifier of the corresponding entry in the log.", + "format": "int64", + "nullable": true + }, + "relatedInfo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/RelatedInfo" + }, + "description": "A list of additional information related to this occurrence of the event message.", + "nullable": true } }, "additionalProperties": false, - "description": "Represents an operator on a Trisoft.InfoShare.WebApi.V30.Models.Forms.FormField.", + "description": "An event message.", "discriminator": { "propertyName": "type", "mapping": { - "FullTextSearchFormFieldOperator": "#/components/schemas/FullTextSearchFormFieldOperator", - "MetadataFilterFormFieldOperator": "#/components/schemas/MetadataFilterFormFieldOperator" + "Message": "#/components/schemas/Message", + "Error": "#/components/schemas/Error" } } }, - "FullTextSearchFormFieldOperator": { + "MetadataFilterFormFieldOperator": { "type": "object", "allOf": [ { @@ -11620,7 +29351,7 @@ "operator": { "allOf": [ { - "$ref": "#/components/schemas/FullTextSearchOperator" + "$ref": "#/components/schemas/MetadataFilterOperator" } ], "description": "Search operator that will be used in search operations.", @@ -11628,1774 +29359,1815 @@ } }, "additionalProperties": false, - "description": "Represents a full text search operator on a Trisoft.InfoShare.WebApi.V30.Models.Forms.FormField." + "description": "Represents a metadata filter operator on a Trisoft.InfoShare.WebApi.V30.Models.Forms.FormField." }, - "FullTextSearchOperator": { + "MetadataFilterOperator": { "enum": [ "equal", "notEqual", - "lessThan", + "in", + "notIn", + "like", "greaterThan", - "lessThanOrEqual", + "lessThan", "greaterThanOrEqual", - "contains" + "lessThanOrEqual", + "between", + "empty", + "notEmpty", + "ciLike" ], "type": "string", - "description": "Enumeration holding search operator options." + "description": "Specifies the possible filter operators that can be used by `FilterFieldValue`." }, - "GetBaselineList": { + "MoveFolder": { "type": "object", "properties": { - "ids": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List with baselineIds which can be used to limit the result to baselines within this list that match the other filters.\r\nIf not supplied, all the baselines will be returned.", - "nullable": true + "folderId": { + "minimum": 0, + "exclusiveMinimum": true, + "type": "integer", + "description": "The card id of the folder that should be moved.", + "format": "int64" }, - "activityFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/ActivityFilter" - } - ], - "description": "Filter of activity that limits the baselines to only the active or inactive ones. If not supplied, all the baselines will be returned.", - "default": "none" + "destinationId": { + "minimum": 0, + "exclusiveMinimum": true, + "type": "integer", + "description": "The card id of the destination folder.", + "format": "int64" + } + }, + "additionalProperties": false, + "description": "Represents a move folder model." + }, + "MoveObject": { + "required": [ + "logicalId" + ], + "type": "object", + "properties": { + "logicalId": { + "minLength": 1, + "type": "string", + "description": "The logical identifier of the object that should be moved." }, - "filterFields": { + "destinationId": { + "minimum": 0, + "exclusiveMinimum": true, + "type": "integer", + "description": "The card identifier of the destination folder.", + "format": "int64" + } + }, + "additionalProperties": false, + "description": "Represents a move object model." + }, + "MultiCardFieldValue": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/FieldValue" + } + ], + "properties": { + "value": { "type": "array", "items": { - "$ref": "#/components/schemas/FilterFieldValue" + "$ref": "#/components/schemas/BaseObject" }, - "description": "The filter fields that contain information to access a field, and the value associated with the field.", "nullable": true - }, - "fieldGroup": { - "allOf": [ - { - "$ref": "#/components/schemas/FieldGroup" - } - ], - "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", - "default": "none" - }, - "fields": { + } + }, + "additionalProperties": false + }, + "MultiDateTimeFieldValue": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/FieldValue" + } + ], + "properties": { + "value": { "type": "array", "items": { - "$ref": "#/components/schemas/RequestedField" + "type": "string", + "format": "date-time" }, - "description": "Specifies one or more metadata fields to return.", "nullable": true } }, - "additionalProperties": false, - "description": "Request object to get all baselines in the repository that match the criteria given in the properties." + "additionalProperties": false }, - "GetDocumentObjectList": { + "MultiLovFieldValue": { "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/FieldValue" + } + ], "properties": { - "objectTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentObjectTypeFilter" - }, - "description": "Type of the document. If not supplied, all the type of documents will be returned.", - "default": [ - "any" - ] - }, - "statusFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/StatusFilter" - } - ], - "description": "Filtering on a type of status using status settings.", - "default": "all" - }, - "filterFields": { + "value": { "type": "array", "items": { - "$ref": "#/components/schemas/FilterFieldValue" + "$ref": "#/components/schemas/LovValue" }, - "description": "The filter fields that contain information to access a field, and the value associated with the field.", "nullable": true - }, - "selectedProperties": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectedProperties" - } - ], - "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", - "default": "id" - }, - "fieldGroup": { - "allOf": [ - { - "$ref": "#/components/schemas/FieldGroup" - } - ], - "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", - "default": "none" - }, - "fields": { + } + }, + "additionalProperties": false + }, + "MultiNumberFieldValue": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/FieldValue" + } + ], + "properties": { + "value": { "type": "array", "items": { - "$ref": "#/components/schemas/RequestedField" + "type": "number", + "format": "double" }, - "description": "Specifies one or more metadata fields to return.", "nullable": true - }, - "includeLinks": { - "type": "boolean", - "description": "true to include the links; otherwise, false. Default is false.", - "default": false } }, - "additionalProperties": false, - "description": "Request object to get all objects in the repository that match the criteria given in the properties." + "additionalProperties": false }, - "GetDocumentObjectListByLanguageCardId": { - "required": [ - "languageCardIds" - ], + "MultiStringFieldValue": { "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/FieldValue" + } + ], "properties": { - "objectTypes": { + "value": { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentObjectTypeFilter" + "type": "string" }, - "description": "Type of the document. If not supplied, all the type of documents will be returned.", - "default": [ - "any" - ] - }, - "languageCardIds": { - "minItems": 1, + "nullable": true + } + }, + "additionalProperties": false + }, + "MultiTagFieldValue": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/FieldValue" + } + ], + "properties": { + "value": { "type": "array", "items": { - "type": "integer", - "format": "int64" + "$ref": "#/components/schemas/Tag" }, - "description": "Language card identifiers of the objects." - }, - "statusFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/StatusFilter" - } - ], - "description": "Filtering on a type of status using status settings.", - "default": "all" - }, - "filterFields": { + "nullable": true + } + }, + "additionalProperties": false + }, + "MultiVersionFieldValue": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/FieldValue" + } + ], + "properties": { + "value": { "type": "array", "items": { - "$ref": "#/components/schemas/FilterFieldValue" + "type": "string" }, - "description": "The filter fields that contain information to access a field, and the value associated with the field.", "nullable": true - }, - "selectedProperties": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectedProperties" - } - ], - "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", - "default": "id" - }, - "fieldGroup": { + } + }, + "additionalProperties": false + }, + "NextStatus": { + "type": "object", + "properties": { + "value": { "allOf": [ { - "$ref": "#/components/schemas/FieldGroup" + "$ref": "#/components/schemas/LovValue" } ], - "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", - "default": "none" - }, - "fields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RequestedField" - }, - "description": "Specifies one or more metadata fields to return.", - "nullable": true - }, - "includeLinks": { - "type": "boolean", - "description": "true to include the links; otherwise, false. Default is false.", - "default": false + "description": "The value of the next status element in the report configuration XML." } }, "additionalProperties": false, - "description": "Request object to get all objects in the repository that match the criteria given in the properties." + "description": "Represents next status element in the report configuration XML." }, - "GetDocumentObjectListByLogicalId": { - "required": [ - "logicalIds" + "NumberFieldValue": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/FieldValue" + } ], + "properties": { + "value": { + "type": "number", + "format": "double", + "nullable": true + } + }, + "additionalProperties": false + }, + "NumberFilterFieldValue": { "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/FilterFieldValue" + } + ], "properties": { - "objectTypes": { + "value": { "type": "array", "items": { - "$ref": "#/components/schemas/DocumentObjectTypeFilter" + "type": "number", + "format": "double" }, - "description": "Type of the document. If not supplied, all the type of documents will be returned.", - "default": [ - "any" - ] - }, - "logicalIds": { + "description": "The filter field value." + } + }, + "additionalProperties": false + }, + "NumberSearchFieldValue": { + "required": [ + "value" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SearchFieldValue" + } + ], + "properties": { + "value": { "minItems": 1, "type": "array", "items": { - "type": "string" - }, - "description": "Logical ids of the objects." - }, - "statusFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/StatusFilter" - } - ], - "description": "Filtering on a type of status using status settings.", - "default": "all" - }, - "filterFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FilterFieldValue" + "type": "number", + "format": "double" }, - "description": "The filter fields that contain information to access a field, and the value associated with the field.", + "description": "Collection of values to search for." + } + }, + "additionalProperties": false, + "description": "Represents search field value of type System.Collections.Generic.IList`1." + }, + "ObjectFieldValue": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/FieldValue" + } + ], + "properties": { + "value": { "nullable": true + } + }, + "additionalProperties": false + }, + "ObjectType": { + "enum": [ + "annotation", + "baseline", + "backgroundTask", + "configuration", + "electronicDocumentType", + "eventProgress", + "folder", + "illustration", + "library", + "map", + "other", + "outputFormat", + "project", + "publication", + "topic", + "translationJob", + "user", + "userGroup", + "userRole" + ], + "type": "string", + "description": "Enumeration holding the type of object." + }, + "OrSearchExpression": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/GroupSearchExpression" + } + ], + "additionalProperties": false, + "description": "Represents collection of search expression to be evaluated with OR logical operator." + }, + "OutputFormat": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + } + ], + "additionalProperties": false, + "description": "Represents a output format." + }, + "PreferenceItem": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the preference item." }, - "selectedProperties": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectedProperties" - } - ], - "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", - "default": "id" - }, - "fieldGroup": { - "allOf": [ - { - "$ref": "#/components/schemas/FieldGroup" - } - ], - "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", - "default": "none" + "value": { + "type": "string", + "description": "The value of the preference item.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents user preference item" + }, + "PreferenceSet": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The Name of the preference set" }, - "fields": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/RequestedField" + "$ref": "#/components/schemas/PreferenceItem" }, - "description": "Specifies one or more metadata fields to return.", + "description": "The list of Trisoft.InfoShare.WebApi.V30.Users.Models.PreferenceItem contained in the Preference set", "nullable": true - }, - "includeLinks": { - "type": "boolean", - "description": "true to include the links; otherwise, false. Default is false.", - "default": false - }, - "includePartialItems": { - "type": "boolean", - "description": "true to include partial items when the version or language is missing; otherwise, false. Default is false.", - "default": false } }, "additionalProperties": false, - "description": "Request object to get all objects in the repository that match the criteria given in the properties." + "description": "Represents user preference set" }, - "GetDocumentObjectListUsingDocumentObject": { + "ProblemDetails": { + "required": [ + "type" + ], "type": "object", "properties": { - "linkType": { - "allOf": [ - { - "$ref": "#/components/schemas/LinkType" - } - ], - "description": "The type of the link.", - "default": "all" + "type": { + "type": "string", + "nullable": true }, - "objectTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/DocumentObjectTypeFilter" - }, - "description": "Type of the document. If not supplied, all the type of documents will be returned.", - "default": [ - "any" - ] + "title": { + "type": "string", + "nullable": true }, - "statusFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/StatusFilter" - } - ], - "description": "Filtering on a type of status using status settings.", - "default": "all" + "status": { + "type": "integer", + "format": "int32", + "nullable": true }, - "filterFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FilterFieldValue" - }, - "description": "The filter fields that contain information to access a field, and the value associated with the field.", + "detail": { + "type": "string", "nullable": true }, - "fieldGroup": { - "allOf": [ - { - "$ref": "#/components/schemas/FieldGroup" - } - ], - "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", - "default": "none" + "instance": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": {}, + "discriminator": { + "propertyName": "type", + "mapping": { + "ProblemDetails": "#/components/schemas/ProblemDetails", + "InfoShareProblemDetails": "#/components/schemas/InfoShareProblemDetails" + } + } + }, + "ProgressStatus": { + "enum": [ + "busy", + "success", + "warning", + "failed", + "calculate" + ], + "type": "string", + "description": "The Trisoft.InfoShare.WebApi.V30.Models.Enumerations.ProgressStatus indicates the status of an event." + }, + "ProgressStatusFilter": { + "enum": [ + "busy", + "success", + "warning", + "failed", + "all" + ], + "type": "string", + "description": "Used to specify which events should be retrieved by the event monitor." + }, + "Project": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + } + ], + "properties": { + "projectId": { + "type": "string", + "description": "The element name of the project." }, - "fields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RequestedField" - }, - "description": "A collection of requested metadata fields.", + "assigneeCardId": { + "type": "integer", + "description": "The CardId of the Assignee (if available).", + "format": "int64", "nullable": true }, - "selectedProperties": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectedProperties" - } - ], - "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", - "default": "id" + "publicationTitle": { + "type": "string", + "description": "The title of the publication.", + "nullable": true }, - "includeLinks": { - "type": "boolean", - "description": "true to include the links; otherwise, false. Default is false.", - "default": false + "publicationVersion": { + "type": "string", + "description": "The version number of the publication version.", + "nullable": true } }, "additionalProperties": false, - "description": "Request object to get all objects in the repository that are referencing the given logical id." + "description": "Represents a project." }, - "GetFolderList": { - "required": [ - "ids" - ], + "Publication": { "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + } + ], "properties": { - "ids": { - "minItems": 1, - "type": "array", - "items": { - "type": "string" - }, - "description": "List with folderIds which can be used to limit the result to folders within this list that match the other filters." + "versionCardId": { + "type": "integer", + "description": "The version card identifier.", + "format": "int64", + "nullable": true }, - "fieldGroup": { - "allOf": [ - { - "$ref": "#/components/schemas/FieldGroup" - } - ], - "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", - "default": "none" + "languageCardId": { + "type": "integer", + "description": "The language card identifier.", + "format": "int64", + "nullable": true }, - "fields": { + "logicalId": { + "type": "string", + "description": "The logical identifier." + }, + "version": { + "type": "string", + "description": "The version.", + "nullable": true + }, + "outputFormatId": { + "type": "string", + "description": "The output format identifier.", + "nullable": true + }, + "languageCombinationIds": { "type": "array", "items": { - "$ref": "#/components/schemas/RequestedField" + "type": "string" }, - "description": "Specifies one or more metadata fields to return.", + "description": "The language identifier combination.", "nullable": true - }, - "selectedProperties": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectedProperties" - } - ], - "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", - "default": "id" - }, - "includeLinks": { - "type": "boolean", - "description": "true to include the links; otherwise, false. Default is false.", - "default": false } }, "additionalProperties": false, - "description": "Request folder to get all folders in the repository that match the criteria given in the properties." + "description": "Represents a publication." }, - "GetInboxObjectList": { + "PublicationFreezeReport": { "type": "object", "properties": { - "selectedProperties": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectedProperties" - } - ], - "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", - "default": "id" - }, - "fieldGroup": { + "publication": { "allOf": [ { - "$ref": "#/components/schemas/FieldGroup" + "$ref": "#/components/schemas/Publication" } ], - "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", - "default": "none" + "description": "publication that reports belongs to." }, - "fields": { + "messages": { "type": "array", - "items": { - "$ref": "#/components/schemas/RequestedField" - }, - "description": "Specifies one or more metadata fields to return.", - "nullable": true - }, - "includeLinks": { - "type": "boolean", - "description": "true to include the links; otherwise, false. Default is false.", - "default": false + "items": { + "$ref": "#/components/schemas/Message" + }, + "description": "All messages belonging to a publication." } }, "additionalProperties": false, - "description": "Represents an Inbox object list." + "description": "Represents freeze status of the publication." }, - "GetLovList": { + "PublishPublication": { "type": "object", "properties": { - "ids": { + "requiredCurrentFields": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/SetFieldValue" }, - "description": "The identifiers of list of values", + "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to publish the Trisoft.InfoShare.WebApi.V30.Publications.Models.Publication.", "nullable": true } }, "additionalProperties": false, - "description": "Represents a get Lov list model." + "description": "Represents a publish model for publication." }, - "GetMetadataBindingTagList": { + "RelatedInfo": { + "required": [ + "type" + ], "type": "object", "properties": { - "inputFilter": { + "type": { "type": "string", - "description": "String used to filter the possible tags.", - "nullable": true - }, - "fields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SetFieldValue" - }, - "description": "Specify some fields of the object which might impact the possible tags.\r\nFor instance FTESTCOUNTRIES with value \"Netherlands\" will limit the result to \"Amsterdam\"", - "nullable": true - }, - "maxTagsToReturn": { - "minimum": 0, - "exclusiveMinimum": true, - "type": "integer", - "description": "Maximum number of tags that should be returned.", - "format": "int64", - "default": 20 + "description": "The type of the current object.", + "nullable": true, + "readOnly": true } }, "additionalProperties": false, - "description": "Request object to get metadata bound tags that match the criteria given in the properties." + "description": "A list of additional information.", + "discriminator": { + "propertyName": "type", + "mapping": { + "User": "#/components/schemas/User", + "UserRole": "#/components/schemas/UserRole", + "UserGroup": "#/components/schemas/UserGroup", + "TranslationJob": "#/components/schemas/TranslationJob", + "LanguageGroup": "#/components/schemas/LanguageGroup", + "LovValueWithIcon": "#/components/schemas/LovValueWithIcon", + "Setting": "#/components/schemas/Setting", + "InContextDocumentObject": "#/components/schemas/InContextDocumentObject", + "Publication": "#/components/schemas/Publication", + "Project": "#/components/schemas/Project", + "OutputFormat": "#/components/schemas/OutputFormat", + "BaseItem": "#/components/schemas/BaseItem", + "BaseObject": "#/components/schemas/BaseObject", + "LovList": "#/components/schemas/LovList", + "LovValue": "#/components/schemas/LovValue", + "RevisionInfo": "#/components/schemas/RevisionInfo", + "Tag": "#/components/schemas/Tag", + "SearchObject": "#/components/schemas/SearchObject", + "FormFieldOperator": "#/components/schemas/FormFieldOperator", + "FullTextSearchFormFieldOperator": "#/components/schemas/FullTextSearchFormFieldOperator", + "MetadataFilterFormFieldOperator": "#/components/schemas/MetadataFilterFormFieldOperator", + "FieldValue": "#/components/schemas/FieldValue", + "CardFieldValue": "#/components/schemas/CardFieldValue", + "DateTimeFieldValue": "#/components/schemas/DateTimeFieldValue", + "LongFieldValue": "#/components/schemas/LongFieldValue", + "LovFieldValue": "#/components/schemas/LovFieldValue", + "MultiCardFieldValue": "#/components/schemas/MultiCardFieldValue", + "MultiDateTimeFieldValue": "#/components/schemas/MultiDateTimeFieldValue", + "MultiLovFieldValue": "#/components/schemas/MultiLovFieldValue", + "MultiNumberFieldValue": "#/components/schemas/MultiNumberFieldValue", + "MultiStringFieldValue": "#/components/schemas/MultiStringFieldValue", + "MultiTagFieldValue": "#/components/schemas/MultiTagFieldValue", + "MultiVersionFieldValue": "#/components/schemas/MultiVersionFieldValue", + "NumberFieldValue": "#/components/schemas/NumberFieldValue", + "ObjectFieldValue": "#/components/schemas/ObjectFieldValue", + "StringFieldValue": "#/components/schemas/StringFieldValue", + "TagFieldValue": "#/components/schemas/TagFieldValue", + "VersionFieldValue": "#/components/schemas/VersionFieldValue", + "Folder": "#/components/schemas/Folder", + "EventProgress": "#/components/schemas/EventProgress", + "ElectronicDocumentType": "#/components/schemas/ElectronicDocumentType", + "DocumentObject": "#/components/schemas/DocumentObject", + "DocumentObjectLink": "#/components/schemas/DocumentObjectLink", + "DocumentObjectParseError": "#/components/schemas/DocumentObjectParseError", + "RevisionHistoryItem": "#/components/schemas/RevisionHistoryItem", + "Baseline": "#/components/schemas/Baseline", + "BackgroundTask": "#/components/schemas/BackgroundTask", + "Annotation": "#/components/schemas/Annotation", + "AnnotationMetadata": "#/components/schemas/AnnotationMetadata", + "AnnotationReplyMetadata": "#/components/schemas/AnnotationReplyMetadata", + "SchemaValidationError": "#/components/schemas/SchemaValidationError" + } + } }, - "GetMetadataBindingTagStructure": { + "ReleasePublication": { "type": "object", "properties": { - "fields": { + "requiredCurrentFields": { "type": "array", "items": { "$ref": "#/components/schemas/SetFieldValue" }, - "description": "Specify some fields of the object which might impact the possible tags structure.\r\nFor instance FTESTCOUNTRIES with value \"Netherlands\" will limit the result to \"Amsterdam\"", + "description": "Fields that will be used in concurrency check.", "nullable": true } }, "additionalProperties": false, - "description": "Request object to get metadata bound tags structure that match the criteria given in the properties." + "description": "Represents a release model for publication." }, - "GetPublicationList": { + "RemoveShortcut": { + "required": [ + "logicalId" + ], "type": "object", "properties": { - "statusFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/StatusFilter" - } - ], - "description": "Filtering on a type of status using status settings.", - "default": "all" + "logicalId": { + "minLength": 1, + "type": "string", + "description": "Specify logical identifier of the document object or publication for which to remove a shortcut." + } + }, + "additionalProperties": false, + "description": "Represents logical identifier model." + }, + "ReportSettings": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string" }, - "filterFields": { + "baselineResolutions": { "type": "array", "items": { - "$ref": "#/components/schemas/FilterFieldValue" + "$ref": "#/components/schemas/LovValue" }, - "description": "The filter fields that contain information to access a field, and the value associated with the field.", + "description": "List of baseline resolution in the report configuration XML.", "nullable": true - }, - "selectedProperties": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectedProperties" - } - ], - "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", - "default": "id" - }, - "fieldGroup": { + } + }, + "additionalProperties": false, + "description": "Represents the report configuration.", + "discriminator": { + "propertyName": "type", + "mapping": { + "TranslationReportSettings": "#/components/schemas/TranslationReportSettings", + "WorkflowReportSettings": "#/components/schemas/WorkflowReportSettings" + } + } + }, + "RequestedField": { + "required": [ + "ishField" + ], + "type": "object", + "properties": { + "ishField": { "allOf": [ { - "$ref": "#/components/schemas/FieldGroup" + "$ref": "#/components/schemas/IshField" } ], - "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", - "default": "none" - }, - "fields": { + "description": "The field with information about the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." + } + }, + "additionalProperties": false, + "description": "Represents a requested metadata field." + }, + "RetryTranslationJob": { + "type": "object", + "properties": { + "requiredCurrentFields": { "type": "array", "items": { - "$ref": "#/components/schemas/RequestedField" + "$ref": "#/components/schemas/SetFieldValue" }, - "description": "Specifies one or more metadata fields to return.", - "nullable": true - }, - "includeLinks": { - "type": "boolean", - "description": "true to include the links; otherwise, false. Default is false.", - "default": false + "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to update the Trisoft.InfoShare.WebApi.V30.TranslationJobs.Models.TranslationJob." } }, "additionalProperties": false, - "description": "Request object to get all objects in the repository that match the criteria given in the properties." + "description": "Represents a retry translation job model." }, - "GetPublicationListByLanguageCardId": { + "RetryTranslationJobParameters": { "required": [ - "languageCardIds" + "id" ], "type": "object", "properties": { - "languageCardIds": { - "minItems": 1, - "type": "array", - "items": { - "type": "integer", - "format": "int64" - }, - "description": "Logical ids of the objects." + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the translation job." + } + }, + "additionalProperties": false, + "description": "The request object to retry the translation job by its identifier." + }, + "RevisionHistoryChange": { + "type": "object", + "properties": { + "modifiedOn": { + "type": "string", + "description": "The datetime of the modification on the document object.", + "format": "date-time" }, - "statusFilter": { + "modifiedBy": { "allOf": [ { - "$ref": "#/components/schemas/StatusFilter" + "$ref": "#/components/schemas/User" } ], - "description": "Filtering on a type of status using status settings.", - "default": "all" - }, - "filterFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FilterFieldValue" - }, - "description": "The filter fields that contain information to access a field, and the value associated with the field.", - "nullable": true + "description": "The user who modified the document object." }, - "selectedProperties": { + "status": { "allOf": [ { - "$ref": "#/components/schemas/SelectedProperties" + "$ref": "#/components/schemas/LovValue" } ], - "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", - "default": "id" + "description": "The status of the document object." + } + }, + "additionalProperties": false, + "description": "Represents a revision history change." + }, + "RevisionHistoryItem": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + } + ], + "properties": { + "sequence": { + "type": "integer", + "description": "The sequence number of a revision history item.", + "format": "int64" }, - "fieldGroup": { + "modifiedOn": { + "type": "string", + "description": "The datetime of the modification on the document object.", + "format": "date-time" + }, + "modifiedBy": { "allOf": [ { - "$ref": "#/components/schemas/FieldGroup" + "$ref": "#/components/schemas/User" } ], - "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", - "default": "none" + "description": "The user who modified the document object." }, - "fields": { + "changes": { "type": "array", "items": { - "$ref": "#/components/schemas/RequestedField" + "$ref": "#/components/schemas/RevisionHistoryChange" }, - "description": "Specifies one or more metadata fields to return.", - "nullable": true + "description": "The list of changes that happened to the revision." }, - "includeLinks": { + "isRemoved": { "type": "boolean", - "description": "true to include the links; otherwise, false. Default is false.", - "default": false + "description": "Indicates whether the revision is removed from the Repository." } }, "additionalProperties": false, - "description": "Request object to get all publications in the repository that match the criteria given in the properties." + "description": "Represents a revision history item." }, - "GetPublicationListByLogicalId": { - "required": [ - "logicalIds" + "RevisionInfo": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + } ], + "additionalProperties": false, + "description": "Represents a revision info." + }, + "SchemaValidationError": { "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/RelatedInfo" + } + ], "properties": { - "logicalIds": { - "minItems": 1, - "type": "array", - "items": { - "type": "string" - }, - "description": "Logical ids of the objects." - }, - "statusFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/StatusFilter" - } - ], - "description": "Filtering on a type of status using status settings.", - "default": "all" - }, - "filterFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/FilterFieldValue" - }, - "description": "The filter fields that contain information to access a field, and the value associated with the field.", + "path": { + "type": "string", + "description": "Path to the schema where validation failed.", "nullable": true + } + }, + "additionalProperties": false, + "description": "Class representing a schema validation error." + }, + "ScoreSearchSortField": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseSearchSortField" + } + ], + "additionalProperties": false, + "description": "Represents a search order criteria based on SolrLucene score." + }, + "SearchExpression": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "readOnly": true + } + }, + "additionalProperties": false, + "description": "Represents base search expressions.", + "discriminator": { + "propertyName": "type", + "mapping": { + "AndSearchExpression": "#/components/schemas/AndSearchExpression", + "AnywhereSearchFieldValue": "#/components/schemas/AnywhereSearchFieldValue", + "CardSearchFieldValue": "#/components/schemas/CardSearchFieldValue", + "DateTimeSearchFieldValue": "#/components/schemas/DateTimeSearchFieldValue", + "GroupSearchExpression": "#/components/schemas/GroupSearchExpression", + "LovSearchFieldValue": "#/components/schemas/LovSearchFieldValue", + "NumberSearchFieldValue": "#/components/schemas/NumberSearchFieldValue", + "OrSearchExpression": "#/components/schemas/OrSearchExpression", + "SearchFieldValue": "#/components/schemas/SearchFieldValue", + "StringSearchFieldValue": "#/components/schemas/StringSearchFieldValue" + } + } + }, + "SearchFieldValue": { + "required": [ + "type" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SearchExpression" + } + ], + "properties": { + "type": { + "type": "string" }, - "selectedProperties": { + "fullTextSearchOperator": { "allOf": [ { - "$ref": "#/components/schemas/SelectedProperties" + "$ref": "#/components/schemas/FullTextSearchOperator" } ], - "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", - "default": "id" + "description": "The search operator." }, - "fieldGroup": { + "ishField": { "allOf": [ { - "$ref": "#/components/schemas/FieldGroup" + "$ref": "#/components/schemas/IshField" } ], - "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", - "default": "none" - }, - "fields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RequestedField" - }, - "description": "Specifies one or more metadata fields to return.", - "nullable": true - }, - "includeLinks": { - "type": "boolean", - "description": "true to include the links; otherwise, false. Default is false.", - "default": false - }, - "includePartialItems": { - "type": "boolean", - "description": "true to include the partial items; otherwise, false. Default is false.", - "default": false + "description": "The search field." } }, "additionalProperties": false, - "description": "Request object to get all publications in the repository that match the criteria given in the properties." + "description": "Represents a search field value.", + "discriminator": { + "propertyName": "type", + "mapping": { + "CardSearchFieldValue": "#/components/schemas/CardSearchFieldValue", + "DateTimeSearchFieldValue": "#/components/schemas/DateTimeSearchFieldValue", + "LovSearchFieldValue": "#/components/schemas/LovSearchFieldValue", + "NumberSearchFieldValue": "#/components/schemas/NumberSearchFieldValue", + "StringSearchFieldValue": "#/components/schemas/StringSearchFieldValue" + } + } }, - "GetPublicationListUsingDocumentObject": { + "SearchInPublicationRequest": { "type": "object", "properties": { - "selectedProperties": { + "autoCompleteMode": { "allOf": [ { - "$ref": "#/components/schemas/SelectedProperties" + "$ref": "#/components/schemas/BaselineAutoCompleteMode" } ], - "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", - "default": "id" + "description": "Specify the auto complete mode that must be used to select the versions in the Baseline.", + "default": "none" }, - "fieldGroup": { + "expression": { "allOf": [ { - "$ref": "#/components/schemas/FieldGroup" + "$ref": "#/components/schemas/GroupSearchExpression" } ], - "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", - "default": "none" + "description": "Search expressions group.\r\nUse Trisoft.InfoShare.WebApi.V30.Models.Search.AnywhereSearchFieldValue for filtering anywhere." }, - "fields": { + "objectTypes": { "type": "array", "items": { - "$ref": "#/components/schemas/RequestedField" + "$ref": "#/components/schemas/SearchObjectTypeFilter" }, - "description": "A collection of requested metadata fields.", - "nullable": true + "description": "Search object type filter." }, - "includeLinks": { - "type": "boolean", - "description": "true to include the links; otherwise, false. Default is false.", - "default": false - } - }, - "additionalProperties": false, - "description": "Represents model to get list of publications inside which the object is used." - }, - "GetUserGroupList": { - "type": "object", - "properties": { - "ids": { + "languages": { "type": "array", "items": { "type": "string" }, - "description": "List with userGroupIds which can be used to limit the result to user groups within this list that match the other filters.\r\nIf not supplied, all the user groups will be returned.", + "description": "The languages list to be included in the search result.", "nullable": true }, - "activityFilter": { - "allOf": [ - { - "$ref": "#/components/schemas/ActivityFilter" - } - ], - "description": "Filter of activity that limits the user groups to only the active or inactive ones. If not supplied, all the user groups will be returned.", - "default": "none" - }, - "filterFields": { + "resolutions": { "type": "array", "items": { - "$ref": "#/components/schemas/FilterFieldValue" + "type": "string" }, - "description": "The filter fields that contain information to access a field, and the value associated with the field.", + "description": "The resolutions list to be included in the search result.", "nullable": true }, - "selectedProperties": { - "allOf": [ - { - "$ref": "#/components/schemas/SelectedProperties" - } - ], - "description": "Specifies the properties that will be returned. If not supplied, only the identifier will be returned.", - "default": "id" - }, - "fieldGroup": { - "allOf": [ - { - "$ref": "#/components/schemas/FieldGroup" - } - ], - "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", - "default": "none" - }, - "fields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RequestedField" - }, - "description": "Specifies one or more metadata fields to return.", - "nullable": true + "sizeLimit": { + "type": "integer", + "description": "The maximum number of objects to return.", + "format": "int32" + } + }, + "additionalProperties": false, + "description": "Represents search request criteria to find document objects." + }, + "SearchInPublicationRequestParameters": { + "required": [ + "logicalId", + "version" + ], + "type": "object", + "properties": { + "logicalId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The publication logical identifier." }, - "includeLinks": { - "type": "boolean", - "description": "true to include the links; otherwise, false. Default is false.", - "default": false + "version": { + "minLength": 1, + "type": "string", + "description": "The version of the publication." + } + }, + "additionalProperties": false, + "description": "Represents search request criteria to find document objects." + }, + "SearchObject": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" } - }, + ], "additionalProperties": false, - "description": "Request object to get all user groups in the repository that match the criteria given in the properties." + "description": "Represents a search object." }, - "GetUserList": { + "SearchObjectTypeFilter": { + "enum": [ + "any", + "illustration", + "library", + "map", + "other", + "topic" + ], + "type": "string", + "description": "Enumeration holding search object type options." + }, + "SearchRequest": { "type": "object", "properties": { - "ids": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List with userIds which can be used to limit the result to users within this list that match the other filters.\r\nIf not supplied, all the users will be returned.", - "nullable": true - }, - "activityFilter": { + "expression": { "allOf": [ { - "$ref": "#/components/schemas/ActivityFilter" + "$ref": "#/components/schemas/GroupSearchExpression" } ], - "description": "Filter of activity that limits the users to only the active or inactive ones. If not supplied, all the users will be returned.", - "default": "none" + "description": "Search expressions group.\r\nUse Trisoft.InfoShare.WebApi.V30.Models.Search.AnywhereSearchFieldValue for filtering anywhere." }, - "filterFields": { + "sortFields": { "type": "array", "items": { - "$ref": "#/components/schemas/FilterFieldValue" + "$ref": "#/components/schemas/BaseSearchSortField" }, - "description": "The filter fields that contain information to access a field, and the value associated with the field.", + "description": "Represents list of fields to be used to sort the search result.\r\nUse Trisoft.InfoShare.WebApi.V30.Models.Search.ScoreSearchSortField for sorting on the SolrLucene score. Trisoft.InfoShare.WebApi.V30.Models.Search.ScoreSearchSortField sort fields are used for SolrLucene by default.", "nullable": true }, - "fieldGroup": { + "versionFilter": { "allOf": [ { - "$ref": "#/components/schemas/FieldGroup" + "$ref": "#/components/schemas/SearchVersionFilter" } ], - "description": "Group of metadata fields that will be returned. If not supplied, no fields will be returned.", - "default": "none" + "description": "Search version filter options." }, - "fields": { + "objectTypes": { "type": "array", "items": { - "$ref": "#/components/schemas/RequestedField" + "$ref": "#/components/schemas/SearchObjectTypeFilter" }, - "description": "Specifies one or more metadata fields to return.", - "nullable": true + "description": "Search object type filter." }, - "includeLinks": { - "type": "boolean", - "description": "true to include the links; otherwise, false. Default is false.", - "default": false - } - }, - "additionalProperties": false, - "description": "Request object to get all users in the repository that match the criteria given in the properties." - }, - "GroupSearchExpression": { - "required": [ - "type" - ], - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/SearchExpression" - } - ], - "properties": { - "type": { - "type": "string" + "languages": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The languages list to be included in the search result.", + "nullable": true }, - "expressions": { + "resolutions": { "type": "array", "items": { - "$ref": "#/components/schemas/SearchExpression" + "type": "string" }, - "description": "Collection of search expressions." + "description": "The resolutions list to be included in the search result.", + "nullable": true + }, + "sizeLimit": { + "type": "integer", + "description": "The maximum number of objects to return.", + "format": "int32" } }, "additionalProperties": false, - "description": "Represents a search expression group.", - "discriminator": { - "propertyName": "type", - "mapping": { - "AndSearchExpression": "#/components/schemas/AndSearchExpression", - "OrSearchExpression": "#/components/schemas/OrSearchExpression" - } - } + "description": "Represents search request criteria to find document objects." }, - "Inbox": { + "SearchResponse": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "The name of the inbox definition." - }, - "id": { - "type": "string", - "description": "The id of the inbox definition." + "totalHitsFound": { + "type": "integer", + "description": "The total number of hits for the current search.", + "format": "int64" }, - "toStatuses": { + "entries": { "type": "array", "items": { - "$ref": "#/components/schemas/ToStatus" + "$ref": "#/components/schemas/SearchResultEntry" }, - "description": "The list of to-statuses.", - "nullable": true + "description": "Collection of search result entries." } }, "additionalProperties": false, - "description": "Represents an Inbox definition." + "description": "Represents the search response." }, - "InfoShareProblemDetails": { + "SearchResultEntry": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/ProblemDetails" - } - ], "properties": { - "eventId": { - "type": "integer", - "description": "The event identifier specific to this occurrence of the problem..", - "format": "int32" + "documentObjectType": { + "allOf": [ + { + "$ref": "#/components/schemas/DocumentObjectType" + } + ], + "description": "The document object type." }, - "eventName": { + "logicalId": { "type": "string", - "description": "The even name specific to this occurrence of the problem.", - "nullable": true + "description": "The document object logical id." }, - "errors": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Error" - }, - "description": "A list of errors related to this occurrence of the problem.", - "nullable": true + "versionCardId": { + "type": "integer", + "description": "The document object version card id.", + "format": "int64" }, - "relatedInfo": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RelatedInfo" - }, - "description": "A list of additional information related to this occurrence of the problem.", - "nullable": true + "languageCardId": { + "type": "integer", + "description": "The document object language card id.", + "format": "int64" + }, + "sequence": { + "type": "integer", + "description": "The search result entry sort sequence.", + "format": "int32" } }, - "additionalProperties": {} + "additionalProperties": false, + "description": "Represents a search result entry." }, - "IshField": { + "SearchSortField": { "required": [ - "name" + "ishField" ], "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseSearchSortField" + } + ], "properties": { - "name": { - "minLength": 1, - "type": "string", - "description": "The name/label of the InfoShare field (e.g. FTITLE)." - }, - "level": { + "ishField": { "allOf": [ { - "$ref": "#/components/schemas/Level" + "$ref": "#/components/schemas/IshField" } ], - "description": "The level of the InfoShare field (e.g. logical, version, language).", - "nullable": true + "description": "The sorting field." } }, "additionalProperties": false, - "description": "Represents a field that contains information to access a field." + "description": "Represents a search order criteria." }, - "Level": { + "SearchSortOrder": { "enum": [ - "none", - "annotation", - "compute", - "data", - "detail", - "language", - "logical", - "object", - "progress", - "reply", - "version" + "ascending", + "descending" ], "type": "string", - "description": "Enumeration holding the visible InfoShare hierarchy levels." - }, - "Link": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Gets or sets the URL for this Trisoft.Utilities.WebApi.Links.Link.", - "nullable": true - }, - "rel": { - "type": "string", - "description": "Gets or sets the relation for this Trisoft.Utilities.WebApi.Links.Link.", - "nullable": true - }, - "type": { - "type": "string", - "description": "Gets or sets the HTTP method for this Trisoft.Utilities.WebApi.Links.Link.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Represents a HATEOAS link model." + "description": "Enumeration holding search sort order options." }, - "LinkType": { + "SearchVersionFilter": { "enum": [ - "contentLink", - "hyperLink", - "all" - ], - "type": "string", - "description": "Indicates which link fields must be used in the GetParents/GetChildren methods." - }, - "LovFieldValue": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/FieldValue" - } + "latest", + "all" ], - "properties": { - "value": { - "allOf": [ - { - "$ref": "#/components/schemas/LovValue" - } - ], - "description": "Represents an item in a value list.", - "nullable": true - } - }, - "additionalProperties": false + "type": "string", + "description": "Enumeration holding search version filter options." }, - "LovFilterFieldValue": { - "required": [ - "value" + "SelectedProperties": { + "enum": [ + "id", + "titleAndDescription" ], + "type": "string", + "description": "Enumeration holding the selected properties." + }, + "SendTranslationJobToTranslation": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/FilterFieldValue" - } - ], "properties": { - "value": { - "minItems": 1, + "requiredCurrentFields": { "type": "array", "items": { - "$ref": "#/components/schemas/SetLovValue" - } + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to update the Trisoft.InfoShare.WebApi.V30.TranslationJobs.Models.TranslationJob." } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Represents a send translation job for translation model." }, - "LovLikeFilterFieldValue": { + "SendTranslationJobToTranslationParameters": { "required": [ - "value" + "id" ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/FilterFieldValue" - } - ], "properties": { - "value": { + "id": { + "maxLength": 255, "minLength": 1, - "type": "string" + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the translation job." } }, - "additionalProperties": false - }, - "LovList": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseItem" - } - ], "additionalProperties": false, - "description": "Represents an item in a list of list of values." + "description": "The request object to send the translation job to translation by its identifier." }, - "LovValue": { + "SetBaseObject": { "required": [ "type" ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseItem" - } - ], "properties": { "type": { - "type": "string" - }, - "active": { - "type": "boolean", - "description": "The active value.", - "nullable": true + "type": "string", + "description": "The type of the current object.", + "readOnly": true } }, "additionalProperties": false, - "description": "Represents an item in a value list.", + "description": "Represents an object.", "discriminator": { "propertyName": "type", "mapping": { - "LovValue": "#/components/schemas/LovValue", - "FormFieldOperator": "#/components/schemas/FormFieldOperator", - "FullTextSearchFormFieldOperator": "#/components/schemas/FullTextSearchFormFieldOperator", - "MetadataFilterFormFieldOperator": "#/components/schemas/MetadataFilterFormFieldOperator" + "SetUser": "#/components/schemas/SetUser", + "SetUserRole": "#/components/schemas/SetUserRole", + "SetUserGroup": "#/components/schemas/SetUserGroup", + "SetTranslationJob": "#/components/schemas/SetTranslationJob", + "SetSetting": "#/components/schemas/SetSetting", + "SetPublication": "#/components/schemas/SetPublication", + "SetOutputFormat": "#/components/schemas/SetOutputFormat", + "SetManagedObject": "#/components/schemas/SetManagedObject", + "SetFolder": "#/components/schemas/SetFolder", + "SetElectronicDocumentType": "#/components/schemas/SetElectronicDocumentType", + "SetDocumentObject": "#/components/schemas/SetDocumentObject", + "SetBaseline": "#/components/schemas/SetBaseline", + "SetRevision": "#/components/schemas/SetRevision" } } }, - "Message": { + "SetBaseline": { "required": [ - "type" + "id" ], "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SetBaseObject" + } + ], "properties": { - "type": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", "type": "string", - "description": "The type of the current object.", - "nullable": true, - "readOnly": true - }, - "title": { + "description": "The identifier." + } + }, + "additionalProperties": false, + "description": "Represents a baseline." + }, + "SetBaselineEntry": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", "type": "string", - "description": "A short, human-readable summary of the event message.", - "nullable": true + "description": "The unique element name of the card on the logical level" }, - "detail": { + "version": { "type": "string", - "description": "A human-readable explanation specific to this occurrence of the event message.", + "description": "The version number of the version card.", "nullable": true }, - "severity": { + "source": { "allOf": [ { - "$ref": "#/components/schemas/SeverityLevel" + "$ref": "#/components/schemas/SetBaselineEntrySource" } ], - "description": "The severity level of the event message." - }, - "eventId": { - "type": "integer", - "description": "The identifier of the corresponding event.", - "format": "int32", - "nullable": true - }, - "eventName": { - "type": "string", - "description": "The name of the corresponding event.", - "nullable": true - }, - "logId": { - "type": "integer", - "description": "The identifier of the corresponding entry in the log.", - "format": "int64", - "nullable": true + "description": "Who or what is responsible for the current version number of the object in the baseline.", + "default": "manual" }, - "relatedInfo": { - "type": "array", - "items": { - "$ref": "#/components/schemas/RelatedInfo" - }, - "description": "A list of additional information related to this occurrence of the event message.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "An event message.", - "discriminator": { - "propertyName": "type", - "mapping": { - "Message": "#/components/schemas/Message", - "Error": "#/components/schemas/Error" - } - } - }, - "MetadataFilterFormFieldOperator": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/FormFieldOperator" - } - ], - "properties": { - "operator": { + "author": { "allOf": [ { - "$ref": "#/components/schemas/MetadataFilterOperator" + "$ref": "#/components/schemas/SetUser" } ], - "description": "Search operator that will be used in search operations.", + "description": "The Author of the object.", "nullable": true } }, "additionalProperties": false, - "description": "Represents a metadata filter operator on a Trisoft.InfoShare.WebApi.V30.Models.Forms.FormField." + "description": "Represents a baseline entry." }, - "MetadataFilterOperator": { + "SetBaselineEntrySource": { "enum": [ - "equal", - "notEqual", - "in", - "notIn", - "like", - "greaterThan", - "lessThan", - "greaterThanOrEqual", - "lessThanOrEqual", - "between", - "empty", - "notEmpty", - "ciLike" + "manual", + "saveManual", + "saveLatestAvailable", + "saveLatestReleased", + "saveByBaseline", + "saveCandidate", + "saveFirstVersion", + "saveCopy" ], "type": "string", - "description": "Specifies the possible filter operators that can be used by {FilterFieldValue}." - }, - "MoveFolder": { - "type": "object", - "properties": { - "folderId": { - "minimum": 0, - "exclusiveMinimum": true, - "type": "integer", - "description": "The card id of the folder that should be moved.", - "format": "int64" - }, - "destinationId": { - "minimum": 0, - "exclusiveMinimum": true, - "type": "integer", - "description": "The card id of the destination folder.", - "format": "int64" - } - }, - "additionalProperties": false, - "description": "Represents a move folder model." + "description": "Enumeration holding limited set of values for the BaselineEntry source during save operation." }, - "MoveObject": { + "SetCardFieldValue": { "required": [ - "logicalId" + "ishField" ], - "type": "object", - "properties": { - "logicalId": { - "minLength": 1, - "type": "string", - "description": "The logical identifier of the object that should be moved." - }, - "destinationId": { - "minimum": 0, - "exclusiveMinimum": true, - "type": "integer", - "description": "The card identifier of the destination folder.", - "format": "int64" - } - }, - "additionalProperties": false, - "description": "Represents a move object model." - }, - "MultiCardFieldValue": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/FieldValue" + "$ref": "#/components/schemas/SetFieldValue" } ], "properties": { + "ishField": { + "allOf": [ + { + "$ref": "#/components/schemas/IshField" + } + ], + "description": "The field with information the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." + }, "value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BaseObject" - }, + "allOf": [ + { + "$ref": "#/components/schemas/SetBaseObject" + } + ], + "description": "The field value.", "nullable": true } }, "additionalProperties": false }, - "MultiDateTimeFieldValue": { + "SetDateTimeFieldValue": { + "required": [ + "ishField" + ], "type": "object", "allOf": [ { - "$ref": "#/components/schemas/FieldValue" + "$ref": "#/components/schemas/SetFieldValue" } ], "properties": { + "ishField": { + "allOf": [ + { + "$ref": "#/components/schemas/IshField" + } + ], + "description": "The field with information the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." + }, "value": { - "type": "array", - "items": { - "type": "string", - "format": "date-time" - }, + "type": "string", + "description": "The field value.", + "format": "date-time", "nullable": true } }, "additionalProperties": false }, - "MultiLovFieldValue": { + "SetDocumentObject": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/FieldValue" + "$ref": "#/components/schemas/SetManagedObject" } ], - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LovValue" - }, - "nullable": true - } - }, - "additionalProperties": false + "additionalProperties": false, + "description": "Represents a document.\r\n\"SetDocumentObject\" must be identified by only one identifier either \"LogicalId\", \"VersionCardId\" or \"LanguageCardId\". " }, - "MultiNumberFieldValue": { + "SetElectronicDocumentType": { + "required": [ + "id" + ], "type": "object", "allOf": [ { - "$ref": "#/components/schemas/FieldValue" + "$ref": "#/components/schemas/SetBaseObject" } ], "properties": { - "value": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier." + } + }, + "additionalProperties": false, + "description": "Represents a edt." + }, + "SetFieldTag": { + "required": [ + "ishField" + ], + "type": "object", + "properties": { + "tags": { "type": "array", "items": { - "type": "number", - "format": "double" + "$ref": "#/components/schemas/SetTag" }, - "nullable": true + "description": "The list of tags." + }, + "ishField": { + "allOf": [ + { + "$ref": "#/components/schemas/IshField" + } + ], + "description": "The field with information the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Represents a field tag that contains information to access a field, and the tags associated with the field." }, - "MultiStringFieldValue": { + "SetFieldValue": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the current object.", + "readOnly": true + } + }, + "additionalProperties": false, + "description": "Represents a field value that contains information to access a field, and the value associated with the field.", + "discriminator": { + "propertyName": "type", + "mapping": { + "SetCardFieldValue": "#/components/schemas/SetCardFieldValue", + "SetDateTimeFieldValue": "#/components/schemas/SetDateTimeFieldValue", + "SetLovFieldValue": "#/components/schemas/SetLovFieldValue", + "SetMultiCardFieldValue": "#/components/schemas/SetMultiCardFieldValue", + "SetMultiDateTimeFieldValue": "#/components/schemas/SetMultiDateTimeFieldValue", + "SetMultiLovFieldValue": "#/components/schemas/SetMultiLovFieldValue", + "SetMultiNumberFieldValue": "#/components/schemas/SetMultiNumberFieldValue", + "SetMultiStringFieldValue": "#/components/schemas/SetMultiStringFieldValue", + "SetMultiTagFieldValue": "#/components/schemas/SetMultiTagFieldValue", + "SetMultiVersionFieldValue": "#/components/schemas/SetMultiVersionFieldValue", + "SetNumberFieldValue": "#/components/schemas/SetNumberFieldValue", + "SetObjectFieldValue": "#/components/schemas/SetObjectFieldValue", + "SetStringFieldValue": "#/components/schemas/SetStringFieldValue", + "SetTagFieldValue": "#/components/schemas/SetTagFieldValue", + "SetVersionFieldValue": "#/components/schemas/SetVersionFieldValue" + } + } + }, + "SetFolder": { + "required": [ + "id" + ], "type": "object", "allOf": [ { - "$ref": "#/components/schemas/FieldValue" + "$ref": "#/components/schemas/SetBaseObject" } ], "properties": { - "value": { - "type": "array", - "items": { - "type": "string" - }, - "nullable": true + "id": { + "minLength": 1, + "type": "string", + "description": "The identifier." } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Represents a folder." }, - "MultiTagFieldValue": { + "SetLovFieldValue": { + "required": [ + "ishField" + ], "type": "object", "allOf": [ { - "$ref": "#/components/schemas/FieldValue" + "$ref": "#/components/schemas/SetFieldValue" } ], "properties": { + "ishField": { + "allOf": [ + { + "$ref": "#/components/schemas/IshField" + } + ], + "description": "The field with information the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." + }, "value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Tag" - }, + "allOf": [ + { + "$ref": "#/components/schemas/SetLovValue" + } + ], + "description": "The field value.", "nullable": true } }, "additionalProperties": false }, - "MultiVersionFieldValue": { + "SetLovValue": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier." + } + }, + "additionalProperties": false, + "description": "Represents a settable item in a value list." + }, + "SetManagedObject": { + "required": [ + "type" + ], "type": "object", "allOf": [ { - "$ref": "#/components/schemas/FieldValue" + "$ref": "#/components/schemas/SetBaseObject" } ], "properties": { - "value": { - "type": "array", - "items": { - "type": "string" - }, + "type": { + "type": "string" + }, + "languageCardId": { + "type": "integer", + "description": "The language card identifier.", + "format": "int64", + "nullable": true + }, + "versionCardId": { + "type": "integer", + "description": "The version card identifier.", + "format": "int64", + "nullable": true + }, + "logicalId": { + "type": "string", + "description": "The logical identifier.", "nullable": true } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Represents an object to set a Document object or Publication.", + "discriminator": { + "propertyName": "type", + "mapping": { + "SetPublication": "#/components/schemas/SetPublication", + "SetDocumentObject": "#/components/schemas/SetDocumentObject" + } + } }, - "NextStatus": { + "SetMultiCardFieldValue": { + "required": [ + "ishField" + ], "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SetFieldValue" + } + ], "properties": { - "value": { + "ishField": { "allOf": [ { - "$ref": "#/components/schemas/LovValue" + "$ref": "#/components/schemas/IshField" } ], - "description": "The value of the next status element in the report configuration XML." + "description": "The field with information the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." + }, + "value": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetBaseObject" + }, + "description": "The field value." } }, - "additionalProperties": false, - "description": "Represents next status element in the report configuration XML." + "additionalProperties": false }, - "NumberFieldValue": { + "SetMultiDateTimeFieldValue": { + "required": [ + "ishField" + ], "type": "object", "allOf": [ { - "$ref": "#/components/schemas/FieldValue" + "$ref": "#/components/schemas/SetFieldValue" } ], "properties": { + "ishField": { + "allOf": [ + { + "$ref": "#/components/schemas/IshField" + } + ], + "description": "The field with information the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." + }, "value": { - "type": "number", - "format": "double", - "nullable": true + "type": "array", + "items": { + "type": "string", + "format": "date-time" + }, + "description": "The field value." } }, "additionalProperties": false }, - "NumberFilterFieldValue": { + "SetMultiLovFieldValue": { "required": [ - "value" + "ishField" ], "type": "object", "allOf": [ { - "$ref": "#/components/schemas/FilterFieldValue" + "$ref": "#/components/schemas/SetFieldValue" } ], "properties": { + "ishField": { + "allOf": [ + { + "$ref": "#/components/schemas/IshField" + } + ], + "description": "The field with information the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." + }, "value": { - "minItems": 1, "type": "array", "items": { - "type": "number", - "format": "double" - } + "$ref": "#/components/schemas/SetLovValue" + }, + "description": "The field value." } }, "additionalProperties": false }, - "NumberSearchFieldValue": { + "SetMultiNumberFieldValue": { "required": [ - "value" + "ishField" ], "type": "object", "allOf": [ { - "$ref": "#/components/schemas/SearchFieldValue" + "$ref": "#/components/schemas/SetFieldValue" } ], "properties": { + "ishField": { + "allOf": [ + { + "$ref": "#/components/schemas/IshField" + } + ], + "description": "The field with information the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." + }, "value": { - "minItems": 1, "type": "array", "items": { "type": "number", "format": "double" }, - "description": "Collection of values to search for." - } - }, - "additionalProperties": false, - "description": "Represents search field value of type System.Collections.Generic.IList`1." - }, - "ObjectFieldValue": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/FieldValue" - } - ], - "properties": { - "value": { - "nullable": true + "description": "The field value." } }, "additionalProperties": false }, - "OrSearchExpression": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/GroupSearchExpression" - } + "SetMultiStringFieldValue": { + "required": [ + "ishField" ], - "additionalProperties": false, - "description": "Represents collection of search expression to be evaluated with OR logical operator." - }, - "OutputFormat": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/BaseObject" + "$ref": "#/components/schemas/SetFieldValue" } ], - "additionalProperties": false, - "description": "Represents an output format." - }, - "PreferenceItem": { - "required": [ - "name" - ], - "type": "object", "properties": { - "name": { - "minLength": 1, - "type": "string", - "description": "The name of the preference item" + "ishField": { + "allOf": [ + { + "$ref": "#/components/schemas/IshField" + } + ], + "description": "The field with information the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." }, "value": { - "type": "string", - "description": "The value of the preference item", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Represents user preference item" - }, - "PreferenceSet": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The Name of the preference set" - }, - "preferenceItems": { "type": "array", "items": { - "$ref": "#/components/schemas/PreferenceItem" + "type": "string" }, - "description": "The list of Trisoft.InfoShare.WebApi.V30.Users.Models.PreferenceItem contained in theis Preference set", - "nullable": true + "description": "The field value." } }, - "additionalProperties": false, - "description": "Represents user preference set" + "additionalProperties": false }, - "ProblemDetails": { + "SetMultiTagFieldValue": { "required": [ - "type" + "ishField" ], - "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": {}, - "discriminator": { - "propertyName": "type", - "mapping": { - "ProblemDetails": "#/components/schemas/ProblemDetails", - "InfoShareProblemDetails": "#/components/schemas/InfoShareProblemDetails" - } - } - }, - "Publication": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/BaseObject" + "$ref": "#/components/schemas/SetFieldValue" } ], "properties": { - "versionCardId": { - "type": "integer", - "description": "The version card identifier.", - "format": "int64", - "nullable": true - }, - "languageCardId": { - "type": "integer", - "description": "The language card identifier.", - "format": "int64", - "nullable": true - }, - "logicalId": { - "type": "string", - "description": "The logical identifier." - }, - "version": { - "type": "string", - "description": "The version.", - "nullable": true - }, - "outputFormatId": { - "type": "string", - "description": "The output format identifier.", - "nullable": true + "ishField": { + "allOf": [ + { + "$ref": "#/components/schemas/IshField" + } + ], + "description": "The field with information the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." }, - "languageCombinationIds": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The language identifier combination.", - "nullable": true - } - }, - "additionalProperties": false, - "description": "Represents a publication." - }, - "PublishPublication": { - "type": "object", - "properties": { - "requiredCurrentFields": { + "value": { "type": "array", "items": { - "$ref": "#/components/schemas/SetFieldValue" + "$ref": "#/components/schemas/SetTag" }, - "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to publish the Trisoft.InfoShare.WebApi.V30.Publications.Models.Publication.", - "nullable": true + "description": "The field value." } }, - "additionalProperties": false, - "description": "Represents a publish model for publication." + "additionalProperties": false }, - "RelatedInfo": { + "SetMultiVersionFieldValue": { "required": [ - "type" - ], - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of the current object.", - "nullable": true, - "readOnly": true - } - }, - "additionalProperties": false, - "description": "A list of additional information.", - "discriminator": { - "propertyName": "type", - "mapping": { - "User": "#/components/schemas/User", - "UserGroup": "#/components/schemas/UserGroup", - "TranslationObject": "#/components/schemas/TranslationObject", - "Setting": "#/components/schemas/Setting", - "SearchObject": "#/components/schemas/SearchObject", - "Publication": "#/components/schemas/Publication", - "BaseItem": "#/components/schemas/BaseItem", - "BaseObject": "#/components/schemas/BaseObject", - "LovList": "#/components/schemas/LovList", - "LovValue": "#/components/schemas/LovValue", - "OutputFormat": "#/components/schemas/OutputFormat", - "RevisionInfo": "#/components/schemas/RevisionInfo", - "Tag": "#/components/schemas/Tag", - "FormFieldOperator": "#/components/schemas/FormFieldOperator", - "FullTextSearchFormFieldOperator": "#/components/schemas/FullTextSearchFormFieldOperator", - "MetadataFilterFormFieldOperator": "#/components/schemas/MetadataFilterFormFieldOperator", - "FieldValue": "#/components/schemas/FieldValue", - "CardFieldValue": "#/components/schemas/CardFieldValue", - "DateTimeFieldValue": "#/components/schemas/DateTimeFieldValue", - "LovFieldValue": "#/components/schemas/LovFieldValue", - "MultiCardFieldValue": "#/components/schemas/MultiCardFieldValue", - "MultiDateTimeFieldValue": "#/components/schemas/MultiDateTimeFieldValue", - "MultiLovFieldValue": "#/components/schemas/MultiLovFieldValue", - "MultiNumberFieldValue": "#/components/schemas/MultiNumberFieldValue", - "MultiStringFieldValue": "#/components/schemas/MultiStringFieldValue", - "MultiTagFieldValue": "#/components/schemas/MultiTagFieldValue", - "MultiVersionFieldValue": "#/components/schemas/MultiVersionFieldValue", - "NumberFieldValue": "#/components/schemas/NumberFieldValue", - "ObjectFieldValue": "#/components/schemas/ObjectFieldValue", - "StringFieldValue": "#/components/schemas/StringFieldValue", - "TagFieldValue": "#/components/schemas/TagFieldValue", - "VersionFieldValue": "#/components/schemas/VersionFieldValue", - "Folder": "#/components/schemas/Folder", - "ElectronicDocumentType": "#/components/schemas/ElectronicDocumentType", - "DocumentObject": "#/components/schemas/DocumentObject", - "DocumentObjectLink": "#/components/schemas/DocumentObjectLink", - "DocumentObjectParseError": "#/components/schemas/DocumentObjectParseError", - "RevisionHistoryItem": "#/components/schemas/RevisionHistoryItem", - "Baseline": "#/components/schemas/Baseline", - "SchemaValidationError": "#/components/schemas/SchemaValidationError" - } - } - }, - "ReleasePublication": { + "ishField" + ], "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SetFieldValue" + } + ], "properties": { - "requiredCurrentFields": { + "ishField": { + "allOf": [ + { + "$ref": "#/components/schemas/IshField" + } + ], + "description": "The field with information the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." + }, + "value": { "type": "array", "items": { - "$ref": "#/components/schemas/SetFieldValue" + "type": "string" }, - "description": "Fields that will be used in concurrency check.", - "nullable": true + "description": "The field value." } }, - "additionalProperties": false, - "description": "Represents a release model for publication." + "additionalProperties": false }, - "RemoveShortcut": { + "SetMyPreferencesParameters": { "required": [ - "logicalId" + "setName" ], "type": "object", "properties": { - "logicalId": { + "setName": { + "maxLength": 255, "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", "type": "string", - "description": "Specify logical identifier of the document object or publication for which to remove a shortcut." + "description": "The name of the preference set to be updated." } }, "additionalProperties": false, - "description": "Represents logical identifier model." + "description": "The request object to set current user preferences that match the criteria given in the properties." }, - "ReportSettings": { + "SetNumberFieldValue": { "required": [ - "type" + "ishField" ], "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SetFieldValue" + } + ], "properties": { - "type": { - "type": "string" + "ishField": { + "allOf": [ + { + "$ref": "#/components/schemas/IshField" + } + ], + "description": "The field with information the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." }, - "baselineResolutions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LovValue" - }, - "description": "List of baseline resolution in the report configuration XML.", + "value": { + "type": "number", + "description": "The field value.", + "format": "double", "nullable": true } }, - "additionalProperties": false, - "description": "Represents the report configuration.", - "discriminator": { - "propertyName": "type", - "mapping": { - "TranslationReportSettings": "#/components/schemas/TranslationReportSettings", - "WorkflowReportSettings": "#/components/schemas/WorkflowReportSettings" - } - } + "additionalProperties": false }, - "RequestedField": { + "SetObjectFieldValue": { "required": [ "ishField" ], "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SetFieldValue" + } + ], "properties": { "ishField": { "allOf": [ @@ -13403,1298 +31175,1632 @@ "$ref": "#/components/schemas/IshField" } ], - "description": "The field with information about the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." + "description": "The field with information the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." + }, + "value": { + "description": "The field value.", + "nullable": true } }, - "additionalProperties": false, - "description": "Represents a requested metadata field." + "additionalProperties": false }, - "RevisionHistoryItem": { + "SetOutputFormat": { + "required": [ + "id" + ], "type": "object", "allOf": [ { - "$ref": "#/components/schemas/BaseObject" + "$ref": "#/components/schemas/SetBaseObject" } ], "properties": { - "sequence": { - "type": "integer", - "description": "The sequence number of a revision history item.", - "format": "int64" - }, - "modifiedOn": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", "type": "string", - "description": "The datetime of the modification on the document object.", - "format": "date-time" - }, - "modifiedBy": { - "allOf": [ - { - "$ref": "#/components/schemas/User" - } - ], - "description": "The user who modified the document object." + "description": "The identifier." + } + }, + "additionalProperties": false, + "description": "Represents an OutputFormat." + }, + "SetPreferenceItem": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", + "type": "string", + "description": "The name of the preference item." }, - "status": { - "allOf": [ - { - "$ref": "#/components/schemas/LovValue" - } - ], - "description": "The status of the document object.", + "value": { + "type": "string", + "description": "The value of the preference item.", "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents user preference item." + }, + "SetPreferencesParameters": { + "required": [ + "id", + "setName" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the user." }, - "isRemoved": { - "type": "boolean", - "description": "Indicates whether the revision is removed from the Repository.", - "default": false + "setName": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9._-]*$", + "type": "string", + "description": "The name of the preference set to be updated." } }, "additionalProperties": false, - "description": "Represents a revision history item." + "description": "The request object to set user preferences that match the criteria given in the properties." }, - "RevisionInfo": { + "SetPublication": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/BaseObject" + "$ref": "#/components/schemas/SetManagedObject" } ], "additionalProperties": false, - "description": "Represents a revision info." + "description": "Represents a publication.\r\n\"SetPublication\" must be identified by only one identifier either \"LogicalId\", \"VersionCardId\" or \"LanguageCardId\". " }, - "SchemaValidationError": { + "SetRevision": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/RelatedInfo" + "$ref": "#/components/schemas/SetBaseObject" } ], "properties": { - "path": { + "id": { + "maxLength": 100, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", "type": "string", - "description": "Path to the schema where validation failed.", + "description": "The identifier.", "nullable": true } }, "additionalProperties": false, - "description": "Class representing a schema validation error." + "description": "Represents a revision." }, - "ScoreSearchSortField": { + "SetSetting": { + "required": [ + "id" + ], "type": "object", "allOf": [ { - "$ref": "#/components/schemas/BaseSearchSortField" + "$ref": "#/components/schemas/SetBaseObject" } ], - "additionalProperties": false, - "description": "Represents a search order criteria based on SolrLucene score." - }, - "SearchExpression": { - "required": [ - "type" - ], - "type": "object", "properties": { - "type": { + "id": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", "type": "string", - "readOnly": true + "description": "The identifier." } }, "additionalProperties": false, - "description": "Represents base search expressions.", - "discriminator": { - "propertyName": "type", - "mapping": { - "AndSearchExpression": "#/components/schemas/AndSearchExpression", - "AnywhereSearchFieldValue": "#/components/schemas/AnywhereSearchFieldValue", - "DateTimeSearchFieldValue": "#/components/schemas/DateTimeSearchFieldValue", - "GroupSearchExpression": "#/components/schemas/GroupSearchExpression", - "NumberSearchFieldValue": "#/components/schemas/NumberSearchFieldValue", - "OrSearchExpression": "#/components/schemas/OrSearchExpression", - "SearchFieldValue": "#/components/schemas/SearchFieldValue", - "StringSearchFieldValue": "#/components/schemas/StringSearchFieldValue" - } - } + "description": "Represents a setting." }, - "SearchFieldValue": { + "SetStringFieldValue": { "required": [ - "type" + "ishField" ], "type": "object", "allOf": [ { - "$ref": "#/components/schemas/SearchExpression" + "$ref": "#/components/schemas/SetFieldValue" } ], "properties": { - "type": { - "type": "string" - }, - "fullTextSearchOperator": { - "allOf": [ - { - "$ref": "#/components/schemas/FullTextSearchOperator" - } - ], - "description": "The search operator." - }, "ishField": { "allOf": [ { "$ref": "#/components/schemas/IshField" } ], - "description": "The search field." + "description": "The field with information the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." + }, + "value": { + "type": "string", + "description": "The field value.", + "nullable": true } }, - "additionalProperties": false, - "description": "Represents a search field value.", - "discriminator": { - "propertyName": "type", - "mapping": { - "DateTimeSearchFieldValue": "#/components/schemas/DateTimeSearchFieldValue", - "NumberSearchFieldValue": "#/components/schemas/NumberSearchFieldValue", - "StringSearchFieldValue": "#/components/schemas/StringSearchFieldValue" - } - } + "additionalProperties": false }, - "SearchObject": { + "SetTag": { + "required": [ + "id" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^[a-zA-Z0-9+!:|&=\\\\/#@%?~._-]+$", + "type": "string", + "description": "The identifier." } - ], + }, "additionalProperties": false, - "description": "Represents a search object." + "description": "Represents a tag." }, - "SearchObjectTypeFilter": { - "enum": [ - "any", - "illustration", - "library", - "map", - "other", - "topic" + "SetTagFieldValue": { + "required": [ + "ishField" ], - "type": "string", - "description": "Enumeration holding search object type options." - }, - "SearchRequest": { "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SetFieldValue" + } + ], "properties": { - "expression": { + "ishField": { "allOf": [ { - "$ref": "#/components/schemas/GroupSearchExpression" + "$ref": "#/components/schemas/IshField" } ], - "description": "Search expressions group.\r\nUse Trisoft.InfoShare.WebApi.V30.Search.Models.AnywhereSearchFieldValue for filtering anywhere." - }, - "sortFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/BaseSearchSortField" - }, - "description": "Represents list of fields to be used to sort the search result.\r\nUse Trisoft.InfoShare.WebApi.V30.Search.Models.ScoreSearchSortField for sorting on the SolrLucene score. Trisoft.InfoShare.WebApi.V30.Search.Models.ScoreSearchSortField sort fields are used for SolrLucene by default.", - "nullable": true + "description": "The field with information the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." }, - "versionFilter": { + "value": { "allOf": [ { - "$ref": "#/components/schemas/SearchVersionFilter" + "$ref": "#/components/schemas/SetTag" } ], - "description": "Search version filter options." - }, - "objectTypes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SearchObjectTypeFilter" - }, - "description": "Search object type filter." - }, - "languages": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The languages list to be be included in the search result.", - "nullable": true - }, - "resolutions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The resolutions list to be be included in the search result.", + "description": "The field value.", "nullable": true - }, - "sizeLimit": { - "type": "integer", - "description": "The maximum number of objects to return.", - "format": "int32" } }, - "additionalProperties": false, - "description": "Represents search request criteria to find document objects." + "additionalProperties": false }, - "SearchResponse": { + "SetTranslationJob": { + "required": [ + "id" + ], "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SetBaseObject" + } + ], "properties": { - "totalHitsFound": { - "type": "integer", - "description": "The total number of hits for the current search.", - "format": "int64" - }, - "entries": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SearchResultEntry" - }, - "description": "Collection of search result entries." + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier." } }, "additionalProperties": false, - "description": "Represents the search response." + "description": "Represents a translation job." }, - "SearchResultEntry": { + "SetTranslationWorkflow": { + "required": [ + "reference" + ], "type": "object", "properties": { - "documentObjectType": { + "reference": { + "minLength": 1, + "type": "string", + "description": "The workflow Reference of the external translation system (ex. world server '1100')." + }, + "language": { "allOf": [ { - "$ref": "#/components/schemas/DocumentObjectType" + "$ref": "#/components/schemas/SetLovValue" } ], - "description": "The document object type." - }, - "logicalId": { - "type": "string", - "description": "The document object logical id." - }, - "versionCardId": { - "type": "integer", - "description": "The document object version card id.", - "format": "int64" - }, - "languageCardId": { - "type": "integer", - "description": "The document object language card id.", - "format": "int64" - }, - "sequence": { - "type": "integer", - "description": "The search result entry sort sequence.", - "format": "int32" + "description": "The workflow language." } }, "additionalProperties": false, - "description": "Represents a search result entry." + "description": "Represents a workflow." }, - "SearchSortField": { + "SetUser": { "required": [ - "ishField" + "id" ], "type": "object", "allOf": [ { - "$ref": "#/components/schemas/BaseSearchSortField" + "$ref": "#/components/schemas/SetBaseObject" } ], "properties": { - "ishField": { - "allOf": [ - { - "$ref": "#/components/schemas/IshField" - } - ], - "description": "The sorting field." + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier." } }, "additionalProperties": false, - "description": "Represents a search order criteria." - }, - "SearchSortOrder": { - "enum": [ - "ascending", - "descending" - ], - "type": "string", - "description": "Enumeration holding search sort order options." + "description": "Represents a user." }, - "SearchVersionFilter": { - "enum": [ - "latest", - "all" + "SetUserGroup": { + "required": [ + "id" ], - "type": "string", - "description": "Enumeration holding search version filter options." - }, - "SelectedProperties": { - "enum": [ - "id", - "titleAndDescription" + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SetBaseObject" + } ], - "type": "string", - "description": "Enumeration holding the selected properties." + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier." + } + }, + "additionalProperties": false, + "description": "Represents a user group." }, - "SetBaseItem": { + "SetUserRole": { "required": [ - "type" + "id" ], "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SetBaseObject" + } + ], "properties": { - "type": { - "type": "string", - "description": "The type of the current object.", - "readOnly": true - }, "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", "type": "string", "description": "The identifier." } }, "additionalProperties": false, - "description": "Represents an item.", - "discriminator": { - "propertyName": "type", - "mapping": { - "SetLovValue": "#/components/schemas/SetLovValue", - "SetTag": "#/components/schemas/SetTag" + "description": "Represents a user role." + }, + "SetVersionFieldValue": { + "required": [ + "ishField" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/SetFieldValue" } - } + ], + "properties": { + "ishField": { + "allOf": [ + { + "$ref": "#/components/schemas/IshField" + } + ], + "description": "The field with information the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." + }, + "value": { + "type": "string", + "description": "The field value.", + "nullable": true + } + }, + "additionalProperties": false }, - "SetBaseline": { + "Setting": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/SetBaseObject" + "$ref": "#/components/schemas/BaseObject" } ], "additionalProperties": false, - "description": "Represents a baseline." + "description": "Represents a setting." }, - "SetBaseObject": { - "required": [ - "type" - ], + "SettingsFieldDefinition": { "type": "object", "properties": { - "type": { + "name": { + "type": "string", + "description": "Gets the element name of the field (e.g. CREATED-ON)", + "nullable": true + }, + "title": { + "type": "string", + "description": "Gets the label of the field (e.g. Creation date)", + "nullable": true + }, + "description": { + "type": "string", + "description": "Gets the description of the field (e.g. \"Used on all cards to indicate the date that the object was created\")", + "nullable": true + }, + "fieldType": { + "allOf": [ + { + "$ref": "#/components/schemas/FieldType" + } + ], + "description": "Gets the type of the field" + }, + "level": { + "allOf": [ + { + "$ref": "#/components/schemas/Level" + } + ], + "description": "Gets the InfoShare level of the field" + }, + "isMandatory": { + "type": "boolean", + "description": "Is the field mandatory or not?" + }, + "isMultiValue": { + "type": "boolean", + "description": "Is the field multi value or not?" + }, + "allowOnRead": { + "type": "boolean", + "description": "Can the field be requested during a \"Read\" action (GetMetadata, RetrieveMetadata, Find,...)?" + }, + "allowOnCreate": { + "type": "boolean", + "description": "Can the field be set via the metadata during a \"Create\" action?" + }, + "allowOnUpdate": { + "type": "boolean", + "description": "Can the field be updated via the metadata during a \"Update\" action (Update, SetMetadata,...)?" + }, + "allowOnSearch": { + "type": "boolean", + "description": "Can the field be requested during a search?" + }, + "allowOnSmartTagging": { + "type": "boolean", + "description": "Can the field be requested during a \"SmartTagging\" action (GetMetadata, RetrieveMetadata, Find,...)?" + }, + "isSystem": { + "type": "boolean", + "description": "Is the field a system field or not?" + }, + "isBasic": { + "type": "boolean", + "description": "Is the field a basic field (e.g. DOC-LANGUAGE) or not (e.g. FISHLINKS)?" + }, + "isDescriptive": { + "type": "boolean", + "description": "Is this field necessary for full describing the object?" + }, + "dataSource": { "type": "string", - "description": "The type of the current object.", - "readOnly": true + "description": "Gets the data source of the Tag type field.", + "nullable": true }, - "id": { + "lovReference": { "type": "string", - "description": "The identifier." + "description": "Gets the reference of the Lov type field.", + "nullable": true + }, + "cardReferences": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FieldCardReference" + }, + "description": "Gets the references of the Card type field.", + "nullable": true } }, "additionalProperties": false, - "description": "Represents an object.", - "discriminator": { - "propertyName": "type", - "mapping": { - "SetUser": "#/components/schemas/SetUser", - "SetUserGroup": "#/components/schemas/SetUserGroup", - "SetSetting": "#/components/schemas/SetSetting", - "SetPublication": "#/components/schemas/SetPublication", - "SetFolder": "#/components/schemas/SetFolder", - "SetElectronicDocumentType": "#/components/schemas/SetElectronicDocumentType", - "SetDocumentObject": "#/components/schemas/SetDocumentObject", - "SetBaseline": "#/components/schemas/SetBaseline" - } - } + "description": "Represents a settings field definition." }, - "SetCardFieldValue": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/SetFieldValue" - } + "SeverityLevel": { + "enum": [ + "error", + "warning", + "message", + "info" ], + "type": "string", + "description": "List of Severity Levels" + }, + "Status": { + "type": "object", "properties": { "value": { "allOf": [ { - "$ref": "#/components/schemas/SetBaseObject" + "$ref": "#/components/schemas/LovValue" } ], - "description": "Represents an object.", + "description": "The value of the status element in the report configuration XML." + }, + "nextStatuses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/NextStatus" + }, + "description": "List of the possible next statuses.", "nullable": true } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Represents status element in the report configuration XML." }, - "SetDateTimeFieldValue": { + "StatusDefinition": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/SetFieldValue" - } - ], "properties": { - "value": { - "type": "string", - "format": "date-time", - "nullable": true + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/LovValue" + } + ], + "description": "Status: A Trisoft.InfoShare.WebApi.V30.Models.LovValue describing the status value of the definition." + }, + "statusType": { + "allOf": [ + { + "$ref": "#/components/schemas/StatusType" + } + ], + "description": "StatusType: Type of the status described in Trisoft.InfoShare.WebApi.V30.Workflows.Models.StatusDefinition.Status." } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Represents an item in a value list." }, - "SetDocumentObject": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/SetBaseObject" - } + "StatusFilter": { + "enum": [ + "all", + "latestReleased", + "draftOrLatestReleased", + "allReleased" ], + "type": "string", + "description": "Allows explicit filtering on the language level status field.\r\n\r\nDepending on which status filter is specified, the objects with following status types can be returned:\r\n
Status filterReturned status types
AllAll status types
LatestReleasedLatest released excluding out-of-date
DraftOrLatestReleasedDraft and latest released excluding out-of-date
AllReleasedAll released including out-of-date
" + }, + "StatusGroup": { + "type": "object", "properties": { - "languageCardId": { - "type": "integer", - "description": "The language card identifier.", - "format": "int64", - "nullable": true - }, - "versionCardId": { - "type": "integer", - "description": "The version card identifier.", - "format": "int64", - "nullable": true - }, - "logicalId": { + "title": { "type": "string", - "description": "The logical identifier." + "description": "The status group title." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Status" + }, + "description": "List of the possible statuses." } }, "additionalProperties": false, - "description": "Represents a document." - }, - "SetElectronicDocumentType": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/SetBaseObject" - } - ], - "additionalProperties": false, - "description": "Represents a edt." + "description": "Represents status group element in the report configuration XML." }, - "SetFieldValue": { + "StatusStatistics": { "required": [ "type" ], "type": "object", "properties": { "type": { - "type": "string", - "description": "The type of the current object.", - "readOnly": true + "type": "string" }, - "ishField": { - "allOf": [ - { - "$ref": "#/components/schemas/IshField" - } - ], - "description": "The field with information the name/label of the InfoShare field (e.g. FTITLE) and the level of the InfoShare field (e.g. logical, version, lng)." + "sourceLanguageStatusGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusGroup" + }, + "description": "The source language list of status groups." } }, "additionalProperties": false, - "description": "Represents a field value that contains information to access a field, and the value associated with the field.", + "description": "Represents statistics element in the report configuration XML.", "discriminator": { "propertyName": "type", "mapping": { - "SetCardFieldValue": "#/components/schemas/SetCardFieldValue", - "SetDateTimeFieldValue": "#/components/schemas/SetDateTimeFieldValue", - "SetLovFieldValue": "#/components/schemas/SetLovFieldValue", - "SetMultiCardFieldValue": "#/components/schemas/SetMultiCardFieldValue", - "SetMultiDateTimeFieldValue": "#/components/schemas/SetMultiDateTimeFieldValue", - "SetMultiLovFieldValue": "#/components/schemas/SetMultiLovFieldValue", - "SetMultiNumberFieldValue": "#/components/schemas/SetMultiNumberFieldValue", - "SetMultiStringFieldValue": "#/components/schemas/SetMultiStringFieldValue", - "SetMultiTagFieldValue": "#/components/schemas/SetMultiTagFieldValue", - "SetMultiVersionFieldValue": "#/components/schemas/SetMultiVersionFieldValue", - "SetNumberFieldValue": "#/components/schemas/SetNumberFieldValue", - "SetObjectFieldValue": "#/components/schemas/SetObjectFieldValue", - "SetStringFieldValue": "#/components/schemas/SetStringFieldValue", - "SetTagFieldValue": "#/components/schemas/SetTagFieldValue", - "SetVersionFieldValue": "#/components/schemas/SetVersionFieldValue" + "StatusStatistics": "#/components/schemas/StatusStatistics", + "TranslationStatusStatistics": "#/components/schemas/TranslationStatusStatistics" } } }, - "SetFolder": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/SetBaseObject" - } + "StatusType": { + "enum": [ + "draft", + "released" ], - "additionalProperties": false, - "description": "Represents a folder." + "type": "string", + "description": "Enumeration with the possible status types" }, - "SetLovFieldValue": { + "StringFieldValue": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/SetFieldValue" + "$ref": "#/components/schemas/FieldValue" } ], "properties": { "value": { - "allOf": [ - { - "$ref": "#/components/schemas/SetLovValue" - } - ], - "description": "Represents a settable item in a value list.", + "type": "string", "nullable": true } }, "additionalProperties": false }, - "SetLovValue": { + "StringFilterFieldValue": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/SetBaseItem" + "$ref": "#/components/schemas/FilterFieldValue" } ], - "additionalProperties": false, - "description": "Represents a settable item in a value list." + "properties": { + "value": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The filter field value." + } + }, + "additionalProperties": false }, - "SetMultiCardFieldValue": { + "StringSearchFieldValue": { + "required": [ + "value" + ], "type": "object", "allOf": [ { - "$ref": "#/components/schemas/SetFieldValue" + "$ref": "#/components/schemas/SearchFieldValue" } ], "properties": { "value": { + "minItems": 1, "type": "array", "items": { - "$ref": "#/components/schemas/SetBaseObject" + "minLength": 1, + "type": "string" }, - "nullable": true + "description": "Collection of values to search for." } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Represents search field value of type System.Collections.Generic.IList`1." }, - "SetMultiDateTimeFieldValue": { + "Tag": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/SetFieldValue" + "$ref": "#/components/schemas/BaseItem" } ], "properties": { - "value": { - "type": "array", - "items": { - "type": "string", - "format": "date-time" - }, + "annotatedTitle": { + "type": "string", + "description": "The annotated title of the tag.\r\nThe value is an HTML string containing the title and <em> elements to mark the input filter, e.g. <em>soft</em> & hard.", "nullable": true + }, + "isSelectable": { + "type": "boolean", + "description": "A value that indicates whether the tag can be selected." + }, + "isValid": { + "type": "boolean", + "description": "A value that indicates whether the tag is valid." } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Represents a tag." }, - "SetMultiLovFieldValue": { + "TagFieldValue": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/SetFieldValue" + "$ref": "#/components/schemas/FieldValue" } ], "properties": { "value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SetLovValue" - }, + "allOf": [ + { + "$ref": "#/components/schemas/Tag" + } + ], + "description": "Represents a tag.", "nullable": true } }, "additionalProperties": false }, - "SetMultiNumberFieldValue": { + "TagFilterFieldValue": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/SetFieldValue" + "$ref": "#/components/schemas/FilterFieldValue" } ], "properties": { "value": { "type": "array", "items": { - "type": "number", - "format": "double" + "$ref": "#/components/schemas/SetTag" }, - "nullable": true + "description": "The filter field value." } }, "additionalProperties": false }, - "SetMultiStringFieldValue": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/SetFieldValue" - } + "TagList": { + "required": [ + "type" ], + "type": "object", "properties": { - "value": { + "type": { + "type": "string" + }, + "tags": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/Tag" + }, + "description": "The list of tags." + }, + "messages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Message" }, + "description": "The list of messages.", "nullable": true } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Represents a list with tags.", + "discriminator": { + "propertyName": "type", + "mapping": { + "TagList": "#/components/schemas/TagList", + "FieldTag": "#/components/schemas/FieldTag" + } + } }, - "SetMultiTagFieldValue": { + "TagRelation": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/SetFieldValue" - } - ], "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SetTag" - }, + "fromId": { + "type": "string", + "description": "The from tag id. If this property is null or System.String.Empty, it indicates that this term appears as a root in the tree.", "nullable": true + }, + "toId": { + "type": "string", + "description": "The to tag id." } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Represents a tag relation." }, - "SetMultiVersionFieldValue": { + "TagStructure": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/SetFieldValue" - } - ], "properties": { - "value": { + "tags": { "type": "array", "items": { - "type": "string" + "$ref": "#/components/schemas/Tag" + }, + "description": "The list of tags." + }, + "relations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TagRelation" }, + "description": "The list of tag relations." + }, + "messages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Message" + }, + "description": "The list of messages.", "nullable": true } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Represents a tags structure." }, - "SetNumberFieldValue": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/SetFieldValue" - } + "TerminateEvent": { + "required": [ + "status" ], + "type": "object", "properties": { - "value": { - "type": "number", - "format": "double", + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/ProgressStatus" + } + ], + "description": "Final status of the event.\r\nBusy status is not allowed." + }, + "currentProgress": { + "minimum": 0, + "type": "integer", + "description": "The current position within the progress range.", + "format": "int32", + "nullable": true + }, + "maximumProgress": { + "minimum": 0, + "type": "integer", + "description": "The maximum progress you expect for this type of event.", + "format": "int32", "nullable": true } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Represents a terminate event model." }, - "SetObjectFieldValue": { + "TerminateEventParameters": { + "required": [ + "progressId" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/SetFieldValue" + "properties": { + "progressId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "format": "int64" } - ], + }, + "additionalProperties": false, + "description": "Request parameters identifying the terminate event." + }, + "ToStatus": { + "type": "object", "properties": { - "value": { - "nullable": true + "label": { + "type": "string", + "description": "The Label of the ToStatus." + }, + "lovValue": { + "allOf": [ + { + "$ref": "#/components/schemas/LovValue" + } + ], + "description": "The LovValue." } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Represents a ToStatus." }, - "SetPublication": { + "TranslationJob": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/SetBaseObject" + "$ref": "#/components/schemas/BaseObject" } ], "properties": { - "versionCardId": { - "type": "integer", - "description": "The version card identifier.", - "format": "int64", + "workflows": { + "type": "array", + "items": { + "$ref": "#/components/schemas/TranslationWorkflow" + }, + "description": "The translation job workflows.", "nullable": true }, - "languageCardId": { - "type": "integer", - "description": "The language card identifier.", - "format": "int64", + "targetFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/FieldValue" + }, + "description": "The translation job target fields.", "nullable": true - }, - "logicalId": { - "type": "string", - "description": "The logical identifier." } }, "additionalProperties": false, - "description": "Represents a publication." + "description": "Represents a translation job." }, - "SetSetting": { + "TranslationJobSourceObject": { + "required": [ + "logicalId" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/SetBaseObject" + "properties": { + "logicalId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The logical ID of the source object." + }, + "version": { + "type": "string", + "description": "The version number of the source object.", + "nullable": true } - ], + }, "additionalProperties": false, - "description": "Represents a setting." + "description": "Represents a translation job source object." }, - "SetStringFieldValue": { + "TranslationJobTargetObject": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/SetFieldValue" - } - ], "properties": { - "value": { + "logicalId": { + "type": "string", + "description": "The logical ID of the target object." + }, + "version": { + "type": "string", + "description": "The version number of the target object.", + "nullable": true + }, + "targetLanguage": { + "allOf": [ + { + "$ref": "#/components/schemas/LovValue" + } + ], + "description": "The target language as a LOVValue.", + "nullable": true + }, + "resolution": { + "allOf": [ + { + "$ref": "#/components/schemas/LovValue" + } + ], + "description": "The resolution as a LOVValue.", + "nullable": true + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/LovValue" + } + ], + "description": "The status as a LOVValue.", + "nullable": true + }, + "documentObjectType": { + "allOf": [ + { + "$ref": "#/components/schemas/DocumentObjectType" + } + ], + "description": "The type of the target object." + }, + "edt": { + "type": "string", + "description": "The Electronic Document Type of the target object.", + "nullable": true + }, + "externalStatus": { + "type": "string", + "description": "The external status of the target object.", + "nullable": true + }, + "externalJobId": { + "type": "integer", + "description": "The external job ID of the target object.", + "format": "int64", + "nullable": true + }, + "externalReference": { + "type": "string", + "description": "The external reference of the target object.", + "nullable": true + }, + "attempts": { + "type": "integer", + "description": "The number of attempts for the target object.", + "format": "int64", + "nullable": true + }, + "error": { "type": "string", + "description": "The error message for the target object.", + "nullable": true + }, + "languageCardId": { + "type": "integer", + "description": "The language card ID of the target object.", + "format": "int64", "nullable": true } }, - "additionalProperties": false - }, - "SetTag": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/SetBaseItem" - } - ], "additionalProperties": false, - "description": "Represents a tag." + "description": "Represents a target object in a translation job." }, - "SetTagFieldValue": { + "TranslationReportSettings": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/SetFieldValue" + "$ref": "#/components/schemas/ReportSettings" } ], "properties": { - "value": { + "statistics": { "allOf": [ { - "$ref": "#/components/schemas/SetTag" + "$ref": "#/components/schemas/TranslationStatusStatistics" } ], - "description": "Represents a tag.", - "nullable": true + "description": "Represents status statistic configuration." } }, - "additionalProperties": false - }, - "Setting": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - } - ], - "additionalProperties": false, - "description": "Represents a setting." - }, - "SetUser": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/SetBaseObject" - } - ], "additionalProperties": false, - "description": "Represents a user." + "description": "Represents the translation report configuration." }, - "SetUserGroup": { + "TranslationStatus": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/SetBaseObject" + "properties": { + "translationStatusType": { + "allOf": [ + { + "$ref": "#/components/schemas/TranslationStatusType" + } + ], + "description": "Represents the type of the translation status." + }, + "status": { + "allOf": [ + { + "$ref": "#/components/schemas/LovValue" + } + ], + "description": "The Lov status." } - ], + }, "additionalProperties": false, - "description": "Represents a user group." + "description": "Represents translation status." }, - "SetVersionFieldValue": { + "TranslationStatusStatistics": { "type": "object", "allOf": [ { - "$ref": "#/components/schemas/SetFieldValue" + "$ref": "#/components/schemas/StatusStatistics" } ], "properties": { - "value": { - "type": "string", - "nullable": true + "targetLanguageStatusGroups": { + "type": "array", + "items": { + "$ref": "#/components/schemas/StatusGroup" + }, + "description": "The target language list of status groups." } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Represents statistics element in the report configuration XML." }, - "SeverityLevel": { + "TranslationStatusType": { "enum": [ - "error", - "warning", - "message", - "info" + "initial", + "inTranslation", + "translationInReview", + "translationApproved", + "translationRejected" ], "type": "string", - "description": "List of Severity Levels" + "description": "Enumeration that lists possible translation status types." }, - "Status": { + "TranslationTemplate": { "type": "object", "properties": { - "value": { + "id": { + "type": "integer", + "description": "The unique identifier.", + "format": "int64" + }, + "name": { + "type": "string", + "description": "The name of the template.", + "nullable": true + }, + "title": { + "type": "string", + "description": "The title of the template (e.g. WS(WS-01):__Trisoft_IntegrationTest_Client:__Trisoft_IntegrationTest_ProjectType_Review).", + "nullable": true + }, + "alias": { + "type": "string", + "description": "The template alias.", + "nullable": true + }, + "translationJobType": { "allOf": [ { "$ref": "#/components/schemas/LovValue" } ], - "description": "The value of the status element in the report configuration XML." + "description": "The translation job type.", + "nullable": true }, - "nextStatuses": { + "sourceLanguage": { + "allOf": [ + { + "$ref": "#/components/schemas/LovValue" + } + ], + "description": "The LovValue with the source language.", + "nullable": true + }, + "review": { + "type": "boolean", + "description": "Can the translation template handle review or not?" + }, + "templateId": { + "type": "string", + "description": "The unique name of the template (e.g. \"WS-1/1021:1017\", TMS-3/DBE64A36-A70D-4B24-9E93-C58CC10A1BDB).", + "nullable": true + }, + "reference": { + "type": "string", + "description": "The reference to the external template.", + "nullable": true + }, + "workflows": { "type": "array", "items": { - "$ref": "#/components/schemas/NextStatus" + "$ref": "#/components/schemas/TranslationWorkflow" }, - "description": "List of the possible next statuses.", + "description": "The workflows of the translation template.", + "nullable": true + }, + "defaultWorkflow": { + "allOf": [ + { + "$ref": "#/components/schemas/TranslationWorkflow" + } + ], + "description": "The default workflow of the translation template.", "nullable": true } }, "additionalProperties": false, - "description": "Represents status element in the report configuration XML." + "description": "Represents a translation job template." }, - "StatusDefinition": { + "TranslationWorkflow": { "type": "object", "properties": { - "status": { + "id": { + "type": "integer", + "description": "Unique identifier of the workflow.", + "format": "int64", + "nullable": true + }, + "reference": { + "type": "string", + "description": "The workflow reference." + }, + "title": { + "type": "string", + "description": "The workflow title.", + "nullable": true + }, + "language": { "allOf": [ { "$ref": "#/components/schemas/LovValue" } ], - "description": "Status: A Trisoft.InfoShare.WebApi.V30.Models.LovValue describing the status value of the definition." - }, - "statusType": { + "description": "The workflow language.", + "nullable": true + } + }, + "additionalProperties": false, + "description": "Represents a workflow of the translation job." + }, + "TypeDefinition": { + "type": "object", + "properties": { + "objectType": { "allOf": [ { - "$ref": "#/components/schemas/StatusType" + "$ref": "#/components/schemas/ObjectType" } ], - "description": "StatusType: Type of the status described in Trisoft.InfoShare.WebApi.V30.Workflows.Models.StatusDefinition.Status." + "description": "Gets the object type." + }, + "fieldDefinitions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SettingsFieldDefinition" + }, + "description": "Gets the list of field definitions.", + "nullable": true } }, "additionalProperties": false, - "description": "Represents an item in a value list." - }, - "StatusFilter": { - "enum": [ - "all", - "latestReleased", - "draftOrLatestReleased", - "allReleased" - ], - "type": "string", - "description": "Allows explicit filtering on the language level status field.\r\n\r\nDepending on which status filter is specified, the objects with following status types can be returned:\r\n
Status filterReturned status types
AllAll status types
LatestReleasedLatest released excluding out-of-date
DraftOrLatestReleasedDraft and latest released excluding out-of-date
AllReleasedAll released including out-of-date
" + "description": "Represents a type definition." }, - "StatusGroup": { + "UndoCheckoutDocumentObject": { "type": "object", "properties": { - "title": { - "type": "string", - "description": "The status group title." - }, - "statuses": { + "requiredCurrentFields": { "type": "array", "items": { - "$ref": "#/components/schemas/Status" + "$ref": "#/components/schemas/SetFieldValue" }, - "description": "List of the possible statuses." + "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to undo checkout the Trisoft.InfoShare.WebApi.V30.DocumentObjects.Models.DocumentObject" } }, "additionalProperties": false, - "description": "Represents status group element in the report configuration XML." + "description": "Represents model to undo checkout of a document" }, - "StatusStatistics": { + "UndoCheckoutDocumentObjectParameters": { "required": [ - "type" + "languageCardId" ], "type": "object", "properties": { - "type": { - "type": "string" - }, - "sourceLanguageStatusGroups": { + "languageCardId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" + } + }, + "additionalProperties": false, + "description": "Request parameters to undo the checkout of the document object specified by the language card identifier." + }, + "UnpublishPublication": { + "type": "object", + "properties": { + "requiredCurrentFields": { "type": "array", "items": { - "$ref": "#/components/schemas/StatusGroup" + "$ref": "#/components/schemas/SetFieldValue" }, - "description": "The source language list of status groups." + "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to publish the Trisoft.InfoShare.WebApi.V30.Publications.Models.Publication.", + "nullable": true } }, "additionalProperties": false, - "description": "Represents statistics element in the report configuration XML.", - "discriminator": { - "propertyName": "type", - "mapping": { - "StatusStatistics": "#/components/schemas/StatusStatistics", - "TranslationStatusStatistics": "#/components/schemas/TranslationStatusStatistics" - } - } - }, - "StatusType": { - "enum": [ - "draft", - "released" - ], - "type": "string", - "description": "Enumeration with the possible status types" + "description": "Represents an unpublish model for publication." }, - "StringFieldValue": { + "UnreleasePublication": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/FieldValue" - } - ], "properties": { - "value": { - "type": "string", + "requiredCurrentFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Fields that will be used in concurrency check.", "nullable": true } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Model representing parameters for unreleasing a publication" }, - "StringFilterFieldValue": { + "UpdateAnnotationByAnnotationId": { "required": [ - "value" + "fields" ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/FilterFieldValue" - } - ], "properties": { - "value": { + "fields": { "minItems": 1, "type": "array", "items": { - "type": "string" - } + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "The list of field values." + }, + "requiredCurrentFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to update the Trisoft.InfoShare.WebApi.V30.Annotations.Models.Annotation" } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Represents an update annotation model." }, - "StringSearchFieldValue": { + "UpdateAnnotationByAnnotationIdParameters": { "required": [ - "value" + "annotationId" ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/SearchFieldValue" + "properties": { + "annotationId": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The annotation identifier." } + }, + "additionalProperties": false, + "description": "The request object to update the annotation by the annotation identifier." + }, + "UpdateAnnotationByReplyCardId": { + "required": [ + "fields" ], + "type": "object", "properties": { - "value": { + "fields": { "minItems": 1, "type": "array", "items": { - "minLength": 1, - "type": "string" + "$ref": "#/components/schemas/SetFieldValue" }, - "description": "Collection of values to search for." + "description": "The list of field values." + }, + "requiredCurrentFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to update the Trisoft.InfoShare.WebApi.V30.Annotations.Models.Annotation" } }, "additionalProperties": false, - "description": "Represents search field value of type System.Collections.Generic.IList`1." + "description": "Represents an update annotation reply model." }, - "Tag": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseItem" - } + "UpdateAnnotationByReplyCardIdParameters": { + "required": [ + "replyCardId" ], + "type": "object", "properties": { - "annotatedTitle": { - "type": "string", - "description": "The annotated title of the tag.", - "nullable": true - }, - "isSelectable": { - "type": "boolean", - "description": "A value that indicates whether the tag can be selected." - }, - "isValid": { - "type": "boolean", - "description": "A value that indicates whether the tag is valid." + "replyCardId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "Reply card identifier.", + "format": "int64" } }, "additionalProperties": false, - "description": "Represents a tag." + "description": "Represents an update annotation reply model." }, - "TagFieldValue": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/FieldValue" - } + "UpdateBaseline": { + "required": [ + "fields" ], + "type": "object", "properties": { - "value": { - "allOf": [ - { - "$ref": "#/components/schemas/Tag" - } - ], - "description": "Represents a tag.", - "nullable": true + "fields": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "The list of field values." } }, - "additionalProperties": false + "additionalProperties": false, + "description": "Represents an update baseline model." }, - "TagFilterFieldValue": { + "UpdateBaselineParameters": { "required": [ - "value" + "id" ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/FilterFieldValue" - } - ], "properties": { - "value": { - "minItems": 1, - "type": "array", - "items": { - "$ref": "#/components/schemas/SetTag" - } + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the baseline." } }, - "additionalProperties": false + "additionalProperties": false, + "description": "The request object to update a baseline that match the criteria given in the properties." }, - "TagList": { + "UpdateDocumentObject": { + "required": [ + "fields" + ], "type": "object", "properties": { - "tags": { + "fields": { + "minItems": 1, "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SetFieldValue" }, - "description": "The list of tags." + "description": "The list of field values to be changed." }, - "messages": { + "requiredCurrentFields": { "type": "array", "items": { - "$ref": "#/components/schemas/Message" + "$ref": "#/components/schemas/SetFieldValue" }, - "description": "The list of messages.", - "nullable": true + "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to update the Trisoft.InfoShare.WebApi.V30.DocumentObjects.Models.DocumentObject" } }, "additionalProperties": false, - "description": "Represents a list with tags." + "description": "Represents a document." }, - "TagRelation": { + "UpdateDocumentObjectByLanguageCardIdParameters": { + "required": [ + "languageCardId" + ], "type": "object", "properties": { - "fromId": { + "languageCardId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "The language card identifier of the document object.", + "format": "int64" + } + }, + "additionalProperties": false, + "description": "Request parameters to update the document object specified by the language card identifier." + }, + "UpdateDocumentObjectByLogicalIdParameters": { + "required": [ + "logicalId" + ], + "type": "object", + "properties": { + "logicalId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", "type": "string", - "description": "The from tag id. If this property is null or System.String.Empty, it indicates that this term appears as a root in the tree.", + "description": "The logical identifier of the document object." + }, + "version": { + "type": "string", + "description": "The version of the document object.", "nullable": true }, - "toId": { + "language": { + "maxLength": 255, "type": "string", - "description": "The to tag id." + "description": "The language of the document object.", + "nullable": true + }, + "resolution": { + "maxLength": 255, + "type": "string", + "description": "The resolution of the document object.", + "nullable": true } }, "additionalProperties": false, - "description": "Represents a tag relation." + "description": "Request parameters to update the document object specified by the logical identifier, version, language and resolution." }, - "TagStructure": { + "UpdateDocumentObjectContent": { "type": "object", "properties": { - "tags": { + "fields": { "type": "array", "items": { - "$ref": "#/components/schemas/Tag" + "$ref": "#/components/schemas/SetFieldValue" }, - "description": "The list of tags." + "description": "The list of field values to be changed." }, - "relations": { + "requiredCurrentFields": { "type": "array", "items": { - "$ref": "#/components/schemas/TagRelation" + "$ref": "#/components/schemas/SetFieldValue" }, - "description": "The list of tag relations." + "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to update the Trisoft.InfoShare.WebApi.V30.DocumentObjects.Models.DocumentObject" + } + }, + "additionalProperties": false, + "description": "Request object to update object content in the repository that match the criteria given in the properties." + }, + "UpdateElectronicDocumentType": { + "required": [ + "fields" + ], + "type": "object", + "properties": { + "fields": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "The list of field values." }, - "messages": { + "requiredCurrentFields": { "type": "array", "items": { - "$ref": "#/components/schemas/Message" + "$ref": "#/components/schemas/SetFieldValue" }, - "description": "The list of messages.", - "nullable": true + "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to update the Trisoft.InfoShare.WebApi.V30.ElectronicDocumentTypes.Models.ElectronicDocumentType" } }, "additionalProperties": false, - "description": "Represents a tags structure." + "description": "Represents an update electronic document type model" }, - "ToStatus": { + "UpdateElectronicDocumentTypeParameters": { + "required": [ + "id" + ], "type": "object", "properties": { - "label": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", "type": "string", - "description": "The Label of the ToStatus." - }, - "lovValue": { - "allOf": [ - { - "$ref": "#/components/schemas/LovValue" - } - ], - "description": "The LovValue." + "description": "Identifier of the electronic document type." } }, "additionalProperties": false, - "description": "Represents a ToStatus." + "description": "Represents an update electronic document type model" }, - "TranslationObject": { - "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/BaseObject" - } + "UpdateEntries": { + "required": [ + "entries" ], - "additionalProperties": false, - "description": "Represents an translation object." - }, - "TranslationReportSettings": { "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/ReportSettings" - } - ], "properties": { - "statistics": { - "allOf": [ - { - "$ref": "#/components/schemas/TranslationStatusStatistics" - } - ], - "description": "Represents status statistic configuration." + "entries": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/SetBaselineEntry" + }, + "description": "List of entries to add/update/delete." } }, "additionalProperties": false, - "description": "Represents the translation report configuration." + "description": "The model contains the parameters which will be used to add/update/delete entries in the baseline." }, - "TranslationStatusStatistics": { + "UpdateEntriesParameters": { + "required": [ + "id" + ], "type": "object", - "allOf": [ - { - "$ref": "#/components/schemas/StatusStatistics" + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the baseline." } + }, + "additionalProperties": false, + "description": "The request object to add/update/delete baseline entries that match the criteria given in the properties." + }, + "UpdateFolder": { + "required": [ + "fields" ], + "type": "object", "properties": { - "targetLanguageStatusGroups": { + "fields": { + "minItems": 1, "type": "array", "items": { - "$ref": "#/components/schemas/StatusGroup" + "$ref": "#/components/schemas/SetFieldValue" }, - "description": "The target language list of status groups." + "description": "The list of field values." } }, "additionalProperties": false, - "description": "Represents statistics element in the report configuration XML." + "description": "Represents an update folder model." }, - "UndoCheckoutDocumentObject": { + "UpdateLovValue": { + "required": [ + "description", + "title" + ], "type": "object", "properties": { - "requiredCurrentFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SetFieldValue" - }, - "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to undo checkout the Trisoft.InfoShare.WebApi.V30.DocumentObjects.Models.DocumentObject", - "nullable": true + "title": { + "minLength": 1, + "type": "string", + "description": "The lov value title" + }, + "description": { + "type": "string", + "description": "The lov value description" + }, + "active": { + "type": "boolean", + "description": "The lov value active status" } }, "additionalProperties": false, - "description": "Represents model to undo checkout of a document" + "description": "Represents an update lov Value model." }, - "UnpublishPublication": { + "UpdateOutputFormat": { + "required": [ + "fields" + ], "type": "object", "properties": { - "requiredCurrentFields": { + "fields": { + "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/SetFieldValue" }, - "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to publish the Trisoft.InfoShare.WebApi.V30.Publications.Models.Publication.", - "nullable": true + "description": "The list of field values." } }, "additionalProperties": false, - "description": "Represents an unpublish model for publication." + "description": "Represents an update output format model" }, - "UnreleasePublication": { + "UpdateOutputFormatParameters": { + "required": [ + "id" + ], "type": "object", "properties": { - "requiredCurrentFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SetFieldValue" - }, - "description": "Fields that will be used in concurrency check.", - "nullable": true + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the output format." } }, "additionalProperties": false, - "description": "Model representing parameters for unreleasing a publication" + "description": "Represents an update output format model" }, - "UpdateCurrentUser": { + "UpdatePreferenceSet": { "required": [ - "fields" + "items" ], "type": "object", "properties": { - "fields": { + "items": { "minItems": 1, "type": "array", "items": { - "$ref": "#/components/schemas/SetFieldValue" + "$ref": "#/components/schemas/SetPreferenceItem" }, - "description": "The list of field values." + "description": "The list of preference items." } }, "additionalProperties": false, - "description": "Represents an update current user model." + "description": "Represents an update current user preference set model." }, - "UpdateDocumentObject": { + "UpdateProject": { "type": "object", "properties": { "fields": { @@ -14709,14 +32815,14 @@ "items": { "$ref": "#/components/schemas/SetFieldValue" }, - "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to update the Trisoft.InfoShare.WebApi.V30.DocumentObjects.Models.DocumentObject", + "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to update the Trisoft.InfoShare.WebApi.V30.Projects.Models.Project", "nullable": true } }, "additionalProperties": false, - "description": "Represents a document." + "description": "Represents an update project model." }, - "UpdateDocumentObjectContent": { + "UpdateProjectAssignee": { "type": "object", "properties": { "fields": { @@ -14724,76 +32830,53 @@ "items": { "$ref": "#/components/schemas/SetFieldValue" }, - "description": "The list of field values to be changed.", - "nullable": true + "description": "The list of field values to be changed." }, "requiredCurrentFields": { "type": "array", "items": { "$ref": "#/components/schemas/SetFieldValue" }, - "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to update the Trisoft.InfoShare.WebApi.V30.DocumentObjects.Models.DocumentObject", + "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to update the assignee.", "nullable": true } }, "additionalProperties": false, - "description": "Request object to update object content in the repository that match the criteria given in the properties." - }, - "UpdateFolder": { - "type": "object", - "properties": { - "fields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SetFieldValue" - }, - "description": "The list of field values." - } - }, - "additionalProperties": false, - "description": "Represents an update folder model." + "description": "Represent update project's assignee model." }, - "UpdateLovValue": { + "UpdateProjectAssigneeParameters": { "required": [ - "description", - "title" + "assigneeCardId" ], "type": "object", "properties": { - "title": { - "minLength": 1, - "type": "string", - "description": "The lov value title" - }, - "description": { - "type": "string", - "description": "The lov value description" - }, - "active": { - "type": "boolean", - "description": "The lov value active status" + "assigneeCardId": { + "maximum": 9999999999, + "minimum": 1, + "type": "integer", + "description": "Identifier of the project's assignee.", + "format": "int64" } }, "additionalProperties": false, - "description": "Represents an update lov Value model." + "description": "Represents the update project's assignee model." }, - "UpdatePreferenceSet": { + "UpdateProjectParameters": { "required": [ - "items" + "projectId" ], "type": "object", "properties": { - "items": { - "minItems": 1, - "type": "array", - "items": { - "$ref": "#/components/schemas/PreferenceItem" - }, - "description": "The list of preference items." + "projectId": { + "maxLength": 100, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of a project." } }, "additionalProperties": false, - "description": "Represents an update current user preference set model." + "description": "Represents the update project model." }, "UpdatePublication": { "type": "object", @@ -14818,9 +32901,13 @@ "description": "Represents an update model for publication." }, "UpdateSettings": { + "required": [ + "fields" + ], "type": "object", "properties": { "fields": { + "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/SetFieldValue" @@ -14832,8 +32919,7 @@ "items": { "$ref": "#/components/schemas/SetFieldValue" }, - "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to update the Trisoft.InfoShare.WebApi.V30.Settings.Models.Setting", - "nullable": true + "description": "Fields that will be used in concurrency check.\r\nEach individual field in this collection should have the same exact value in the database in order to update the Trisoft.InfoShare.WebApi.V30.Settings.Models.Setting" } }, "additionalProperties": false, @@ -14841,17 +32927,20 @@ }, "UpdateStatusDefinition": { "required": [ + "active", "description", "title" ], "type": "object", "properties": { "title": { + "maxLength": 255, "minLength": 1, "type": "string", "description": "The status definition title" }, "description": { + "maxLength": 1000, "type": "string", "description": "The status definition description" }, @@ -14863,6 +32952,58 @@ "additionalProperties": false, "description": "Represents an update status definition model." }, + "UpdateTranslationJob": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Specify the fields of the object." + }, + "requiredCurrentFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Specify the fields that will be used in concurrency check." + }, + "targetFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "Specify the target fields of the object." + }, + "workflows": { + "type": "array", + "items": { + "$ref": "#/components/schemas/SetTranslationWorkflow" + }, + "description": "Specify the workflows of the object." + } + }, + "additionalProperties": false, + "description": "Request object to update the translation job." + }, + "UpdateTranslationJobParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the translation job." + } + }, + "additionalProperties": false, + "description": "Request object to update the translation job in the repository that match the criteria given in the properties." + }, "UpdateUser": { "required": [ "fields" @@ -14881,6 +33022,93 @@ "additionalProperties": false, "description": "Represents an update user model." }, + "UpdateUserGroup": { + "required": [ + "fields" + ], + "type": "object", + "properties": { + "fields": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "The list of field values." + } + }, + "additionalProperties": false, + "description": "Represents an update user group model" + }, + "UpdateUserGroupParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the group." + } + }, + "additionalProperties": false, + "description": "Represents an update user group model" + }, + "UpdateUserParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "The identifier of the user." + } + }, + "additionalProperties": false, + "description": "The request object to update a user that match the criteria given in the properties." + }, + "UpdateUserRole": { + "required": [ + "fields" + ], + "type": "object", + "properties": { + "fields": { + "minItems": 1, + "type": "array", + "items": { + "$ref": "#/components/schemas/SetFieldValue" + }, + "description": "The list of field values." + } + }, + "additionalProperties": false, + "description": "Represents an update user role model" + }, + "UpdateUserRoleParameters": { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "maxLength": 255, + "minLength": 1, + "pattern": "^(?=.*[a-zA-Z])[a-zA-Z0-9.-]*$", + "type": "string", + "description": "Identifier of the role." + } + }, + "additionalProperties": false, + "description": "Represents an update user role model" + }, "User": { "type": "object", "allOf": [ @@ -14891,6 +33119,14 @@ "additionalProperties": false, "description": "Represents a user." }, + "UserFilter": { + "enum": [ + "all", + "current" + ], + "type": "string", + "description": "Enumeration holding the possible filters on a user column/field" + }, "UserGroup": { "type": "object", "allOf": [ @@ -14901,6 +33137,16 @@ "additionalProperties": false, "description": "Represents a user group." }, + "UserRole": { + "type": "object", + "allOf": [ + { + "$ref": "#/components/schemas/BaseObject" + } + ], + "additionalProperties": false, + "description": "Represents a user role." + }, "VersionFieldValue": { "type": "object", "allOf": [ diff --git a/Source/ISHRemote/Trisoft.ISHRemote/Cmdlets/Session/NewIshSession.Tests.ps1 b/Source/ISHRemote/Trisoft.ISHRemote/Cmdlets/Session/NewIshSession.Tests.ps1 index 447db97b..0bfd1d25 100644 --- a/Source/ISHRemote/Trisoft.ISHRemote/Cmdlets/Session/NewIshSession.Tests.ps1 +++ b/Source/ISHRemote/Trisoft.ISHRemote/Cmdlets/Session/NewIshSession.Tests.ps1 @@ -627,7 +627,7 @@ Describe "New-IshSession" -Tags "Read" { } It "IshSession.OpenApiAM10Client" { if (([Version]$ishSession.ServerVersion).Major -ge 15) { # new service since 15/15.0.0 - $json = $localIShSession.OpenApiAM10Client.IdentityProvidersGetAsync() + $json = $localIShSession.OpenApiAM10Client.IdentityProviders_GetAsync() $json.Result.Count -ge 1 | Should -Be $true } } @@ -740,12 +740,44 @@ Describe "New-IshSession" -Tags "Read" { $json.Result | Should -Be $ishSession.ServerVersion } } + It "IshSession.OpenApiISH30Client OperationIds (20240404 methods exists)" { + # below array generated with: "@( '"+$(((Get-Member -InputObject $ishSession.OpenApiISH30Client -MemberType Method).Name) -join "','")+"' )" + $members20240404 = @( 'AddShortcutToFolderAsync','CancelPublicationPublishAsync','CheckInDocumentObjectByLanguageCardIdAsync','CheckOutDocumentObjectByLanguageCardIdAsync','CompleteBaselineAsync','CreateBackgroundTaskAsync','CreateDocumentObjectAsync','CreateDocumentObjectLanguageAsync','CreateDocumentObjectVersionAsync','CreateFolderAsync','CreateLovValueAsync','CreatePublicationAsync','CreatePublicationLanguageAsync','CreatePublicationVersionAsync','CreateStatusDefinitionAsync','CreateUserAsync','CreateUserGroupAsync','DeleteDocumentObjectByLanguageCardIdAsync','DeleteDocumentObjectByLogicalIdAsync','DeleteFolderAsync','DeleteLovValueAsync','DeletePublicationByLanguageCardIdAsync','DeletePublicationByLogicalIdAsync','DeleteStatusDefinitionAsync','DeleteUserAsync','DeleteUserGroupAsync','Equals','ExpandBaselineAsync','GetApplicationVersionAsync','GetBackgroundTaskByIdAsync','GetBaselineListAsync','GetCurrentUserAsync','GetDocumentObjectByLanguageCardIdAsync','GetDocumentObjectByLogicalIdAsync','GetDocumentObjectContentByLanguageCardIdAsync','GetDocumentObjectListAsync','GetDocumentObjectListByLanguageCardIdAsync','GetDocumentObjectListByLogicalIdAsync','GetDocumentObjectListUsingDocumentObjectAsync','GetDocumentObjectLocationAsync','GetDocumentObjectPossibleTargetStatusListAsync','GetDocumentObjectPossibleTargetStatusListByLanguageCardIdAsync','GetDocumentObjectReferenceListByLanguageCardIdAsync','GetFolderAsync','GetFolderListAsync','GetFolderLocationAsync','GetFolderObjectListAsync','GetHashCode','GetInboxListAsync','GetInboxObjectListAsync','GetLovListAsync','GetLovValueAsync','GetLovValueListAsync','GetMetadataBindingTagListAsync','GetMetadataBindingTagStructureAsync','GetMyPreferencesAsync','GetMyPrivilegesAsync','GetObjectAsync','GetPublicationByLanguageCardIdAsync','GetPublicationByLogicalIdAsync','GetPublicationContentByLanguageCardIdAsync','GetPublicationListAsync','GetPublicationListByLanguageCardIdAsync','GetPublicationListByLogicalIdAsync','GetPublicationListUsingDocumentObjectAsync','GetPublicationLocationAsync','GetRootFolderListAsync','GetSettingsAsync','GetStatusDefinitionAsync','GetStatusDefinitionListAsync','GetTranslationReportSettingsAsync','GetType','GetUserAsync','GetUserGroupListAsync','GetUserListAsync','GetUserPreferencesAsync','GetWorkflowReportSettingsAsync','MoveFolderAsync','MoveObjectToFolderAsync','PublishPublicationAsync','ReleasePublicationAsync','RemoveShortcutFromFolderAsync','SearchAsync','SetMyPreferencesAsync','SetUserPreferencesAsync','ToString','UndoCheckoutDocumentObjectByLanguageCardIdAsync','UnpublishPublicationAsync','UnreleasePublicationAsync','UpdateCurrentUserAsync','UpdateDocumentObjectByLanguageCardIdAsync','UpdateDocumentObjectByLogicalIdAsync','UpdateDocumentObjectContentByLanguageCardIdAsync','UpdateFolderAsync','UpdateLovValueAsync','UpdatePublicationByLanguageCardIdAsync','UpdatePublicationByLogicalIdAsync','UpdateSettingsAsync','UpdateStatusDefinitionAsync','UpdateUserAsync','UpdateUserGroupAsync' ) + foreach ($member in $members20240404) { + $localIShSession.OpenApiISH30Client.PSObject.Methods.Name | Should -Contain $member + } + } + It "IshSession.OpenApiISH30Client OperationIds (new methods found, adapt this test)" { + # below array generated with: "@( '"+$(((Get-Member -InputObject $ishSession.OpenApiISH30Client -MemberType Method).Name) -join "','")+"' )" + $members20240404 = @( 'AddShortcutToFolderAsync','CancelPublicationPublishAsync','CheckInDocumentObjectByLanguageCardIdAsync','CheckOutDocumentObjectByLanguageCardIdAsync','CompleteBaselineAsync','CreateBackgroundTaskAsync','CreateDocumentObjectAsync','CreateDocumentObjectLanguageAsync','CreateDocumentObjectVersionAsync','CreateFolderAsync','CreateLovValueAsync','CreatePublicationAsync','CreatePublicationLanguageAsync','CreatePublicationVersionAsync','CreateStatusDefinitionAsync','CreateUserAsync','CreateUserGroupAsync','DeleteDocumentObjectByLanguageCardIdAsync','DeleteDocumentObjectByLogicalIdAsync','DeleteFolderAsync','DeleteLovValueAsync','DeletePublicationByLanguageCardIdAsync','DeletePublicationByLogicalIdAsync','DeleteStatusDefinitionAsync','DeleteUserAsync','DeleteUserGroupAsync','Equals','ExpandBaselineAsync','GetApplicationVersionAsync','GetBackgroundTaskByIdAsync','GetBaselineListAsync','GetCurrentUserAsync','GetDocumentObjectByLanguageCardIdAsync','GetDocumentObjectByLogicalIdAsync','GetDocumentObjectContentByLanguageCardIdAsync','GetDocumentObjectListAsync','GetDocumentObjectListByLanguageCardIdAsync','GetDocumentObjectListByLogicalIdAsync','GetDocumentObjectListUsingDocumentObjectAsync','GetDocumentObjectLocationAsync','GetDocumentObjectPossibleTargetStatusListAsync','GetDocumentObjectPossibleTargetStatusListByLanguageCardIdAsync','GetDocumentObjectReferenceListByLanguageCardIdAsync','GetFolderAsync','GetFolderListAsync','GetFolderLocationAsync','GetFolderObjectListAsync','GetHashCode','GetInboxListAsync','GetInboxObjectListAsync','GetLovListAsync','GetLovValueAsync','GetLovValueListAsync','GetMetadataBindingTagListAsync','GetMetadataBindingTagStructureAsync','GetMyPreferencesAsync','GetMyPrivilegesAsync','GetObjectAsync','GetPublicationByLanguageCardIdAsync','GetPublicationByLogicalIdAsync','GetPublicationContentByLanguageCardIdAsync','GetPublicationListAsync','GetPublicationListByLanguageCardIdAsync','GetPublicationListByLogicalIdAsync','GetPublicationListUsingDocumentObjectAsync','GetPublicationLocationAsync','GetRootFolderListAsync','GetSettingsAsync','GetStatusDefinitionAsync','GetStatusDefinitionListAsync','GetTranslationReportSettingsAsync','GetType','GetUserAsync','GetUserGroupListAsync','GetUserListAsync','GetUserPreferencesAsync','GetWorkflowReportSettingsAsync','MoveFolderAsync','MoveObjectToFolderAsync','PublishPublicationAsync','ReleasePublicationAsync','RemoveShortcutFromFolderAsync','SearchAsync','SetMyPreferencesAsync','SetUserPreferencesAsync','ToString','UndoCheckoutDocumentObjectByLanguageCardIdAsync','UnpublishPublicationAsync','UnreleasePublicationAsync','UpdateCurrentUserAsync','UpdateDocumentObjectByLanguageCardIdAsync','UpdateDocumentObjectByLogicalIdAsync','UpdateDocumentObjectContentByLanguageCardIdAsync','UpdateFolderAsync','UpdateLovValueAsync','UpdatePublicationByLanguageCardIdAsync','UpdatePublicationByLogicalIdAsync','UpdateSettingsAsync','UpdateStatusDefinitionAsync','UpdateUserAsync','UpdateUserGroupAsync' ) + foreach ($member in $localIShSession.OpenApiISH30Client.PSObject.Methods.Name) { + if ($member -notin @('Equals','GetHashCode','GetType','ToString','get_BaseUrl','set_BaseUrl','get_ReadResponseAsString','set_ReadResponseAsString')) { + $members20240404 | Should -Contain $member + } + } + } It "IshSession.OpenApiAM10Client" { if (([Version]$ishSession.ServerVersion).Major -ge 15) { # new service since 15/15.0.0 - $json = $localIShSession.OpenApiAM10Client.IdentityProvidersGetAsync() + $json = $localIShSession.OpenApiAM10Client.IdentityProviders_GetAsync() $json.Result.Count -ge 1 | Should -Be $true } } + It "IshSession.OpenApiAM10Client OperationIds (20240404 methods exists)" { + # below array generated with: "@( '"+$(((Get-Member -InputObject $ishSession.OpenApiAM10Client -MemberType Method).Name) -join "','")+"' )" + $members20240404 = @( 'ApiResourcesGetAsync','ApiResourcesGetByIdAsync','ApplicationsCreateAsync','ApplicationsDeleteAsync','ApplicationsGetAsync','ApplicationsGetByIdAsync','ApplicationsUpdateAsync','AuditLogsGetByFilterAsync','AuditLogsGetByIdAsync','Equals','GetHashCode','GetType','IdentityProvidersCreateAsync','IdentityProvidersDeleteAsync','IdentityProvidersGetAsync','IdentityProvidersGetAvailableIdpTypesAsync','IdentityProvidersGetByIdAsync','IdentityProvidersGetIconAsync','IdentityProvidersGetLoginOptionsAsync','IdentityProvidersGetParametersForIdentityProviderTypeAsync','IdentityProvidersUpdateAsync','ServiceAccountsCreateAsync','ServiceAccountsDeleteAsync','ServiceAccountsDeleteClientSecretAsync','ServiceAccountsGenerateClientSecretAsync','ServiceAccountsGetAsync','ServiceAccountsGetByIdAsync','ServiceAccountsUpdateAsync','ServiceAccountsUpdateClientSecretAsync','SystemGetLoginStatusAsync','SystemGetSupportedCulturesAsync','SystemGetUserInfoAsync','ToString','UsersActivateUserAsync','UsersDeactivateUserAsync','UsersDeleteAsync','UsersDeleteClientSecretAsync','UsersGenerateClientSecretAsync','UsersGetAsync','UsersGetByIdAsync','UsersUpdateAsync','UsersUpdateClientSecretAsync' ) + foreach ($member in $members20240404) { + $localIShSession.OpenApiAM10Client.PSObject.Methods.Name | Should -Contain $member + } + } + It "IshSession.OpenApiAM10Client OperationIds (new methods found, adapt this test)" { + # below array generated with: "@( '"+$(((Get-Member -InputObject $ishSession.OpenApiAM10Client -MemberType Method).Name) -join "','")+"' )" + $members20240404 = @( 'ApiResourcesGetAsync','ApiResourcesGetByIdAsync','ApplicationsCreateAsync','ApplicationsDeleteAsync','ApplicationsGetAsync','ApplicationsGetByIdAsync','ApplicationsUpdateAsync','AuditLogsGetByFilterAsync','AuditLogsGetByIdAsync','Equals','GetHashCode','GetType','IdentityProvidersCreateAsync','IdentityProvidersDeleteAsync','IdentityProvidersGetAsync','IdentityProvidersGetAvailableIdpTypesAsync','IdentityProvidersGetByIdAsync','IdentityProvidersGetIconAsync','IdentityProvidersGetLoginOptionsAsync','IdentityProvidersGetParametersForIdentityProviderTypeAsync','IdentityProvidersUpdateAsync','ServiceAccountsCreateAsync','ServiceAccountsDeleteAsync','ServiceAccountsDeleteClientSecretAsync','ServiceAccountsGenerateClientSecretAsync','ServiceAccountsGetAsync','ServiceAccountsGetByIdAsync','ServiceAccountsUpdateAsync','ServiceAccountsUpdateClientSecretAsync','SystemGetLoginStatusAsync','SystemGetSupportedCulturesAsync','SystemGetUserInfoAsync','ToString','UsersActivateUserAsync','UsersDeactivateUserAsync','UsersDeleteAsync','UsersDeleteClientSecretAsync','UsersGenerateClientSecretAsync','UsersGetAsync','UsersGetByIdAsync','UsersUpdateAsync','UsersUpdateClientSecretAsync' ) + foreach ($member in $localIShSession.OpenApiAM10Client.PSObject.Methods.Name) { + if ($member -notin @('Equals','GetHashCode','GetType','ToString','get_BaseUrl','set_BaseUrl','get_ReadResponseAsString','set_ReadResponseAsString')) { + $members20240404 | Should -Contain $member + } + } + } It "IshSession.Annotation25" { if (([Version]$ishSession.ServerVersion).Major -ge 15) { # new service since 15/15.0.0 $localIShSession.Annotation25 | Should -Not -BeNullOrEmpty diff --git a/Source/ISHRemote/Trisoft.ISHRemote/ExtensionMethods/IshFieldsExtensions.cs b/Source/ISHRemote/Trisoft.ISHRemote/ExtensionMethods/IshFieldsExtensions.cs index 90e263a0..81c8ed55 100644 --- a/Source/ISHRemote/Trisoft.ISHRemote/ExtensionMethods/IshFieldsExtensions.cs +++ b/Source/ISHRemote/Trisoft.ISHRemote/ExtensionMethods/IshFieldsExtensions.cs @@ -52,7 +52,7 @@ internal static OpenApiISH30.Level ToOpenApiISH30Level(this Enumerations.Level l return OpenApiISH30.Level.Data; case Enumerations.Level.Detail: - return OpenApiISH30.Level.Detail; + return OpenApiISH30.Level.EventProgressDetail; case Enumerations.Level.History: // TODO [Could] API30 enumerations @@ -207,7 +207,7 @@ private static ICollection GetSetBaseObjectFromReferenceType(stri case Enumerations.ISHType.ISHIllustration: case Enumerations.ISHType.ISHModule: case Enumerations.ISHType.ISHTemplate: - setBaseObject = new SetDocumentObject() { Id = id }; + setBaseObject = new SetDocumentObject() { LogicalId = id }; break; } @@ -220,4 +220,4 @@ private static ICollection GetSetBaseObjectFromReferenceType(stri return setBaseObjects; } } -} \ No newline at end of file +} diff --git a/Source/ISHRemote/Trisoft.ISHRemote/ExtensionMethods/OpenApiISH30EnumerationsExtensions.cs b/Source/ISHRemote/Trisoft.ISHRemote/ExtensionMethods/OpenApiISH30EnumerationsExtensions.cs index 587feed1..4d5ba767 100644 --- a/Source/ISHRemote/Trisoft.ISHRemote/ExtensionMethods/OpenApiISH30EnumerationsExtensions.cs +++ b/Source/ISHRemote/Trisoft.ISHRemote/ExtensionMethods/OpenApiISH30EnumerationsExtensions.cs @@ -1,4 +1,4 @@ -/* +/* * Copyright (c) 2014 All Rights Reserved by the SDL Group. * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -64,9 +64,9 @@ internal static Level ToISHFieldLevel(this OpenApiISH30.Level oLevel) return Level.Annotation; case OpenApiISH30.Level.Reply: return Level.Reply; - case OpenApiISH30.Level.Progress: + case OpenApiISH30.Level.EventProgress: return Level.Progress; - case OpenApiISH30.Level.Detail: + case OpenApiISH30.Level.EventProgressDetail: return Level.Detail; case OpenApiISH30.Level.Object: case OpenApiISH30.Level.Compute: From 40010047c7b22951cd1ff80b776591d122ae2fa6 Mon Sep 17 00:00:00 2001 From: ddemeyer Date: Mon, 15 Dec 2025 10:01:48 +0100 Subject: [PATCH 2/3] #223 Added Pester tests based on 20251012 members. Refreshed OpenAPIAM10Client, no code changes but all OperationIds changed.... Probably not many scripts use OpenAPI proxies so could be resolved with breaking change documentation. --- .../Cmdlets/Session/NewIshSession.Tests.ps1 | 45 ++++++++++++------- 1 file changed, 29 insertions(+), 16 deletions(-) diff --git a/Source/ISHRemote/Trisoft.ISHRemote/Cmdlets/Session/NewIshSession.Tests.ps1 b/Source/ISHRemote/Trisoft.ISHRemote/Cmdlets/Session/NewIshSession.Tests.ps1 index 0bfd1d25..9586a967 100644 --- a/Source/ISHRemote/Trisoft.ISHRemote/Cmdlets/Session/NewIshSession.Tests.ps1 +++ b/Source/ISHRemote/Trisoft.ISHRemote/Cmdlets/Session/NewIshSession.Tests.ps1 @@ -732,6 +732,16 @@ Describe "New-IshSession" -Tags "Read" { BeforeAll { if (([Version]$ishSession.ServerVersion).Major -ge 15) { # new service since 15/15.0.0 $localIShSession = New-IshSession -Protocol OpenApiWithOpenIdConnect -WsBaseUrl $webServicesBaseUrl -ClientId $amClientId -ClientSecret $amClientSecret + # OpenApiISH30Client + # below array generated with: "@( '"+$(((Get-Member -InputObject $ishSession.OpenApiISH30Client -MemberType Method).Name) -join "','")+"' )" + # Correct HATEOS Placeholder 'GetBackgroundTaskByIdAsync' which was only implemented in 15.2.0 and renamed to 'GetBackgroundTaskAsync' + $openApiISH30ClientMembers20240404 = @( 'AddShortcutToFolderAsync','CancelPublicationPublishAsync','CheckInDocumentObjectByLanguageCardIdAsync','CheckOutDocumentObjectByLanguageCardIdAsync','CompleteBaselineAsync','CreateBackgroundTaskAsync','CreateDocumentObjectAsync','CreateDocumentObjectLanguageAsync','CreateDocumentObjectVersionAsync','CreateFolderAsync','CreateLovValueAsync','CreatePublicationAsync','CreatePublicationLanguageAsync','CreatePublicationVersionAsync','CreateStatusDefinitionAsync','CreateUserAsync','CreateUserGroupAsync','DeleteDocumentObjectByLanguageCardIdAsync','DeleteDocumentObjectByLogicalIdAsync','DeleteFolderAsync','DeleteLovValueAsync','DeletePublicationByLanguageCardIdAsync','DeletePublicationByLogicalIdAsync','DeleteStatusDefinitionAsync','DeleteUserAsync','DeleteUserGroupAsync','Equals','ExpandBaselineAsync','GetApplicationVersionAsync','GetBackgroundTaskAsync','GetBaselineListAsync','GetCurrentUserAsync','GetDocumentObjectByLanguageCardIdAsync','GetDocumentObjectByLogicalIdAsync','GetDocumentObjectContentByLanguageCardIdAsync','GetDocumentObjectListAsync','GetDocumentObjectListByLanguageCardIdAsync','GetDocumentObjectListByLogicalIdAsync','GetDocumentObjectListUsingDocumentObjectAsync','GetDocumentObjectLocationAsync','GetDocumentObjectPossibleTargetStatusListAsync','GetDocumentObjectPossibleTargetStatusListByLanguageCardIdAsync','GetDocumentObjectReferenceListByLanguageCardIdAsync','GetFolderAsync','GetFolderListAsync','GetFolderLocationAsync','GetFolderObjectListAsync','GetHashCode','GetInboxListAsync','GetInboxObjectListAsync','GetLovListAsync','GetLovValueAsync','GetLovValueListAsync','GetMetadataBindingTagListAsync','GetMetadataBindingTagStructureAsync','GetMyPreferencesAsync','GetMyPrivilegesAsync','GetObjectAsync','GetPublicationByLanguageCardIdAsync','GetPublicationByLogicalIdAsync','GetPublicationContentByLanguageCardIdAsync','GetPublicationListAsync','GetPublicationListByLanguageCardIdAsync','GetPublicationListByLogicalIdAsync','GetPublicationListUsingDocumentObjectAsync','GetPublicationLocationAsync','GetRootFolderListAsync','GetSettingsAsync','GetStatusDefinitionAsync','GetStatusDefinitionListAsync','GetTranslationReportSettingsAsync','GetType','GetUserAsync','GetUserGroupListAsync','GetUserListAsync','GetUserPreferencesAsync','GetWorkflowReportSettingsAsync','MoveFolderAsync','MoveObjectToFolderAsync','PublishPublicationAsync','ReleasePublicationAsync','RemoveShortcutFromFolderAsync','SearchAsync','SetMyPreferencesAsync','SetUserPreferencesAsync','ToString','UndoCheckoutDocumentObjectByLanguageCardIdAsync','UnpublishPublicationAsync','UnreleasePublicationAsync','UpdateCurrentUserAsync','UpdateDocumentObjectByLanguageCardIdAsync','UpdateDocumentObjectByLogicalIdAsync','UpdateDocumentObjectContentByLanguageCardIdAsync','UpdateFolderAsync','UpdateLovValueAsync','UpdatePublicationByLanguageCardIdAsync','UpdatePublicationByLogicalIdAsync','UpdateSettingsAsync','UpdateStatusDefinitionAsync','UpdateUserAsync','UpdateUserGroupAsync' ) + $openApiISH30ClientMembers20251210 = @( 'AddShortcutToFolderAsync','AddTranslationJobSourceObjectsAsync','CancelPublicationPublishAsync','CancelTranslationJobAsync','CheckInDocumentObjectByLanguageCardIdAsync','CheckOutDocumentObjectByLanguageCardIdAsync','CleanUpBaselineAsync','CompleteBaselineAsync','CompleteBaselineReportAsync','CopyBaselineAsync','CreateAnnotationAsync','CreateAnnotationReplyAsync','CreateBackgroundTaskAsync','CreateBackgroundTaskForDocumentObjectByLanguageCardIdAsync','CreateBaselineAsync','CreateDocumentObjectAsync','CreateDocumentObjectLanguageAsync','CreateDocumentObjectVersionAsync','CreateElectronicDocumentTypeAsync','CreateEventAsync','CreateEventDetailAsync','CreateFolderAsync','CreateLovValueAsync','CreateOutputFormatAsync','CreateProjectAssigneeAsync','CreateProjectAsync','CreatePublicationAsync','CreatePublicationLanguageAsync','CreatePublicationVersionAsync','CreateStatusDefinitionAsync','CreateTranslationJobAsync','CreateUserAsync','CreateUserGroupAsync','CreateUserRoleAsync','DeleteAnnotationByAnnotationIdAsync','DeleteAnnotationByReplyCardIdAsync','DeleteBaselineAsync','DeleteDocumentObjectByLanguageCardIdAsync','DeleteDocumentObjectByLogicalIdAsync','DeleteElectronicDocumentTypeAsync','DeleteEventAsync','DeleteFolderAsync','DeleteLovValueAsync','DeleteMyPreferencesAsync','DeleteOutputFormatAsync','DeleteProjectAssigneeAsync','DeleteProjectAsync','DeletePublicationByLanguageCardIdAsync','DeletePublicationByLogicalIdAsync','DeleteStatusDefinitionAsync','DeleteTranslationJobAsync','DeleteTranslationJobSourceObjectAsync','DeleteUserAsync','DeleteUserGroupAsync','DeleteUserPreferencesAsync','DeleteUserRoleAsync','Equals','ExpandBaselineAsync','ExpandBaselineReportAsync','ExtendBaselineReportByBaselineAsync','ExtendBaselineReportByCandidateAsync','FreezeBaselineAsync','GetAnnotationByAnnotationIdAsync','GetAnnotationByReplyCardIdAsync','GetAnnotationListAsync','GetAnnotationListByAnnotationIdAsync','GetApplicationVersionAsync','GetBackgroundTaskAsync','GetBackgroundTaskContentAsync','GetBackgroundTaskListAsync','GetBaselineAsync','GetBaselineEntryListAsync','GetBaselineListAsync','GetCurrentUserAsync','GetDocumentObjectByLanguageCardIdAsync','GetDocumentObjectByLogicalIdAsync','GetDocumentObjectContentByLanguageCardIdAsync','GetDocumentObjectContentByLogicalIdAsync','GetDocumentObjectContentInfoByLanguageCardIdAsync','GetDocumentObjectListAsync','GetDocumentObjectListByLanguageCardIdAsync','GetDocumentObjectListByLogicalIdAsync','GetDocumentObjectListByVersionAndLanguageFilterAsync','GetDocumentObjectListByVersionFilterAsync','GetDocumentObjectListUsingConditionNameAsync','GetDocumentObjectListUsingConditionValueAsync','GetDocumentObjectListUsingDocumentObjectAsync','GetDocumentObjectListUsingVariableAsync','GetDocumentObjectLocationAsync','GetDocumentObjectPossibleTargetStatusListAsync','GetDocumentObjectPossibleTargetStatusListByLanguageCardIdAsync','GetDocumentObjectReferenceListByLanguageCardIdAsync','GetDocumentObjectSmartTagListByLanguageCardIdAsync','GetElectronicDocumentTypeAsync','GetElectronicDocumentTypeListAsync','GetEventByDetailIdAsync','GetEventByEventIdAsync','GetEventByProgressIdAsync','GetEventByProgressIdOverviewAsync','GetEventContentByDetailIdAsync','GetEventGroupsAsync','GetEventListByParentProgressIdAsync','GetEventListByProgressIdAsync','GetEventOverviewAsync','GetFieldDefinitionsSettingsAsync','GetFolderAsync','GetFolderByFolderPathAsync','GetFolderListAsync','GetFolderLocationAsync','GetFolderObjectListAsync','GetHashCode','GetInboxListAsync','GetInboxObjectListAsync','GetLovListAsync','GetLovValueAsync','GetLovValueListAsync','GetMetadataBindingSmartTagsAsync','GetMetadataBindingTagListAsync','GetMetadataBindingTagStructureAsync','GetMyPreferencesAsync','GetMyPrivilegesAsync','GetObjectAsync','GetOutputFormatAsync','GetOutputFormatListAsync','GetProjectByAssigneeCardIdAsync','GetProjectByProjectIdAsync','GetProjectListAsync','GetProjectListByProjectIdAsync','GetPublicationByLanguageCardIdAsync','GetPublicationByLogicalIdAsync','GetPublicationContentByLanguageCardIdAsync','GetPublicationListAsync','GetPublicationListByLanguageCardIdAsync','GetPublicationListByLogicalIdAsync','GetPublicationListByVersionFilterAsync','GetPublicationListUsingBaselineAsync','GetPublicationListUsingDocumentObjectAsync','GetPublicationLocationAsync','GetPublicationPublishReportAsync','GetRootFolderListAsync','GetSettingsAsync','GetStatusDefinitionAsync','GetStatusDefinitionListAsync','GetTranslationJobAsync','GetTranslationJobListAsync','GetTranslationJobSourceObjectListAsync','GetTranslationJobTargetObjectListAsync','GetTranslationReportSettingsAsync','GetTranslationStatusListSettingsAsync','GetTranslationTemplateListAsync','GetType','GetUserAsync','GetUserGroupAsync','GetUserGroupListAsync','GetUserListAsync','GetUserPreferencesAsync','GetUserRoleAsync','GetUserRoleListAsync','GetWorkflowReportSettingsAsync','MoveFolderAsync','MoveObjectToFolderAsync','PublishPublicationAsync','ReleasePublicationAsync','RemoveShortcutFromFolderAsync','RetryTranslationJobAsync','SearchAsync','SearchInPublicationAsync','SendTranslationJobToTranslationAsync','SetMyPreferencesAsync','SetUserPreferencesAsync','TerminateEventAsync','ToString','UndoCheckoutDocumentObjectByLanguageCardIdAsync','UnpublishPublicationAsync','UnreleasePublicationAsync','UpdateAnnotationByAnnotationIdAsync','UpdateAnnotationByReplyCardIdAsync','UpdateBaselineAsync','UpdateBaselineEntryListAsync','UpdateCurrentUserAsync','UpdateDocumentObjectByLanguageCardIdAsync','UpdateDocumentObjectByLogicalIdAsync','UpdateDocumentObjectContentByLanguageCardIdAsync','UpdateElectronicDocumentTypeAsync','UpdateFolderAsync','UpdateLovValueAsync','UpdateOutputFormatAsync','UpdateProjectAssigneeAsync','UpdateProjectAsync','UpdatePublicationByLanguageCardIdAsync','UpdatePublicationByLogicalIdAsync','UpdateSettingsAsync','UpdateStatusDefinitionAsync','UpdateTranslationJobAsync','UpdateUserAsync','UpdateUserGroupAsync','UpdateUserRoleAsync' ) + # OpenApiAM10Client + # below array generated with: "@( '"+$(((Get-Member -InputObject $ishSession.OpenApiAM10Client -MemberType Method).Name) -join "','")+"' )" + # OperationId naming convention changed from CamelCase to Snake_Case + $openApiAM10ClientMembers20240404 = @( 'ApiResourcesGetAsync','ApiResourcesGetByIdAsync','ApplicationsCreateAsync','ApplicationsDeleteAsync','ApplicationsGetAsync','ApplicationsGetByIdAsync','ApplicationsUpdateAsync','AuditLogsGetByFilterAsync','AuditLogsGetByIdAsync','Equals','GetHashCode','GetType','IdentityProvidersCreateAsync','IdentityProvidersDeleteAsync','IdentityProvidersGetAsync','IdentityProvidersGetAvailableIdpTypesAsync','IdentityProvidersGetByIdAsync','IdentityProvidersGetIconAsync','IdentityProvidersGetLoginOptionsAsync','IdentityProvidersGetParametersForIdentityProviderTypeAsync','IdentityProvidersUpdateAsync','ServiceAccountsCreateAsync','ServiceAccountsDeleteAsync','ServiceAccountsDeleteClientSecretAsync','ServiceAccountsGenerateClientSecretAsync','ServiceAccountsGetAsync','ServiceAccountsGetByIdAsync','ServiceAccountsUpdateAsync','ServiceAccountsUpdateClientSecretAsync','SystemGetLoginStatusAsync','SystemGetSupportedCulturesAsync','SystemGetUserInfoAsync','ToString','UsersActivateUserAsync','UsersDeactivateUserAsync','UsersDeleteAsync','UsersDeleteClientSecretAsync','UsersGenerateClientSecretAsync','UsersGetAsync','UsersGetByIdAsync','UsersUpdateAsync','UsersUpdateClientSecretAsync' ) + $openApiAM10ClientMembers20251210 = @( 'ApiResources_GetAsync','ApiResources_GetByIdAsync','Applications_CreateAsync','Applications_DeleteAsync','Applications_GetAsync','Applications_GetByIdAsync','Applications_UpdateAsync','AuditLogs_GetByFilterAsync','AuditLogs_GetByIdAsync','Equals','GetHashCode','GetType','IdentityProviders_CreateAsync','IdentityProviders_DeleteAsync','IdentityProviders_GetAsync','IdentityProviders_GetAvailableIdpTypesAsync','IdentityProviders_GetByIdAsync','IdentityProviders_GetIconAsync','IdentityProviders_GetLoginOptionsAsync','IdentityProviders_GetParametersForIdentityProviderTypeAsync','IdentityProviders_UpdateAsync','ServiceAccounts_CreateAsync','ServiceAccounts_DeleteAsync','ServiceAccounts_DeleteClientSecretAsync','ServiceAccounts_GenerateClientSecretAsync','ServiceAccounts_GetAsync','ServiceAccounts_GetByIdAsync','ServiceAccounts_UpdateAsync','ServiceAccounts_UpdateClientSecretAsync','System_GetLoginStatusAsync','System_GetSupportedCulturesAsync','System_GetUserInfoAsync','ToString','Users_ActivateUserAsync','Users_DeactivateUserAsync','Users_DeleteAsync','Users_DeleteClientSecretAsync','Users_GenerateClientSecretAsync','Users_GetAsync','Users_GetByIdAsync','Users_UpdateAsync','Users_UpdateClientSecretAsync' ) } } It "IshSession.OpenApiISH30Client" { @@ -740,19 +750,26 @@ Describe "New-IshSession" -Tags "Read" { $json.Result | Should -Be $ishSession.ServerVersion } } - It "IshSession.OpenApiISH30Client OperationIds (20240404 methods exists)" { - # below array generated with: "@( '"+$(((Get-Member -InputObject $ishSession.OpenApiISH30Client -MemberType Method).Name) -join "','")+"' )" - $members20240404 = @( 'AddShortcutToFolderAsync','CancelPublicationPublishAsync','CheckInDocumentObjectByLanguageCardIdAsync','CheckOutDocumentObjectByLanguageCardIdAsync','CompleteBaselineAsync','CreateBackgroundTaskAsync','CreateDocumentObjectAsync','CreateDocumentObjectLanguageAsync','CreateDocumentObjectVersionAsync','CreateFolderAsync','CreateLovValueAsync','CreatePublicationAsync','CreatePublicationLanguageAsync','CreatePublicationVersionAsync','CreateStatusDefinitionAsync','CreateUserAsync','CreateUserGroupAsync','DeleteDocumentObjectByLanguageCardIdAsync','DeleteDocumentObjectByLogicalIdAsync','DeleteFolderAsync','DeleteLovValueAsync','DeletePublicationByLanguageCardIdAsync','DeletePublicationByLogicalIdAsync','DeleteStatusDefinitionAsync','DeleteUserAsync','DeleteUserGroupAsync','Equals','ExpandBaselineAsync','GetApplicationVersionAsync','GetBackgroundTaskByIdAsync','GetBaselineListAsync','GetCurrentUserAsync','GetDocumentObjectByLanguageCardIdAsync','GetDocumentObjectByLogicalIdAsync','GetDocumentObjectContentByLanguageCardIdAsync','GetDocumentObjectListAsync','GetDocumentObjectListByLanguageCardIdAsync','GetDocumentObjectListByLogicalIdAsync','GetDocumentObjectListUsingDocumentObjectAsync','GetDocumentObjectLocationAsync','GetDocumentObjectPossibleTargetStatusListAsync','GetDocumentObjectPossibleTargetStatusListByLanguageCardIdAsync','GetDocumentObjectReferenceListByLanguageCardIdAsync','GetFolderAsync','GetFolderListAsync','GetFolderLocationAsync','GetFolderObjectListAsync','GetHashCode','GetInboxListAsync','GetInboxObjectListAsync','GetLovListAsync','GetLovValueAsync','GetLovValueListAsync','GetMetadataBindingTagListAsync','GetMetadataBindingTagStructureAsync','GetMyPreferencesAsync','GetMyPrivilegesAsync','GetObjectAsync','GetPublicationByLanguageCardIdAsync','GetPublicationByLogicalIdAsync','GetPublicationContentByLanguageCardIdAsync','GetPublicationListAsync','GetPublicationListByLanguageCardIdAsync','GetPublicationListByLogicalIdAsync','GetPublicationListUsingDocumentObjectAsync','GetPublicationLocationAsync','GetRootFolderListAsync','GetSettingsAsync','GetStatusDefinitionAsync','GetStatusDefinitionListAsync','GetTranslationReportSettingsAsync','GetType','GetUserAsync','GetUserGroupListAsync','GetUserListAsync','GetUserPreferencesAsync','GetWorkflowReportSettingsAsync','MoveFolderAsync','MoveObjectToFolderAsync','PublishPublicationAsync','ReleasePublicationAsync','RemoveShortcutFromFolderAsync','SearchAsync','SetMyPreferencesAsync','SetUserPreferencesAsync','ToString','UndoCheckoutDocumentObjectByLanguageCardIdAsync','UnpublishPublicationAsync','UnreleasePublicationAsync','UpdateCurrentUserAsync','UpdateDocumentObjectByLanguageCardIdAsync','UpdateDocumentObjectByLogicalIdAsync','UpdateDocumentObjectContentByLanguageCardIdAsync','UpdateFolderAsync','UpdateLovValueAsync','UpdatePublicationByLanguageCardIdAsync','UpdatePublicationByLogicalIdAsync','UpdateSettingsAsync','UpdateStatusDefinitionAsync','UpdateUserAsync','UpdateUserGroupAsync' ) - foreach ($member in $members20240404) { - $localIShSession.OpenApiISH30Client.PSObject.Methods.Name | Should -Contain $member + It "IshSession.OpenApiISH30Client OperationIds (15.1 20240404 methods exists)" { + if (([Version]$ishSession.ServerVersion).Major -ge 15) { # new service since 15/15.0.0 + foreach ($member in $openApiISH30ClientMembers20240404) { + $localIShSession.OpenApiISH30Client.PSObject.Methods.Name | Should -Contain $member + } + } + } + It "IshSession.OpenApiISH30Client OperationIds (15.3 20251210 methods exists)" { + if ((([Version]$ishSession.ServerVersion).Major -ge 15) -and (([Version]$ishSession.ServerVersion).Minor -ge 2)) { # new service since 15.2/15.2.0 + foreach ($member in $openApiISH30ClientMembers20251210) { + $localIShSession.OpenApiISH30Client.PSObject.Methods.Name | Should -Contain $member + } } } It "IshSession.OpenApiISH30Client OperationIds (new methods found, adapt this test)" { - # below array generated with: "@( '"+$(((Get-Member -InputObject $ishSession.OpenApiISH30Client -MemberType Method).Name) -join "','")+"' )" - $members20240404 = @( 'AddShortcutToFolderAsync','CancelPublicationPublishAsync','CheckInDocumentObjectByLanguageCardIdAsync','CheckOutDocumentObjectByLanguageCardIdAsync','CompleteBaselineAsync','CreateBackgroundTaskAsync','CreateDocumentObjectAsync','CreateDocumentObjectLanguageAsync','CreateDocumentObjectVersionAsync','CreateFolderAsync','CreateLovValueAsync','CreatePublicationAsync','CreatePublicationLanguageAsync','CreatePublicationVersionAsync','CreateStatusDefinitionAsync','CreateUserAsync','CreateUserGroupAsync','DeleteDocumentObjectByLanguageCardIdAsync','DeleteDocumentObjectByLogicalIdAsync','DeleteFolderAsync','DeleteLovValueAsync','DeletePublicationByLanguageCardIdAsync','DeletePublicationByLogicalIdAsync','DeleteStatusDefinitionAsync','DeleteUserAsync','DeleteUserGroupAsync','Equals','ExpandBaselineAsync','GetApplicationVersionAsync','GetBackgroundTaskByIdAsync','GetBaselineListAsync','GetCurrentUserAsync','GetDocumentObjectByLanguageCardIdAsync','GetDocumentObjectByLogicalIdAsync','GetDocumentObjectContentByLanguageCardIdAsync','GetDocumentObjectListAsync','GetDocumentObjectListByLanguageCardIdAsync','GetDocumentObjectListByLogicalIdAsync','GetDocumentObjectListUsingDocumentObjectAsync','GetDocumentObjectLocationAsync','GetDocumentObjectPossibleTargetStatusListAsync','GetDocumentObjectPossibleTargetStatusListByLanguageCardIdAsync','GetDocumentObjectReferenceListByLanguageCardIdAsync','GetFolderAsync','GetFolderListAsync','GetFolderLocationAsync','GetFolderObjectListAsync','GetHashCode','GetInboxListAsync','GetInboxObjectListAsync','GetLovListAsync','GetLovValueAsync','GetLovValueListAsync','GetMetadataBindingTagListAsync','GetMetadataBindingTagStructureAsync','GetMyPreferencesAsync','GetMyPrivilegesAsync','GetObjectAsync','GetPublicationByLanguageCardIdAsync','GetPublicationByLogicalIdAsync','GetPublicationContentByLanguageCardIdAsync','GetPublicationListAsync','GetPublicationListByLanguageCardIdAsync','GetPublicationListByLogicalIdAsync','GetPublicationListUsingDocumentObjectAsync','GetPublicationLocationAsync','GetRootFolderListAsync','GetSettingsAsync','GetStatusDefinitionAsync','GetStatusDefinitionListAsync','GetTranslationReportSettingsAsync','GetType','GetUserAsync','GetUserGroupListAsync','GetUserListAsync','GetUserPreferencesAsync','GetWorkflowReportSettingsAsync','MoveFolderAsync','MoveObjectToFolderAsync','PublishPublicationAsync','ReleasePublicationAsync','RemoveShortcutFromFolderAsync','SearchAsync','SetMyPreferencesAsync','SetUserPreferencesAsync','ToString','UndoCheckoutDocumentObjectByLanguageCardIdAsync','UnpublishPublicationAsync','UnreleasePublicationAsync','UpdateCurrentUserAsync','UpdateDocumentObjectByLanguageCardIdAsync','UpdateDocumentObjectByLogicalIdAsync','UpdateDocumentObjectContentByLanguageCardIdAsync','UpdateFolderAsync','UpdateLovValueAsync','UpdatePublicationByLanguageCardIdAsync','UpdatePublicationByLogicalIdAsync','UpdateSettingsAsync','UpdateStatusDefinitionAsync','UpdateUserAsync','UpdateUserGroupAsync' ) - foreach ($member in $localIShSession.OpenApiISH30Client.PSObject.Methods.Name) { - if ($member -notin @('Equals','GetHashCode','GetType','ToString','get_BaseUrl','set_BaseUrl','get_ReadResponseAsString','set_ReadResponseAsString')) { - $members20240404 | Should -Contain $member + if (([Version]$ishSession.ServerVersion).Major -ge 15) { # new service since 15/15.0.0 + foreach ($member in $localIShSession.OpenApiISH30Client.PSObject.Methods.Name) { + if ($member -notin @('Equals','GetHashCode','GetType','ToString','get_BaseUrl','set_BaseUrl','get_ReadResponseAsString','set_ReadResponseAsString')) { + $openApiISH30ClientMembers20251210 | Should -Contain $member + } } } } @@ -763,18 +780,14 @@ Describe "New-IshSession" -Tags "Read" { } } It "IshSession.OpenApiAM10Client OperationIds (20240404 methods exists)" { - # below array generated with: "@( '"+$(((Get-Member -InputObject $ishSession.OpenApiAM10Client -MemberType Method).Name) -join "','")+"' )" - $members20240404 = @( 'ApiResourcesGetAsync','ApiResourcesGetByIdAsync','ApplicationsCreateAsync','ApplicationsDeleteAsync','ApplicationsGetAsync','ApplicationsGetByIdAsync','ApplicationsUpdateAsync','AuditLogsGetByFilterAsync','AuditLogsGetByIdAsync','Equals','GetHashCode','GetType','IdentityProvidersCreateAsync','IdentityProvidersDeleteAsync','IdentityProvidersGetAsync','IdentityProvidersGetAvailableIdpTypesAsync','IdentityProvidersGetByIdAsync','IdentityProvidersGetIconAsync','IdentityProvidersGetLoginOptionsAsync','IdentityProvidersGetParametersForIdentityProviderTypeAsync','IdentityProvidersUpdateAsync','ServiceAccountsCreateAsync','ServiceAccountsDeleteAsync','ServiceAccountsDeleteClientSecretAsync','ServiceAccountsGenerateClientSecretAsync','ServiceAccountsGetAsync','ServiceAccountsGetByIdAsync','ServiceAccountsUpdateAsync','ServiceAccountsUpdateClientSecretAsync','SystemGetLoginStatusAsync','SystemGetSupportedCulturesAsync','SystemGetUserInfoAsync','ToString','UsersActivateUserAsync','UsersDeactivateUserAsync','UsersDeleteAsync','UsersDeleteClientSecretAsync','UsersGenerateClientSecretAsync','UsersGetAsync','UsersGetByIdAsync','UsersUpdateAsync','UsersUpdateClientSecretAsync' ) - foreach ($member in $members20240404) { + foreach ($member in $openApiAM10ClientMembers20240404) { $localIShSession.OpenApiAM10Client.PSObject.Methods.Name | Should -Contain $member } } It "IshSession.OpenApiAM10Client OperationIds (new methods found, adapt this test)" { - # below array generated with: "@( '"+$(((Get-Member -InputObject $ishSession.OpenApiAM10Client -MemberType Method).Name) -join "','")+"' )" - $members20240404 = @( 'ApiResourcesGetAsync','ApiResourcesGetByIdAsync','ApplicationsCreateAsync','ApplicationsDeleteAsync','ApplicationsGetAsync','ApplicationsGetByIdAsync','ApplicationsUpdateAsync','AuditLogsGetByFilterAsync','AuditLogsGetByIdAsync','Equals','GetHashCode','GetType','IdentityProvidersCreateAsync','IdentityProvidersDeleteAsync','IdentityProvidersGetAsync','IdentityProvidersGetAvailableIdpTypesAsync','IdentityProvidersGetByIdAsync','IdentityProvidersGetIconAsync','IdentityProvidersGetLoginOptionsAsync','IdentityProvidersGetParametersForIdentityProviderTypeAsync','IdentityProvidersUpdateAsync','ServiceAccountsCreateAsync','ServiceAccountsDeleteAsync','ServiceAccountsDeleteClientSecretAsync','ServiceAccountsGenerateClientSecretAsync','ServiceAccountsGetAsync','ServiceAccountsGetByIdAsync','ServiceAccountsUpdateAsync','ServiceAccountsUpdateClientSecretAsync','SystemGetLoginStatusAsync','SystemGetSupportedCulturesAsync','SystemGetUserInfoAsync','ToString','UsersActivateUserAsync','UsersDeactivateUserAsync','UsersDeleteAsync','UsersDeleteClientSecretAsync','UsersGenerateClientSecretAsync','UsersGetAsync','UsersGetByIdAsync','UsersUpdateAsync','UsersUpdateClientSecretAsync' ) foreach ($member in $localIShSession.OpenApiAM10Client.PSObject.Methods.Name) { if ($member -notin @('Equals','GetHashCode','GetType','ToString','get_BaseUrl','set_BaseUrl','get_ReadResponseAsString','set_ReadResponseAsString')) { - $members20240404 | Should -Contain $member + $openApiAM10ClientMembers20240404 | Should -Contain $member } } } From b8bada232c8d1c5df1f45341389748bb7eeeeecf Mon Sep 17 00:00:00 2001 From: ddemeyer Date: Fri, 9 Jan 2026 19:48:07 +0100 Subject: [PATCH 3/3] #223 Added Pester tests based on 20251012 members. Refreshed OpenAPIAM10Client, no code changes but all OperationIds changed.... Probably not many scripts use OpenAPI proxies so could be resolved with breaking change documentation. --- .../Cmdlets/Session/NewIshSession.Tests.ps1 | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Source/ISHRemote/Trisoft.ISHRemote/Cmdlets/Session/NewIshSession.Tests.ps1 b/Source/ISHRemote/Trisoft.ISHRemote/Cmdlets/Session/NewIshSession.Tests.ps1 index 9586a967..51acb2d6 100644 --- a/Source/ISHRemote/Trisoft.ISHRemote/Cmdlets/Session/NewIshSession.Tests.ps1 +++ b/Source/ISHRemote/Trisoft.ISHRemote/Cmdlets/Session/NewIshSession.Tests.ps1 @@ -739,9 +739,10 @@ Describe "New-IshSession" -Tags "Read" { $openApiISH30ClientMembers20251210 = @( 'AddShortcutToFolderAsync','AddTranslationJobSourceObjectsAsync','CancelPublicationPublishAsync','CancelTranslationJobAsync','CheckInDocumentObjectByLanguageCardIdAsync','CheckOutDocumentObjectByLanguageCardIdAsync','CleanUpBaselineAsync','CompleteBaselineAsync','CompleteBaselineReportAsync','CopyBaselineAsync','CreateAnnotationAsync','CreateAnnotationReplyAsync','CreateBackgroundTaskAsync','CreateBackgroundTaskForDocumentObjectByLanguageCardIdAsync','CreateBaselineAsync','CreateDocumentObjectAsync','CreateDocumentObjectLanguageAsync','CreateDocumentObjectVersionAsync','CreateElectronicDocumentTypeAsync','CreateEventAsync','CreateEventDetailAsync','CreateFolderAsync','CreateLovValueAsync','CreateOutputFormatAsync','CreateProjectAssigneeAsync','CreateProjectAsync','CreatePublicationAsync','CreatePublicationLanguageAsync','CreatePublicationVersionAsync','CreateStatusDefinitionAsync','CreateTranslationJobAsync','CreateUserAsync','CreateUserGroupAsync','CreateUserRoleAsync','DeleteAnnotationByAnnotationIdAsync','DeleteAnnotationByReplyCardIdAsync','DeleteBaselineAsync','DeleteDocumentObjectByLanguageCardIdAsync','DeleteDocumentObjectByLogicalIdAsync','DeleteElectronicDocumentTypeAsync','DeleteEventAsync','DeleteFolderAsync','DeleteLovValueAsync','DeleteMyPreferencesAsync','DeleteOutputFormatAsync','DeleteProjectAssigneeAsync','DeleteProjectAsync','DeletePublicationByLanguageCardIdAsync','DeletePublicationByLogicalIdAsync','DeleteStatusDefinitionAsync','DeleteTranslationJobAsync','DeleteTranslationJobSourceObjectAsync','DeleteUserAsync','DeleteUserGroupAsync','DeleteUserPreferencesAsync','DeleteUserRoleAsync','Equals','ExpandBaselineAsync','ExpandBaselineReportAsync','ExtendBaselineReportByBaselineAsync','ExtendBaselineReportByCandidateAsync','FreezeBaselineAsync','GetAnnotationByAnnotationIdAsync','GetAnnotationByReplyCardIdAsync','GetAnnotationListAsync','GetAnnotationListByAnnotationIdAsync','GetApplicationVersionAsync','GetBackgroundTaskAsync','GetBackgroundTaskContentAsync','GetBackgroundTaskListAsync','GetBaselineAsync','GetBaselineEntryListAsync','GetBaselineListAsync','GetCurrentUserAsync','GetDocumentObjectByLanguageCardIdAsync','GetDocumentObjectByLogicalIdAsync','GetDocumentObjectContentByLanguageCardIdAsync','GetDocumentObjectContentByLogicalIdAsync','GetDocumentObjectContentInfoByLanguageCardIdAsync','GetDocumentObjectListAsync','GetDocumentObjectListByLanguageCardIdAsync','GetDocumentObjectListByLogicalIdAsync','GetDocumentObjectListByVersionAndLanguageFilterAsync','GetDocumentObjectListByVersionFilterAsync','GetDocumentObjectListUsingConditionNameAsync','GetDocumentObjectListUsingConditionValueAsync','GetDocumentObjectListUsingDocumentObjectAsync','GetDocumentObjectListUsingVariableAsync','GetDocumentObjectLocationAsync','GetDocumentObjectPossibleTargetStatusListAsync','GetDocumentObjectPossibleTargetStatusListByLanguageCardIdAsync','GetDocumentObjectReferenceListByLanguageCardIdAsync','GetDocumentObjectSmartTagListByLanguageCardIdAsync','GetElectronicDocumentTypeAsync','GetElectronicDocumentTypeListAsync','GetEventByDetailIdAsync','GetEventByEventIdAsync','GetEventByProgressIdAsync','GetEventByProgressIdOverviewAsync','GetEventContentByDetailIdAsync','GetEventGroupsAsync','GetEventListByParentProgressIdAsync','GetEventListByProgressIdAsync','GetEventOverviewAsync','GetFieldDefinitionsSettingsAsync','GetFolderAsync','GetFolderByFolderPathAsync','GetFolderListAsync','GetFolderLocationAsync','GetFolderObjectListAsync','GetHashCode','GetInboxListAsync','GetInboxObjectListAsync','GetLovListAsync','GetLovValueAsync','GetLovValueListAsync','GetMetadataBindingSmartTagsAsync','GetMetadataBindingTagListAsync','GetMetadataBindingTagStructureAsync','GetMyPreferencesAsync','GetMyPrivilegesAsync','GetObjectAsync','GetOutputFormatAsync','GetOutputFormatListAsync','GetProjectByAssigneeCardIdAsync','GetProjectByProjectIdAsync','GetProjectListAsync','GetProjectListByProjectIdAsync','GetPublicationByLanguageCardIdAsync','GetPublicationByLogicalIdAsync','GetPublicationContentByLanguageCardIdAsync','GetPublicationListAsync','GetPublicationListByLanguageCardIdAsync','GetPublicationListByLogicalIdAsync','GetPublicationListByVersionFilterAsync','GetPublicationListUsingBaselineAsync','GetPublicationListUsingDocumentObjectAsync','GetPublicationLocationAsync','GetPublicationPublishReportAsync','GetRootFolderListAsync','GetSettingsAsync','GetStatusDefinitionAsync','GetStatusDefinitionListAsync','GetTranslationJobAsync','GetTranslationJobListAsync','GetTranslationJobSourceObjectListAsync','GetTranslationJobTargetObjectListAsync','GetTranslationReportSettingsAsync','GetTranslationStatusListSettingsAsync','GetTranslationTemplateListAsync','GetType','GetUserAsync','GetUserGroupAsync','GetUserGroupListAsync','GetUserListAsync','GetUserPreferencesAsync','GetUserRoleAsync','GetUserRoleListAsync','GetWorkflowReportSettingsAsync','MoveFolderAsync','MoveObjectToFolderAsync','PublishPublicationAsync','ReleasePublicationAsync','RemoveShortcutFromFolderAsync','RetryTranslationJobAsync','SearchAsync','SearchInPublicationAsync','SendTranslationJobToTranslationAsync','SetMyPreferencesAsync','SetUserPreferencesAsync','TerminateEventAsync','ToString','UndoCheckoutDocumentObjectByLanguageCardIdAsync','UnpublishPublicationAsync','UnreleasePublicationAsync','UpdateAnnotationByAnnotationIdAsync','UpdateAnnotationByReplyCardIdAsync','UpdateBaselineAsync','UpdateBaselineEntryListAsync','UpdateCurrentUserAsync','UpdateDocumentObjectByLanguageCardIdAsync','UpdateDocumentObjectByLogicalIdAsync','UpdateDocumentObjectContentByLanguageCardIdAsync','UpdateElectronicDocumentTypeAsync','UpdateFolderAsync','UpdateLovValueAsync','UpdateOutputFormatAsync','UpdateProjectAssigneeAsync','UpdateProjectAsync','UpdatePublicationByLanguageCardIdAsync','UpdatePublicationByLogicalIdAsync','UpdateSettingsAsync','UpdateStatusDefinitionAsync','UpdateTranslationJobAsync','UpdateUserAsync','UpdateUserGroupAsync','UpdateUserRoleAsync' ) # OpenApiAM10Client # below array generated with: "@( '"+$(((Get-Member -InputObject $ishSession.OpenApiAM10Client -MemberType Method).Name) -join "','")+"' )" - # OperationId naming convention changed from CamelCase to Snake_Case - $openApiAM10ClientMembers20240404 = @( 'ApiResourcesGetAsync','ApiResourcesGetByIdAsync','ApplicationsCreateAsync','ApplicationsDeleteAsync','ApplicationsGetAsync','ApplicationsGetByIdAsync','ApplicationsUpdateAsync','AuditLogsGetByFilterAsync','AuditLogsGetByIdAsync','Equals','GetHashCode','GetType','IdentityProvidersCreateAsync','IdentityProvidersDeleteAsync','IdentityProvidersGetAsync','IdentityProvidersGetAvailableIdpTypesAsync','IdentityProvidersGetByIdAsync','IdentityProvidersGetIconAsync','IdentityProvidersGetLoginOptionsAsync','IdentityProvidersGetParametersForIdentityProviderTypeAsync','IdentityProvidersUpdateAsync','ServiceAccountsCreateAsync','ServiceAccountsDeleteAsync','ServiceAccountsDeleteClientSecretAsync','ServiceAccountsGenerateClientSecretAsync','ServiceAccountsGetAsync','ServiceAccountsGetByIdAsync','ServiceAccountsUpdateAsync','ServiceAccountsUpdateClientSecretAsync','SystemGetLoginStatusAsync','SystemGetSupportedCulturesAsync','SystemGetUserInfoAsync','ToString','UsersActivateUserAsync','UsersDeactivateUserAsync','UsersDeleteAsync','UsersDeleteClientSecretAsync','UsersGenerateClientSecretAsync','UsersGetAsync','UsersGetByIdAsync','UsersUpdateAsync','UsersUpdateClientSecretAsync' ) - $openApiAM10ClientMembers20251210 = @( 'ApiResources_GetAsync','ApiResources_GetByIdAsync','Applications_CreateAsync','Applications_DeleteAsync','Applications_GetAsync','Applications_GetByIdAsync','Applications_UpdateAsync','AuditLogs_GetByFilterAsync','AuditLogs_GetByIdAsync','Equals','GetHashCode','GetType','IdentityProviders_CreateAsync','IdentityProviders_DeleteAsync','IdentityProviders_GetAsync','IdentityProviders_GetAvailableIdpTypesAsync','IdentityProviders_GetByIdAsync','IdentityProviders_GetIconAsync','IdentityProviders_GetLoginOptionsAsync','IdentityProviders_GetParametersForIdentityProviderTypeAsync','IdentityProviders_UpdateAsync','ServiceAccounts_CreateAsync','ServiceAccounts_DeleteAsync','ServiceAccounts_DeleteClientSecretAsync','ServiceAccounts_GenerateClientSecretAsync','ServiceAccounts_GetAsync','ServiceAccounts_GetByIdAsync','ServiceAccounts_UpdateAsync','ServiceAccounts_UpdateClientSecretAsync','System_GetLoginStatusAsync','System_GetSupportedCulturesAsync','System_GetUserInfoAsync','ToString','Users_ActivateUserAsync','Users_DeactivateUserAsync','Users_DeleteAsync','Users_DeleteClientSecretAsync','Users_GenerateClientSecretAsync','Users_GetAsync','Users_GetByIdAsync','Users_UpdateAsync','Users_UpdateClientSecretAsync' ) + $openApiAM10ClientMembers20240404 = @( 'ApiResourcesGetAsync','ApiResourcesGetByIdAsync','ApplicationsCreateAsync','ApplicationsDeleteAsync','ApplicationsGetAsync','ApplicationsGetByIdAsync','ApplicationsUpdateAsync','AuditLogsGetByFilterAsync','AuditLogsGetByIdAsync','Equals','GetHashCode','GetType','IdentityProvidersCreateAsync','IdentityProvidersDeleteAsync','IdentityProvidersGetAsync','IdentityProvidersGetAvailableIdpTypesAsync','IdentityProvidersGetByIdAsync','IdentityProvidersGetIconAsync','IdentityProvidersGetLoginOptionsAsync','IdentityProvidersGetParametersForIdentityProviderTypeAsync','IdentityProvidersUpdateAsync','ServiceAccountsCreateAsync','ServiceAccountsDeleteAsync','ServiceAccountsDeleteClientSecretAsync','ServiceAccountsGenerateClientSecretAsync','ServiceAccountsGetAsync','ServiceAccountsGetByIdAsync','ServiceAccountsUpdateAsync','ServiceAccountsUpdateClientSecretAsync','SystemGetLoginStatusAsync','SystemGetSupportedCulturesAsync','SystemGetUserInfoAsync','ToString','UsersActivateUserAsync','UsersDeactivateUserAsync','UsersDeleteAsync','UsersDeleteClientSecretAsync','UsersGenerateClientSecretAsync','UsersGetAsync','UsersGetByIdAsync','UsersUpdateAsync','UsersUpdateClientSecretAsync' ) # Before v8.2 + $openApiAM10ClientMembers20251210 = @( 'ApiResources_GetAsync','ApiResources_GetByIdAsync','Applications_CreateAsync','Applications_DeleteAsync','Applications_GetAsync','Applications_GetByIdAsync','Applications_UpdateAsync','AuditLogs_GetByFilterAsync','AuditLogs_GetByIdAsync','Equals','GetHashCode','GetType','IdentityProviders_CreateAsync','IdentityProviders_DeleteAsync','IdentityProviders_GetAsync','IdentityProviders_GetAvailableIdpTypesAsync','IdentityProviders_GetByIdAsync','IdentityProviders_GetIconAsync','IdentityProviders_GetLoginOptionsAsync','IdentityProviders_GetParametersForIdentityProviderTypeAsync','IdentityProviders_UpdateAsync','ServiceAccounts_CreateAsync','ServiceAccounts_DeleteAsync','ServiceAccounts_DeleteClientSecretAsync','ServiceAccounts_GenerateClientSecretAsync','ServiceAccounts_GetAsync','ServiceAccounts_GetByIdAsync','ServiceAccounts_UpdateAsync','ServiceAccounts_UpdateClientSecretAsync','System_GetLoginStatusAsync','System_GetSupportedCulturesAsync','System_GetUserInfoAsync','ToString','Users_ActivateUserAsync','Users_DeactivateUserAsync','Users_DeleteAsync','Users_DeleteClientSecretAsync','Users_GenerateClientSecretAsync','Users_GetAsync','Users_GetByIdAsync','Users_UpdateAsync','Users_UpdateClientSecretAsync' ) # Since v8.2 + # Up to ISHRemote v8.2 $ishSession.OpenApiAM10Client was CamelCase, chose to break and align to Snake_Case as delivered by Access Management since v2.0.0 so Tridion Docs 15.0.0 + $openApiAM10ClientMembers20240404 = $openApiAM10ClientMembers20251210 } } It "IshSession.OpenApiISH30Client" {