diff --git a/src/client/interfaces/Model.d.ts b/src/client/interfaces/Model.d.ts index 4125951d..979ba8cd 100644 --- a/src/client/interfaces/Model.d.ts +++ b/src/client/interfaces/Model.d.ts @@ -5,9 +5,9 @@ export interface Model { name: string; base: string; type: string; - template: string; - description: string | null; - extends: string | null; + template?: string; + description?: string; + extends: string[]; imports: string[]; properties: ModelProperty[]; enums: ModelEnum[]; diff --git a/src/client/interfaces/ModelEnum.ts b/src/client/interfaces/ModelEnum.ts index c2891d1c..1d3d9442 100644 --- a/src/client/interfaces/ModelEnum.ts +++ b/src/client/interfaces/ModelEnum.ts @@ -1,7 +1,7 @@ -import { ModelEnumProperty } from './ModelEnumProperty'; +import { ModelEnumValue } from './ModelEnumValue'; export interface ModelEnum { name: string; value: string; - values: ModelEnumProperty[]; + values: ModelEnumValue[]; } diff --git a/src/client/interfaces/ModelEnumProperty.ts b/src/client/interfaces/ModelEnumValue.ts similarity index 52% rename from src/client/interfaces/ModelEnumProperty.ts rename to src/client/interfaces/ModelEnumValue.ts index dcfca5ee..54ee622c 100644 --- a/src/client/interfaces/ModelEnumProperty.ts +++ b/src/client/interfaces/ModelEnumValue.ts @@ -1,5 +1,6 @@ -export interface ModelEnumProperty { +export interface ModelEnumValue { type: string; name: string; + description?: string; value: string | number; } diff --git a/src/client/interfaces/ModelProperties.d.ts b/src/client/interfaces/ModelProperties.d.ts deleted file mode 100644 index 002fce4f..00000000 --- a/src/client/interfaces/ModelProperties.d.ts +++ /dev/null @@ -1,8 +0,0 @@ -import { ModelProperty } from './ModelProperty'; -import { ModelEnum } from './ModelEnum'; - -export interface ModelProperties { - imports: string[]; - properties: ModelProperty[]; - enums: ModelEnum[]; -} diff --git a/src/client/interfaces/ModelProperty.d.ts b/src/client/interfaces/ModelProperty.d.ts index ac9ff157..a11706f7 100644 --- a/src/client/interfaces/ModelProperty.d.ts +++ b/src/client/interfaces/ModelProperty.d.ts @@ -2,9 +2,13 @@ export interface ModelProperty { name: string; type: string; base: string; - template: string | null; - description: string | null; + template?: string; + description?: string; + default?: any; required: boolean; + nullable: boolean; readOnly: boolean; + extends: string[]; imports: string[]; + properties: ModelProperty[]; } diff --git a/src/client/interfaces/Service.d.ts b/src/client/interfaces/Service.d.ts index f7ae6a69..b272a34c 100644 --- a/src/client/interfaces/Service.d.ts +++ b/src/client/interfaces/Service.d.ts @@ -1,5 +1,7 @@ +import { ServiceOperation } from './ServiceOperation'; + export interface Service { name: string; - base: string; - imports: []; + operations: ServiceOperation[]; + imports: string[]; } diff --git a/src/client/interfaces/ServiceOperation.d.ts b/src/client/interfaces/ServiceOperation.d.ts new file mode 100644 index 00000000..c1176312 --- /dev/null +++ b/src/client/interfaces/ServiceOperation.d.ts @@ -0,0 +1,23 @@ +import { ServiceOperationError } from './ServiceOperationError'; +import { ServiceOperationParameter } from './ServiceOperationParameter'; +import { Model } from './Model'; +import { ServiceOperationResponse } from './ServiceOperationResponse'; + +export interface ServiceOperation { + name: string; + summary?: string; + description?: string; + deprecated?: boolean; + method: string; + path: string; + parameters: ServiceOperationParameter[]; + parametersPath: ServiceOperationParameter[]; + parametersQuery: ServiceOperationParameter[]; + parametersForm: ServiceOperationParameter[]; + parametersHeader: ServiceOperationParameter[]; + parametersBody: ServiceOperationParameter | null; + models: Model[]; + errors: ServiceOperationError[]; + response: ServiceOperationResponse | null; + result: string; +} diff --git a/src/client/interfaces/ServiceOperationError.d.ts b/src/client/interfaces/ServiceOperationError.d.ts new file mode 100644 index 00000000..815b44a1 --- /dev/null +++ b/src/client/interfaces/ServiceOperationError.d.ts @@ -0,0 +1,4 @@ +export interface ServiceOperationError { + code: number; + text: string; +} diff --git a/src/client/interfaces/ServiceOperationParameter.ts b/src/client/interfaces/ServiceOperationParameter.ts new file mode 100644 index 00000000..aa5dbe29 --- /dev/null +++ b/src/client/interfaces/ServiceOperationParameter.ts @@ -0,0 +1,13 @@ +export interface ServiceOperationParameter { + name: string; + type: string; + base: string; + template: string; + description: string; + default?: any; + required: boolean; + nullable: boolean; + // extends: string[]; + // imports: string[]; + // properties: ModelProperty[]; +} diff --git a/src/client/interfaces/ServiceOperationResponse.ts b/src/client/interfaces/ServiceOperationResponse.ts new file mode 100644 index 00000000..a710433d --- /dev/null +++ b/src/client/interfaces/ServiceOperationResponse.ts @@ -0,0 +1,5 @@ +export interface ServiceOperationResponse { + code: number; + text: string; + property: any; +} diff --git a/src/index.ts b/src/index.ts index 4786806b..e276d24a 100644 --- a/src/index.ts +++ b/src/index.ts @@ -20,7 +20,7 @@ export enum HttpClient { /** * Generate the OpenAPI client. This method will read the OpenAPI specification and based on the - * given language it will generate the client, including the types models, validation schemas, + * given language it will generate the client, including the typed models, validation schemas, * service layer, etc. * @param input The relative location of the OpenAPI spec. * @param output The relative location of the output directory @@ -39,6 +39,8 @@ export function generate(input: string, output: string, language: Language = Lan console.log(os.EOL); try { + // Load the specification, read the OpenAPI version and load the + // handlebar templates for the given language const openApi = getOpenApiSpec(inputPath); const openApiVersion = getOpenApiVersion(openApi); const templates = readHandlebarsTemplates(language); diff --git a/src/openApi/v2/index.ts b/src/openApi/v2/index.ts index 77d74608..e5f50606 100644 --- a/src/openApi/v2/index.ts +++ b/src/openApi/v2/index.ts @@ -5,6 +5,11 @@ import { getServices } from './parser/getServices'; import { getModels } from './parser/getModels'; import { getSchemas } from './parser/getSchemas'; +/** + * Parse the OpenAPI specification to a Client model that contains + * all the models, services and schema's we should output. + * @param openApi The OpenAPI spec that we have loaded from disk. + */ export function parse(openApi: OpenApi): Client { return { version: openApi.info.version, diff --git a/src/openApi/v2/interfaces/OpenApiHeader.d.ts b/src/openApi/v2/interfaces/OpenApiHeader.d.ts index 4e7c67d5..83c2a7e0 100644 --- a/src/openApi/v2/interfaces/OpenApiHeader.d.ts +++ b/src/openApi/v2/interfaces/OpenApiHeader.d.ts @@ -21,6 +21,6 @@ export interface OpenApiHeader { maxItems?: number; minItems?: number; uniqueItems?: boolean; - enum?: string[] | number[]; + enum?: (string | number)[]; multipleOf?: number; } diff --git a/src/openApi/v2/interfaces/OpenApiItems.d.ts b/src/openApi/v2/interfaces/OpenApiItems.d.ts index 30ae5292..dca05ad6 100644 --- a/src/openApi/v2/interfaces/OpenApiItems.d.ts +++ b/src/openApi/v2/interfaces/OpenApiItems.d.ts @@ -17,6 +17,6 @@ export interface OpenApiItems { maxItems?: number; minItems?: number; uniqueItems?: number; - enum?: string[] | number[]; + enum?: (string | number)[]; multipleOf?: number; } diff --git a/src/openApi/v2/interfaces/OpenApiOperation.d.ts b/src/openApi/v2/interfaces/OpenApiOperation.d.ts index 47baf76c..3ebfdc2d 100644 --- a/src/openApi/v2/interfaces/OpenApiOperation.d.ts +++ b/src/openApi/v2/interfaces/OpenApiOperation.d.ts @@ -15,7 +15,7 @@ export interface OpenApiOperation { operationId?: string; consumes?: string[]; produces?: string[]; - parameters?: OpenApiParameter[] | OpenApiReference[]; + parameters?: (OpenApiParameter & OpenApiReference)[]; responses: OpenApiResponses; schemes: ('http' | 'https' | 'ws' | 'wss')[]; deprecated?: boolean; diff --git a/src/openApi/v2/interfaces/OpenApiParameter.d.ts b/src/openApi/v2/interfaces/OpenApiParameter.d.ts index 14df84dc..ec8e2cac 100644 --- a/src/openApi/v2/interfaces/OpenApiParameter.d.ts +++ b/src/openApi/v2/interfaces/OpenApiParameter.d.ts @@ -26,6 +26,6 @@ export interface OpenApiParameter { maxItems?: number; minItems?: number; uniqueItems?: boolean; - enum?: string[] | number[]; + enum?: (string | number)[]; multipleOf?: number; } diff --git a/src/openApi/v2/interfaces/OpenApiPath.d.ts b/src/openApi/v2/interfaces/OpenApiPath.d.ts index 315ab8a7..2274d891 100644 --- a/src/openApi/v2/interfaces/OpenApiPath.d.ts +++ b/src/openApi/v2/interfaces/OpenApiPath.d.ts @@ -6,7 +6,6 @@ import { OpenApiReference } from './OpenApiReference'; * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#pathItemObject */ export interface OpenApiPath { - $ref?: string; get?: OpenApiOperation; put?: OpenApiOperation; post?: OpenApiOperation; @@ -14,5 +13,5 @@ export interface OpenApiPath { options?: OpenApiOperation; head?: OpenApiOperation; patch?: OpenApiOperation; - parameters?: OpenApiParameter[] | OpenApiReference[]; + parameters?: (OpenApiParameter & OpenApiReference)[]; } diff --git a/src/openApi/v2/interfaces/OpenApiReference.d.ts b/src/openApi/v2/interfaces/OpenApiReference.d.ts index 8c8e97d0..cbf3253d 100644 --- a/src/openApi/v2/interfaces/OpenApiReference.d.ts +++ b/src/openApi/v2/interfaces/OpenApiReference.d.ts @@ -2,5 +2,5 @@ * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#referenceObject */ export interface OpenApiReference { - $ref: string; + $ref?: string; } diff --git a/src/openApi/v2/interfaces/OpenApiResponses.d.ts b/src/openApi/v2/interfaces/OpenApiResponses.d.ts index 4d8c88a1..d8492f79 100644 --- a/src/openApi/v2/interfaces/OpenApiResponses.d.ts +++ b/src/openApi/v2/interfaces/OpenApiResponses.d.ts @@ -5,7 +5,7 @@ import { OpenApiResponse } from './OpenApiResponse'; * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#responsesObject */ export interface OpenApiResponses { - [httpcode: string]: OpenApiResponse | OpenApiReference; + [httpcode: string]: OpenApiResponse & OpenApiReference; - default: OpenApiResponse | OpenApiReference; + default: OpenApiResponse & OpenApiReference; } diff --git a/src/openApi/v2/interfaces/OpenApiSchema.d.ts b/src/openApi/v2/interfaces/OpenApiSchema.d.ts index 452846de..57bfb7f4 100644 --- a/src/openApi/v2/interfaces/OpenApiSchema.d.ts +++ b/src/openApi/v2/interfaces/OpenApiSchema.d.ts @@ -7,7 +7,6 @@ import { OpenApiXml } from './OpenApiXml'; * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#schemaObject */ export interface OpenApiSchema { - $ref?: string; format?: 'int32' | 'int64' | 'float' | 'double' | 'string' | 'boolean' | 'byte' | 'binary' | 'date' | 'date-time' | 'password'; title?: string; description?: string; @@ -26,12 +25,12 @@ export interface OpenApiSchema { maxProperties?: number; minProperties?: number; required?: string[]; - enum?: string[] | number[]; + enum?: (string | number)[]; type?: string; - items?: OpenApiReference | OpenApiSchema; - allOf?: OpenApiReference[] | OpenApiSchema[]; - properties?: Dictionary; - additionalProperties?: boolean | OpenApiReference | OpenApiSchema; + items?: OpenApiSchema & OpenApiReference; + allOf?: (OpenApiSchema & OpenApiReference)[]; + properties?: Dictionary; + additionalProperties?: boolean | (OpenApiSchema & OpenApiReference); discriminator?: string; readOnly?: boolean; xml?: OpenApiXml; diff --git a/src/openApi/v2/parser/getModelProperty.ts b/src/openApi/v2/parser/getModelProperty.ts index d5f7ec29..811e9b22 100644 --- a/src/openApi/v2/parser/getModelProperty.ts +++ b/src/openApi/v2/parser/getModelProperty.ts @@ -1,14 +1,100 @@ import { ModelProperty } from '../../../client/interfaces/ModelProperty'; +import { OpenApiSchema } from '../interfaces/OpenApiSchema'; +import { OpenApiReference } from '../interfaces/OpenApiReference'; +import { getType } from './getType'; -export function parseModelProperty(): ModelProperty { - return { - name: '', +export function getModelProperty(name: string, schema: OpenApiSchema & OpenApiReference): ModelProperty { + /** + $ref?: string; + format?: 'int32' | 'int64' | 'float' | 'double' | 'string' | 'boolean' | 'byte' | 'binary' | 'date' | 'date-time' | 'password'; + title?: string; + description?: string; + default?: any; + multipleOf?: number; + maximum?: number; + exclusiveMaximum?: boolean; + minimum?: number; + exclusiveMinimum?: boolean; + maxLength?: number; + minLength?: number; + pattern?: string; + maxItems?: number; + minItems?: number; + uniqueItems?: number; + maxProperties?: number; + minProperties?: number; + required?: string[]; + enum?: string[] | number[]; + type?: string; + items?: OpenApiReference | OpenApiSchema; + allOf?: OpenApiReference[] | OpenApiSchema[]; + properties?: Dictionary; + additionalProperties?: boolean | OpenApiReference | OpenApiSchema; + discriminator?: string; + readOnly?: boolean; + xml?: OpenApiXml; + externalDocs?: OpenApiExternalDocs; + example?: any; + */ + + const prop: ModelProperty = { + name: name, type: '', base: '', template: '', - description: null, + description: schema.description, + default: schema.default, required: false, - readOnly: false, + nullable: false, + readOnly: schema.readOnly || false, imports: [], + extends: [], + properties: [], }; + + if (schema.$ref) { + // console.log('parse $ref?'); + } + + if (schema.properties || schema.type === 'object') { + prop.type = 'interface'; + // type is interface!? + } + + if (schema.enum) { + prop.type = 'enum'; + // type is enum! + } + + console.log('propertyName:', schema); + console.log('format:', schema.format); + console.log('type:', schema.type); + + const properties = schema.properties; + for (const propertyName in properties) { + if (properties.hasOwnProperty(propertyName)) { + const property = properties[propertyName]; + console.log('propertyName', propertyName); + // getModelProperty(propertyName, property); + } + } + + if (schema.allOf) { + schema.allOf.forEach(parent => { + if (parent.$ref) { + const extend = getType(parent.$ref); + prop.extends.push(extend.type); + prop.imports.push(extend.base); + } + if (parent.properties) { + console.log(parent.properties); + // const properties: ParsedModelProperties = parseModelProperties(modelClass, definition.allOf[1].properties as SwaggerDefinitions, required); + // model.imports.push(...properties.imports); + // model.properties.push(...properties.properties); + // model.enums.push(...properties.enums); + } + }); + } + + return prop; } diff --git a/src/openApi/v2/parser/getModels.ts b/src/openApi/v2/parser/getModels.ts index b0cc560a..7b662962 100644 --- a/src/openApi/v2/parser/getModels.ts +++ b/src/openApi/v2/parser/getModels.ts @@ -1,7 +1,6 @@ import { Model } from '../../../client/interfaces/Model'; import { OpenApi } from '../interfaces/OpenApi'; import { getType } from './getType'; -import { getModelTemplate } from './getModelTemplate'; /** * Parse and return the OpenAPI models. @@ -9,26 +8,40 @@ import { getModelTemplate } from './getModelTemplate'; */ export function getModels(openApi: OpenApi): Map { const models = new Map(); + + // Iterate over the definitions const definitions = openApi.definitions; for (const definitionName in definitions) { if (definitions.hasOwnProperty(definitionName)) { const definition = definitions[definitionName]; const required = definition.required || []; const modelClass = getType(definitionName); - const modelTemplate: string = getModelTemplate(modelClass); + + // Check if we haven't already parsed the model if (!models.has(modelClass.base)) { - const model: Model = { - name: modelClass.base, - base: modelClass.base, - type: modelClass.type, - template: modelTemplate, - description: null, - extends: null, - imports: [], - properties: [], - enums: [], - }; - models.set(modelClass.base, model); + // // Create a new model object + // const model: Model = { + // name: modelClass.base, + // base: modelClass.base, + // type: modelClass.type, + // template: getModelTemplate(modelClass), + // description: null, + // extends: [], + // imports: [], + // properties: [], + // enums: [], + // }; + // + // const properties = definition.properties; + // for (const propertyName in properties) { + // if (properties.hasOwnProperty(propertyName)) { + // const property = properties[propertyName]; + // const propertyRequired = required.includes(propertyName); + // getModelProperty(propertyName, property); + // } + // } + // + // models.set(modelClass.base, model); } } } diff --git a/src/openApi/v2/parser/getServiceOperationErrors.ts b/src/openApi/v2/parser/getServiceOperationErrors.ts new file mode 100644 index 00000000..90d58257 --- /dev/null +++ b/src/openApi/v2/parser/getServiceOperationErrors.ts @@ -0,0 +1,16 @@ +import { ServiceOperationResponse } from '../../../client/interfaces/ServiceOperationResponse'; +import { ServiceOperationError } from '../../../client/interfaces/ServiceOperationError'; + +/** + * Get list of service errors. + * @param responses List of parsed service responses. + * @returns List of service errors containing the error code and message. + */ +export function getServiceOperationErrors(responses: ServiceOperationResponse[]): ServiceOperationError[] { + return responses + .filter((response: ServiceOperationResponse): boolean => response.code >= 300 && response.text !== undefined && response.text !== '') + .map(response => ({ + code: response.code, + text: response.text, + })); +} diff --git a/src/openApi/v2/parser/getServiceOperationPath.spec.ts b/src/openApi/v2/parser/getServiceOperationPath.spec.ts new file mode 100644 index 00000000..a350a1d1 --- /dev/null +++ b/src/openApi/v2/parser/getServiceOperationPath.spec.ts @@ -0,0 +1,10 @@ +import { getServiceOperationPath } from './getServiceOperationPath'; + +describe('getServiceOperationPath', () => { + it('should produce correct result', () => { + expect(getServiceOperationPath('/api/v{api-version}/list/{id}/{type}')).toEqual('/api/v${OpenAPI.VERSION}/list/${id}/${type}'); + expect(getServiceOperationPath('/api/v{api-version}/list/{id}')).toEqual('/api/v${OpenAPI.VERSION}/list/${id}'); + expect(getServiceOperationPath('/api/v1/list/{id}')).toEqual('/api/v1/list/${id}'); + expect(getServiceOperationPath('/api/v1/list')).toEqual('/api/v1/list'); + }); +}); diff --git a/src/openApi/v2/parser/getServicePath.ts b/src/openApi/v2/parser/getServiceOperationPath.ts similarity index 84% rename from src/openApi/v2/parser/getServicePath.ts rename to src/openApi/v2/parser/getServiceOperationPath.ts index c1fd8124..1cfb106f 100644 --- a/src/openApi/v2/parser/getServicePath.ts +++ b/src/openApi/v2/parser/getServiceOperationPath.ts @@ -4,6 +4,6 @@ * OpenAPI version without the need to hardcode this in the URL. * @param path */ -export function getServicePath(path: string): string { +export function getServiceOperationPath(path: string): string { return path.replace(/{api-version}/g, '{OpenAPI.VERSION}').replace(/\{(.*?)\}/g, '${$1}'); } diff --git a/src/openApi/v2/parser/getServiceOperationResponseCode.ts b/src/openApi/v2/parser/getServiceOperationResponseCode.ts new file mode 100644 index 00000000..39899034 --- /dev/null +++ b/src/openApi/v2/parser/getServiceOperationResponseCode.ts @@ -0,0 +1,16 @@ +export function getServiceOperationResponsesCode(value: string | 'default'): number | null { + // You can specify a "default" response, this is treated as HTTP code 200 + if (value === 'default') { + return 200; + } + + // Check if we can parse the code and return of successful. + if (/[0-9]+/g.test(value)) { + const code = parseInt(value); + if (Number.isInteger(code)) { + return code; + } + } + + return null; +} diff --git a/src/openApi/v2/parser/getServiceOperationResponses.ts b/src/openApi/v2/parser/getServiceOperationResponses.ts new file mode 100644 index 00000000..5efbefee --- /dev/null +++ b/src/openApi/v2/parser/getServiceOperationResponses.ts @@ -0,0 +1,35 @@ +import { OpenApiResponses } from '../interfaces/OpenApiResponses'; +import { ServiceOperationResponse } from '../../../client/interfaces/ServiceOperationResponse'; +import { getServiceOperationResponsesCode } from './getServiceOperationResponseCode'; + +/** + * Parse the service response object into a list with status codes and response messages. + * @param responses Swagger responses. + * @returns List of status codes and response messages. + */ +export function getServiceOperationResponses(responses: OpenApiResponses): ServiceOperationResponse[] { + const result: ServiceOperationResponse[] = []; + + // Iterate over each response code. + for (const code in responses) { + if (responses.hasOwnProperty(code)) { + // Get the status code and response message (if any). + const response = responses[code]; + const responseCode = getServiceOperationResponsesCode(code); + const responseText = response.description || ''; + + if (responseCode) { + result.push({ + code: responseCode, + text: responseText, + property: undefined, + }); + } + } + } + + // Sort the responses to 2XX success codes come before 4XX and 5XX error codes. + return result.sort((a, b): number => { + return a.code < b.code ? -1 : a.code > b.code ? 1 : 0; + }); +} diff --git a/src/openApi/v2/parser/getServiceOperationResult.ts b/src/openApi/v2/parser/getServiceOperationResult.ts new file mode 100644 index 00000000..aeab76b9 --- /dev/null +++ b/src/openApi/v2/parser/getServiceOperationResult.ts @@ -0,0 +1,29 @@ +import { ServiceOperationResponse } from '../../../client/interfaces/ServiceOperationResponse'; + +export interface ServiceOperationResult { + type: string; + imports: string[]; +} + +/** + * Parse service result. + * @param responses List of service responses. + * @returns Object containing the result type and needed imports. + */ +export function getServiceOperationResult(responses: ServiceOperationResponse[]): ServiceOperationResult { + let resultType = 'any'; + let resultImports: string[] = []; + + // Fetch the first valid (2XX range) response code and return that type. + const result = responses.find(response => response.code && response.code >= 200 && response.code < 300 && response.property); + + if (result) { + resultType = result.property.type; + resultImports = [...result.property.imports]; + } + + return { + type: resultType, + imports: resultImports, + }; +} diff --git a/src/openApi/v2/parser/getServicePath.spec.ts b/src/openApi/v2/parser/getServicePath.spec.ts deleted file mode 100644 index 2e8ff3a2..00000000 --- a/src/openApi/v2/parser/getServicePath.spec.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { getServicePath } from './getServicePath'; - -describe('getServicePath', () => { - it('should produce correct result', () => { - expect(getServicePath('/api/v{api-version}/list/{id}/{type}')).toEqual('/api/v${OpenAPI.VERSION}/list/${id}/${type}'); - expect(getServicePath('/api/v{api-version}/list/{id}')).toEqual('/api/v${OpenAPI.VERSION}/list/${id}'); - expect(getServicePath('/api/v1/list/{id}')).toEqual('/api/v1/list/${id}'); - expect(getServicePath('/api/v1/list')).toEqual('/api/v1/list'); - }); -}); diff --git a/src/openApi/v2/parser/getServices.ts b/src/openApi/v2/parser/getServices.ts index ad4c8041..e4ed88b0 100644 --- a/src/openApi/v2/parser/getServices.ts +++ b/src/openApi/v2/parser/getServices.ts @@ -1,5 +1,62 @@ import { Service } from '../../../client/interfaces/Service'; import { OpenApi } from '../interfaces/OpenApi'; +import { OpenApiOperation } from '../interfaces/OpenApiOperation'; +import { getServiceClassName } from './getServiceClassName'; +import { getServiceOperationName } from './getServiceOperationName'; +import { getServiceOperationPath } from './getServiceOperationPath'; +import { ServiceOperation } from '../../../client/interfaces/ServiceOperation'; +import { getServiceOperationResponses } from './getServiceOperationResponses'; +import { getServiceOperationResult } from './getServiceOperationResult'; +import { getServiceOperationErrors } from './getServiceOperationErrors'; + +function getMethod(url: string, services: Map, op: OpenApiOperation, method: string): void { + const serviceName = (op.tags && op.tags[0]) || 'Service'; + const serviceClassName: string = getServiceClassName(serviceName); + const serviceOperationNameFallback = `${method}${serviceClassName}`; + const serviceOperationName: string = getServiceOperationName(op.operationId || serviceOperationNameFallback); + const servicePath: string = getServiceOperationPath(url); + + // If we have already declared a service, then we should fetch that and + // append the new method to it. Otherwise we should create a new service object. + const service = + services.get(serviceClassName) || + ({ + name: serviceClassName, + imports: [], + operations: [], + } as Service); + + // Create a new operation object for this method. + const operation: ServiceOperation = { + name: serviceOperationName, + summary: op.summary, + description: op.description, + deprecated: op.deprecated, + method: method, + path: servicePath, + parameters: [], + parametersPath: [], + parametersQuery: [], + parametersForm: [], + parametersHeader: [], + parametersBody: null, + models: [], + errors: [], + response: null, + result: 'any', + }; + + if (op.responses) { + const responses = getServiceOperationResponses(op.responses); + const result = getServiceOperationResult(responses); + operation.errors = getServiceOperationErrors(responses); + operation.result = result.type; + service.imports.push(...result.imports); + } + + service.operations.push(operation); + services.set(serviceClassName, service); +} /** * Parse and return the OpenAPI services. @@ -7,29 +64,15 @@ import { OpenApi } from '../interfaces/OpenApi'; */ export function getServices(openApi: OpenApi): Map { const services = new Map(); - const paths = openApi.paths; - for (const url in paths) { - if (paths.hasOwnProperty(url)) { - const path = paths[url]; - for (const method in path) { - if (path.hasOwnProperty(method)) { - switch (method) { - case 'get': - case 'put': - case 'post': - case 'delete': - case 'options': - case 'head': - case 'patch': - const op = path[method]; - if (op) { - // - } - break; - } - } - } - } - } + Object.keys(openApi.paths).forEach(url => { + const path = openApi.paths[url]; + path.get && getMethod(url, services, path.get, 'get'); + path.put && getMethod(url, services, path.put, 'put'); + path.post && getMethod(url, services, path.post, 'post'); + path.delete && getMethod(url, services, path.delete, 'delete'); + path.options && getMethod(url, services, path.options, 'options'); + path.head && getMethod(url, services, path.head, 'head'); + path.patch && getMethod(url, services, path.patch, 'patch'); + }); return services; } diff --git a/src/openApi/v3/index.ts b/src/openApi/v3/index.ts index e866df70..c8862a9a 100644 --- a/src/openApi/v3/index.ts +++ b/src/openApi/v3/index.ts @@ -5,6 +5,11 @@ import { getModels } from './parser/getModels'; import { getServices } from './parser/getServices'; import { getSchemas } from './parser/getSchemas'; +/** + * Parse the OpenAPI specification to a Client model that contains + * all the models, services and schema's we should output. + * @param openApi The OpenAPI spec that we have loaded from disk. + */ export function parse(openApi: OpenApi): Client { return { version: openApi.info.version, diff --git a/src/openApi/v3/interfaces/OpenApiComponents.d.ts b/src/openApi/v3/interfaces/OpenApiComponents.d.ts index 863c1a0f..c8564186 100644 --- a/src/openApi/v3/interfaces/OpenApiComponents.d.ts +++ b/src/openApi/v3/interfaces/OpenApiComponents.d.ts @@ -14,13 +14,13 @@ import { OpenApiSecurityScheme } from './OpenApiSecurityScheme'; * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#componentsObject */ export interface OpenApiComponents { - schemas?: Dictionary; - responses?: Dictionary; - parameters?: Dictionary; - examples?: Dictionary; - requestBodies?: Dictionary; - headers?: Dictionary; - securitySchemes: Dictionary; - links?: Dictionary; - callbacks?: Dictionary; + schemas?: Dictionary; + responses?: Dictionary; + parameters?: Dictionary; + examples?: Dictionary; + requestBodies?: Dictionary; + headers?: Dictionary; + securitySchemes: Dictionary; + links?: Dictionary; + callbacks?: Dictionary; } diff --git a/src/openApi/v3/interfaces/OpenApiEncoding.d.ts b/src/openApi/v3/interfaces/OpenApiEncoding.d.ts index af2cfd2d..300903ec 100644 --- a/src/openApi/v3/interfaces/OpenApiEncoding.d.ts +++ b/src/openApi/v3/interfaces/OpenApiEncoding.d.ts @@ -7,7 +7,7 @@ import { OpenApiReference } from './OpenApiReference'; */ export interface OpenApiEncoding { contentType?: string; - headers?: Dictionary; + headers?: Dictionary; style?: string; explode?: boolean; allowReserved?: boolean; diff --git a/src/openApi/v3/interfaces/OpenApiHeader.d.ts b/src/openApi/v3/interfaces/OpenApiHeader.d.ts index 58cd6ed3..30f86408 100644 --- a/src/openApi/v3/interfaces/OpenApiHeader.d.ts +++ b/src/openApi/v3/interfaces/OpenApiHeader.d.ts @@ -14,7 +14,7 @@ export interface OpenApiHeader { style?: string; explode?: boolean; allowReserved?: boolean; - schema?: OpenApiSchema | OpenApiReference; + schema?: OpenApiSchema & OpenApiReference; example?: any; - examples?: Dictionary; + examples?: Dictionary; } diff --git a/src/openApi/v3/interfaces/OpenApiMediaType.d.ts b/src/openApi/v3/interfaces/OpenApiMediaType.d.ts index b3dc30cc..66d31c14 100644 --- a/src/openApi/v3/interfaces/OpenApiMediaType.d.ts +++ b/src/openApi/v3/interfaces/OpenApiMediaType.d.ts @@ -8,8 +8,8 @@ import { OpenApiSchema } from './OpenApiSchema'; * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#mediaTypeObject */ export interface OpenApiMediaType { - schema?: OpenApiSchema | OpenApiReference; + schema?: OpenApiSchema & OpenApiReference; example?: any; - examples?: Dictionary; + examples?: Dictionary; encoding?: Dictionary; } diff --git a/src/openApi/v3/interfaces/OpenApiOperation.d.ts b/src/openApi/v3/interfaces/OpenApiOperation.d.ts index d9970cc8..52763d15 100644 --- a/src/openApi/v3/interfaces/OpenApiOperation.d.ts +++ b/src/openApi/v3/interfaces/OpenApiOperation.d.ts @@ -17,10 +17,10 @@ export interface OpenApiOperation { description?: string; externalDocs?: OpenApiExternalDocs; operationId?: string; - parameters?: OpenApiParameter[] | OpenApiReference[]; - requestBody?: OpenApiRequestBody | OpenApiReference; + parameters?: (OpenApiParameter & OpenApiReference)[]; + requestBody?: OpenApiRequestBody & OpenApiReference; responses: OpenApiResponses; - callbacks?: Dictionary; + callbacks?: Dictionary; deprecated?: boolean; security?: OpenApiSecurityRequirement[]; servers?: OpenApiServer[]; diff --git a/src/openApi/v3/interfaces/OpenApiParameter.d.ts b/src/openApi/v3/interfaces/OpenApiParameter.d.ts index c4cecab3..6fd22004 100644 --- a/src/openApi/v3/interfaces/OpenApiParameter.d.ts +++ b/src/openApi/v3/interfaces/OpenApiParameter.d.ts @@ -16,7 +16,7 @@ export interface OpenApiParameter { style?: string; explode?: boolean; allowReserved?: boolean; - schema?: OpenApiSchema | OpenApiReference; + schema?: OpenApiSchema & OpenApiReference; example?: any; - examples?: Dictionary; + examples?: Dictionary; } diff --git a/src/openApi/v3/interfaces/OpenApiPath.d.ts b/src/openApi/v3/interfaces/OpenApiPath.d.ts index 5ec8b993..22db9049 100644 --- a/src/openApi/v3/interfaces/OpenApiPath.d.ts +++ b/src/openApi/v3/interfaces/OpenApiPath.d.ts @@ -7,7 +7,6 @@ import { OpenApiServer } from './OpenApiServer'; * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#pathItemObject */ export interface OpenApiPath { - $ref?: string; summary?: string; description?: string; get?: OpenApiOperation; @@ -19,5 +18,5 @@ export interface OpenApiPath { patch?: OpenApiOperation; trace?: OpenApiOperation; servers?: OpenApiServer[]; - parameters?: OpenApiParameter[] | OpenApiReference[]; + parameters?: (OpenApiParameter & OpenApiReference)[]; } diff --git a/src/openApi/v3/interfaces/OpenApiReference.d.ts b/src/openApi/v3/interfaces/OpenApiReference.d.ts index 71d76b48..e3a1c07b 100644 --- a/src/openApi/v3/interfaces/OpenApiReference.d.ts +++ b/src/openApi/v3/interfaces/OpenApiReference.d.ts @@ -2,5 +2,5 @@ * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#referenceObject */ export interface OpenApiReference { - $ref: string; + $ref?: string; } diff --git a/src/openApi/v3/interfaces/OpenApiRequestBody.d.ts b/src/openApi/v3/interfaces/OpenApiRequestBody.d.ts index 74c32705..80a3a222 100644 --- a/src/openApi/v3/interfaces/OpenApiRequestBody.d.ts +++ b/src/openApi/v3/interfaces/OpenApiRequestBody.d.ts @@ -7,6 +7,6 @@ import { OpenApiReference } from './OpenApiReference'; */ export interface OpenApiRequestBody { description?: string; - content: Dictionary; + content: Dictionary; required?: boolean; } diff --git a/src/openApi/v3/interfaces/OpenApiResponse.d.ts b/src/openApi/v3/interfaces/OpenApiResponse.d.ts index 4eefca6f..62999841 100644 --- a/src/openApi/v3/interfaces/OpenApiResponse.d.ts +++ b/src/openApi/v3/interfaces/OpenApiResponse.d.ts @@ -9,7 +9,7 @@ import { OpenApiReference } from './OpenApiReference'; */ export interface OpenApiResponse { description: string; - headers?: Dictionary; + headers?: Dictionary; content?: Dictionary; - links?: Dictionary; + links?: Dictionary; } diff --git a/src/openApi/v3/interfaces/OpenApiResponses.d.ts b/src/openApi/v3/interfaces/OpenApiResponses.d.ts index 44085dc1..58317703 100644 --- a/src/openApi/v3/interfaces/OpenApiResponses.d.ts +++ b/src/openApi/v3/interfaces/OpenApiResponses.d.ts @@ -5,7 +5,7 @@ import { OpenApiResponse } from './OpenApiResponse'; * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#responsesObject */ export interface OpenApiResponses { - [httpcode: string]: OpenApiResponse | OpenApiReference; + [httpcode: string]: OpenApiResponse & OpenApiReference; - default: OpenApiResponse | OpenApiReference; + default: OpenApiResponse & OpenApiReference; } diff --git a/src/openApi/v3/interfaces/OpenApiSchema.d.ts b/src/openApi/v3/interfaces/OpenApiSchema.d.ts index b72f6ca9..da7904c4 100644 --- a/src/openApi/v3/interfaces/OpenApiSchema.d.ts +++ b/src/openApi/v3/interfaces/OpenApiSchema.d.ts @@ -23,15 +23,15 @@ export interface OpenApiSchema { maxProperties?: number; minProperties?: number; required?: string[]; - enum?: string[] | number[]; + enum?: (string | number)[]; type?: string; - allOf?: OpenApiReference[] | OpenApiSchema[]; - oneOf?: OpenApiReference[] | OpenApiSchema[]; - anyOf?: OpenApiReference[] | OpenApiSchema[]; - not?: OpenApiReference[] | OpenApiSchema[]; - items?: OpenApiReference | OpenApiSchema; - properties?: Dictionary; - additionalProperties?: boolean | OpenApiReference | OpenApiSchema; + allOf?: (OpenApiSchema & OpenApiReference)[]; + oneOf?: (OpenApiSchema & OpenApiReference)[]; + anyOf?: (OpenApiSchema & OpenApiReference)[]; + not?: (OpenApiSchema & OpenApiReference)[]; + items?: OpenApiSchema & OpenApiReference; + properties?: Dictionary; + additionalProperties?: boolean | (OpenApiSchema & OpenApiReference); description?: string; format?: 'int32' | 'int64' | 'float' | 'double' | 'string' | 'boolean' | 'byte' | 'binary' | 'date' | 'date-time' | 'password'; default?: any; diff --git a/src/templates/javascript/index.hbs b/src/templates/javascript/index.hbs index b62786c4..49e3aae3 100644 --- a/src/templates/javascript/index.hbs +++ b/src/templates/javascript/index.hbs @@ -18,6 +18,6 @@ export { {{{basename}}} } from './schemas/{{{basename}}}'; {{#if services}} {{#each services}} -export { {{{basename}}} } from './services/{{{basename}}}'; +export { {{{name}}} } from './services/{{{name}}}'; {{/each}} {{/if}} diff --git a/src/templates/javascript/model.hbs b/src/templates/javascript/model.hbs index 6b73f35c..2677cdd3 100644 --- a/src/templates/javascript/model.hbs +++ b/src/templates/javascript/model.hbs @@ -1,11 +1,22 @@ /* istanbul ignore file */ /* eslint-disable */ -{{#if enums}} + +{{#if imports}} +{{#each imports}} +import { {{{this}}} } from '../models/{{{this}}}'; +{{/each}} +{{/if}} +import * as yup from 'yup'; export let {{{base}}}; (function ({{{base}}}) { {{#each enums}} + {{#if description}} + /** + * {{{description}}} + */ + {{/if}} {{{../base}}}.{{{name}}} = { {{#each values}} {{{name}}}: {{{value}}}, @@ -13,5 +24,17 @@ export let {{{base}}}; }; {{/each}} + + {{{../base}}}.schema = yup.object().shape({ + // Add properties + }; + + {{{../base}}}.validate = function(value) { + return schema.validate(value, { strict: true }); + }; + + {{{../base}}}.validateSync = function(value) { + return schema.validateSync(value, { strict: true }); + }; + })({{{base}}} || ({{{base}}} = {})); -{{/if}} diff --git a/src/templates/javascript/service.hbs b/src/templates/javascript/service.hbs index 24d72018..0f0af42f 100644 --- a/src/templates/javascript/service.hbs +++ b/src/templates/javascript/service.hbs @@ -1,2 +1,70 @@ /* istanbul ignore file */ /* eslint-disable */ +import * as yup from 'yup'; + +export class {{{name}}} { + + {{#each operations}} + /** + {{#if deprecated}} + * @deprecated + {{/if}} + {{#if summary}} + * {{{summary}}} + {{/if}} + {{#if description}} + * {{{description}}} + {{/if}} + {{#if parameters}} + {{#each parameters}} + * @param {{{name}}} {{{description}}} + {{/each}} + {{/if}} + */ + static async {{{name}}}({{#each parameters}}{{{name}}}{{#unless required}}?{{/unless}}{{#unless @last}}, {{/unless}}{{/each}}) { + {{#if parameters}} + + {{#each parameters}} + yup.schema.validate(); + isValidRequiredParam({{{name}}}, '{{{name}}}'); + {{/each}} + {{/if}} + + const result = await request({ + method: '{{{method}}}', + path: `{{{path}}}`,{{#if parametersHeader}} + headers: { + {{#each parametersHeader}} + '{{{prop}}}': {{{name}}}, + {{/each}} + },{{/if}}{{#if parametersQuery}} + query: { + {{#each parametersQuery}} + '{{{prop}}}': {{{name}}}, + {{/each}} + },{{/if}}{{#if parametersForm}} + formData: { + {{#each parametersForm}} + '{{{prop}}}': {{{name}}}, + {{/each}} + },{{/if}}{{#if parametersBody}} + body: {{{parametersBody.name}}},{{/if}} + }); + + {{#if errors}} + if (!result.ok) { + switch (result.status) { + {{#each errors}} + case {{{code}}}: throw new ApiError(result, `{{{text}}}`); + {{/each}} + } + } + {{/if}} + + catchGenericError(result); + + return result.body; + } + + {{/each}} +} diff --git a/src/templates/typescript/index.hbs b/src/templates/typescript/index.hbs index f7068208..bbf3c632 100644 --- a/src/templates/typescript/index.hbs +++ b/src/templates/typescript/index.hbs @@ -2,8 +2,8 @@ /* tslint:disable */ /* eslint-disable */ -const server: string = '{{{server}}}'; -const version: string = '{{{version}}}'; +const server = '{{{server}}}'; +const version = '{{{version}}}'; {{#if models}} {{#each models}} @@ -19,6 +19,6 @@ export { {{{base}}} } from './schemas/{{{base}}}'; {{#if services}} {{#each services}} -export { {{{base}}} } from './services/{{{base}}}'; +export { {{{name}}} } from './services/{{{name}}}'; {{/each}} {{/if}} diff --git a/src/templates/typescript/model.hbs b/src/templates/typescript/model.hbs index 538aab85..c4de2f5e 100644 --- a/src/templates/typescript/model.hbs +++ b/src/templates/typescript/model.hbs @@ -1,23 +1,38 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ -{{#if imports}} +{{#if imports}} {{#each imports}} import { {{{this}}} } from '../models/{{{this}}}'; {{/each}} {{/if}} +import * as yup from 'yup'; +{{#if description}} +/** + * {{{description}}} + */ +{{/if}} export interface {{{base}}}{{{template}}}{{#if extend}} extends {{{extend}}}{{/if}} { {{#each properties}} - {{#if readOnly}}readonly {{/if}}{{{name}}}{{#unless required}}?{{/unless}}: {{{type}}}; + {{#if description}} + /** + * {{{description}}} + */ + {{/if}} + {{#if readOnly}}readonly {{/if}}{{{name}}}{{#unless required}}?{{/unless}}: {{{type}}}{{#if nullable}} | null{{/if}}; {{/each}} } -{{#if enums}} export namespace {{{base}}} { {{#each enums}} + {{#if description}} + /** + * {{{description}}} + */ + {{/if}} export enum {{{name}}} { {{#each values}} {{{name}}} = {{{value}}}, @@ -25,5 +40,16 @@ export namespace {{{base}}} { }; {{/each}} + + export const schema = yup.object<{{{base}}}{{{template}}}>().shape({ + // Add properties + }); + + export function validate(value: {{{base}}}{{{template}}}): Promise<{{{base}}}{{{template}}}> { + return schema.validate(value, { strict: true }); + } + + export function validateSync(value: {{{base}}}{{{template}}}): {{{base}}}{{{template}}} { + return schema.validateSync(value, { strict: true }); + } } -{{/if}} diff --git a/src/templates/typescript/service.hbs b/src/templates/typescript/service.hbs index d592379e..8547a9f8 100644 --- a/src/templates/typescript/service.hbs +++ b/src/templates/typescript/service.hbs @@ -1,3 +1,71 @@ /* istanbul ignore file */ /* tslint:disable */ /* eslint-disable */ +import * as yup from 'yup'; + +export class {{{name}}} { + + {{#each operations}} + /** + {{#if deprecated}} + * @deprecated + {{/if}} + {{#if summary}} + * {{{summary}}} + {{/if}} + {{#if description}} + * {{{description}}} + {{/if}} + {{#if parameters}} + {{#each parameters}} + * @param {{{name}}} {{{description}}} + {{/each}} + {{/if}} + */ + public static async {{{name}}}({{#each parameters}}{{{name}}}{{#unless required}}?{{/unless}}: {{{type}}}{{#if nullable}} | null{{/if}}{{#unless @last}}, {{/unless}}{{/each}}): Promise<{{{result}}}> { + {{#if parameters}} + + {{#each parameters}} + yup.schema.validate(); + isValidRequiredParam({{{name}}}, '{{{name}}}'); + {{/each}} + {{/if}} + + const result = await request<{{{result}}}>({ + method: '{{{method}}}', + path: `{{{path}}}`,{{#if parametersHeader}} + headers: { + {{#each parametersHeader}} + '{{{prop}}}': {{{name}}}, + {{/each}} + },{{/if}}{{#if parametersQuery}} + query: { + {{#each parametersQuery}} + '{{{prop}}}': {{{name}}}, + {{/each}} + },{{/if}}{{#if parametersForm}} + formData: { + {{#each parametersForm}} + '{{{prop}}}': {{{name}}}, + {{/each}} + },{{/if}}{{#if parametersBody}} + body: {{{parametersBody.name}}},{{/if}} + }); + + {{#if errors}} + if (!result.ok) { + switch (result.status) { + {{#each errors}} + case {{{code}}}: throw new ApiError(result, `{{{text}}}`); + {{/each}} + } + } + {{/if}} + + catchGenericError(result); + + return result.body; + } + + {{/each}} +} diff --git a/src/utils/getFileName.ts b/src/utils/getFileName.ts index ccd6936a..711c0c06 100644 --- a/src/utils/getFileName.ts +++ b/src/utils/getFileName.ts @@ -1,5 +1,10 @@ import { Language } from '../index'; +/** + * Get the correct file name and extension for a given language. + * @param fileName Any file name. + * @param language Typescript or Javascript. + */ export function getFileName(fileName: string, language: Language): string { switch (language) { case Language.TYPESCRIPT: diff --git a/src/utils/getSortedModels.spec.ts b/src/utils/getSortedModels.spec.ts index 59d6a71c..ec383408 100644 --- a/src/utils/getSortedModels.spec.ts +++ b/src/utils/getSortedModels.spec.ts @@ -9,8 +9,7 @@ describe('getSortedModels', () => { base: 'John', type: '', template: '', - description: null, - extends: null, + extends: [], imports: [], properties: [], enums: [], @@ -20,8 +19,7 @@ describe('getSortedModels', () => { base: 'Jane', type: '', template: '', - description: null, - extends: null, + extends: [], imports: [], properties: [], enums: [], @@ -31,8 +29,7 @@ describe('getSortedModels', () => { base: 'Doe', type: '', template: '', - description: null, - extends: null, + extends: [], imports: [], properties: [], enums: [], diff --git a/src/utils/getSortedServices.ts b/src/utils/getSortedServices.ts index 52d724c5..ecd7d4d0 100644 --- a/src/utils/getSortedServices.ts +++ b/src/utils/getSortedServices.ts @@ -7,8 +7,8 @@ import { Service } from '../client/interfaces/Service'; export function getSortedServices(services: Map): Service[] { return ( Array.from(services.values()).sort((a, b) => { - const nameA = a.base.toLowerCase(); - const nameB = b.base.toLowerCase(); + const nameA = a.name.toLowerCase(); + const nameB = b.name.toLowerCase(); return nameA.localeCompare(nameB, 'en'); }) || [] ); diff --git a/src/utils/writeClient.ts b/src/utils/writeClient.ts index 1401045d..ccf7f93c 100644 --- a/src/utils/writeClient.ts +++ b/src/utils/writeClient.ts @@ -25,12 +25,14 @@ export function writeClient(client: Client, language: Language, templates: Templ const outputPathSchemas = path.resolve(outputPath, 'schemas'); const outputPathServices = path.resolve(outputPath, 'services'); + // Clean output directory try { rimraf.sync(outputPath); } catch (e) { throw new Error(`Could not clean output directory`); } + // Create new directories try { mkdirp.sync(outputPath); mkdirp.sync(outputPathCore); @@ -41,6 +43,7 @@ export function writeClient(client: Client, language: Language, templates: Templ throw new Error(`Could not create output directories`); } + // Write the client files try { writeClientIndex(client, language, templates.index, outputPath); writeClientModels(getSortedModels(client.models), language, templates.model, outputPathModels); diff --git a/test/index.js b/test/index.js index 695d8b0c..575ca2ac 100755 --- a/test/index.js +++ b/test/index.js @@ -6,43 +6,50 @@ const OpenAPI = require('../dist'); OpenAPI.generate( './test/mock/v2/test-petstore.json', - './test/tmp/v2/test-petstore', + './test/tmp/v2/ts/test-petstore', OpenAPI.Language.TYPESCRIPT, OpenAPI.HttpClient.FETCH, ); OpenAPI.generate( - './test/mock/v2/test-petstore.yaml', - './test/tmp/v2/test-petstore-yaml', - OpenAPI.Language.TYPESCRIPT, - OpenAPI.HttpClient.FETCH, -); - -OpenAPI.generate( - './test/mock/v3/test-petstore.json', - './test/tmp/v3/test-petstore-json', - OpenAPI.Language.TYPESCRIPT, - OpenAPI.HttpClient.FETCH -); - -OpenAPI.generate( - './test/mock/v3/test-petstore.yaml', - './test/tmp/v3/test-petstore-yaml', - OpenAPI.Language.TYPESCRIPT, - OpenAPI.HttpClient.FETCH, -); - -OpenAPI.generate( - './test/mock/v3/test-uspto.json', - './test/tmp/v3/test-uspto', - OpenAPI.Language.TYPESCRIPT, - OpenAPI.HttpClient.FETCH, -); - -OpenAPI.generate( - './test/mock/v3/test-with-examples.json', - './test/tmp/v3/test-with-examples', - OpenAPI.Language.TYPESCRIPT, + './test/mock/v2/test-petstore.json', + './test/tmp/v2/js/test-petstore', + OpenAPI.Language.JAVASCRIPT, OpenAPI.HttpClient.FETCH, ); +// OpenAPI.generate( +// './test/mock/v2/test-petstore.yaml', +// './test/tmp/v2/test-petstore-yaml', +// OpenAPI.Language.TYPESCRIPT, +// OpenAPI.HttpClient.FETCH, +// ); +// +// OpenAPI.generate( +// './test/mock/v3/test-petstore.json', +// './test/tmp/v3/test-petstore-json', +// OpenAPI.Language.TYPESCRIPT, +// OpenAPI.HttpClient.FETCH +// ); +// +// OpenAPI.generate( +// './test/mock/v3/test-petstore.yaml', +// './test/tmp/v3/test-petstore-yaml', +// OpenAPI.Language.TYPESCRIPT, +// OpenAPI.HttpClient.FETCH, +// ); +// +// OpenAPI.generate( +// './test/mock/v3/test-uspto.json', +// './test/tmp/v3/test-uspto', +// OpenAPI.Language.TYPESCRIPT, +// OpenAPI.HttpClient.FETCH, +// ); +// +// OpenAPI.generate( +// './test/mock/v3/test-with-examples.json', +// './test/tmp/v3/test-with-examples', +// OpenAPI.Language.TYPESCRIPT, +// OpenAPI.HttpClient.FETCH, +// ); +// diff --git a/test/mock/v2/test-addon.json b/test/mock/v2/test-addon.json new file mode 100644 index 00000000..030a51aa --- /dev/null +++ b/test/mock/v2/test-addon.json @@ -0,0 +1,954 @@ +{ + "x-generator": "NSwag v12.3.1.0 (NJsonSchema v9.14.1.0 (Newtonsoft.Json v12.0.0.0))", + "swagger": "2.0", + "info": { + "title": "Add-on Service API", + "version": "v1" + }, + "host": "10.91.90.47:83", + "schemes": [ + "http" + ], + "paths": { + "/addon/api/v1/addons": { + "get": { + "tags": [ + "Addons" + ], + "summary": "Gets the list of addons.", + "operationId": "GetAll", + "responses": { + "200": { + "x-nullable": true, + "description": "", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Addon" + } + } + } + } + }, + "post": { + "tags": [ + "Addons" + ], + "summary": "Upload add-ons' zip files. Creates (or updates if exists) add-on.", + "operationId": "Upload", + "consumes": [ + "multipart/form-data" + ], + "parameters": [ + { + "type": "file", + "name": "file", + "in": "formData", + "required": true, + "description": "FileStream of the uploading file." + } + ], + "responses": { + "201": { + "x-nullable": true, + "description": "UploadResult", + "schema": { + "$ref": "#/definitions/UploadResult" + } + }, + "202": { + "x-nullable": true, + "description": "UploadResult", + "schema": { + "$ref": "#/definitions/UploadResult" + } + } + } + } + }, + "/addon/api/v1/addons/{id}": { + "put": { + "tags": [ + "Addons" + ], + "summary": "Upload addons' zip files. Updates existing add-on.", + "operationId": "Update", + "consumes": [ + "multipart/form-data" + ], + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true, + "description": "The add-on id.", + "format": "int32", + "x-nullable": false + }, + { + "type": "file", + "name": "file", + "in": "formData", + "required": true, + "description": "FileStream of the uploading file." + } + ], + "responses": { + "200": { + "x-nullable": true, + "description": "UploadResult.", + "schema": { + "$ref": "#/definitions/UploadResult" + } + } + } + }, + "get": { + "tags": [ + "Addons" + ], + "summary": "Gets the addon metadata by the specified id.", + "operationId": "Get", + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true, + "description": "The addon id.", + "format": "int32", + "x-nullable": false + } + ], + "responses": { + "200": { + "x-nullable": true, + "description": "The addon metadata.", + "schema": { + "$ref": "#/definitions/Addon" + } + } + } + }, + "delete": { + "tags": [ + "Addons" + ], + "summary": "Deletes the addon with a specified id.", + "operationId": "Delete", + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true, + "description": "The addon id.", + "format": "int32", + "x-nullable": false + } + ], + "responses": { + "200": { + "x-nullable": true, + "description": "", + "schema": { + "type": "file" + } + } + } + } + }, + "/addon/api/v1/addons/{id}/status": { + "post": { + "tags": [ + "Addons" + ], + "summary": "Updates the addon status.", + "operationId": "UpdateAddonStatus", + "consumes": [ + "application/json-patch+json", + "application/json", + "text/json", + "application/*+json" + ], + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true, + "description": "The addon id.", + "format": "int32", + "x-nullable": false + }, + { + "name": "statusReport", + "in": "body", + "required": true, + "description": "The status report.", + "schema": { + "$ref": "#/definitions/StatusReport" + }, + "x-nullable": false + } + ], + "responses": { + "200": { + "x-nullable": true, + "description": "", + "schema": { + "type": "file" + } + } + } + }, + "delete": { + "tags": [ + "Addons" + ], + "summary": "Deletes the addon status.", + "operationId": "DeleteAddonStatus", + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true, + "description": "The addon id.", + "format": "int32", + "x-nullable": false + } + ], + "responses": { + "200": { + "x-nullable": true, + "description": "", + "schema": { + "type": "file" + } + } + } + } + }, + "/addon/api/v1/addons/{id}/download": { + "get": { + "tags": [ + "Addons" + ], + "summary": "Downloads addon by the specified id.", + "description": "When HEAD request is used the method only checks if the addon exists and returns the empty file.", + "operationId": "Download", + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true, + "description": "The addon id.", + "format": "int32", + "x-nullable": false + } + ], + "responses": { + "200": { + "x-nullable": true, + "description": "Binary addon.", + "schema": { + "type": "file" + } + } + } + }, + "head": { + "tags": [ + "Addons" + ], + "summary": "Downloads addon by the specified id.", + "description": "When HEAD request is used the method only checks if the addon exists and returns the empty file.", + "operationId": "Fetch", + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true, + "description": "The addon id.", + "format": "int32", + "x-nullable": false + } + ], + "responses": { + "200": { + "x-nullable": true, + "description": "Binary addon.", + "schema": { + "type": "file" + } + } + } + } + }, + "/addon/api/v1/addons/{id}/downloadicon": { + "get": { + "tags": [ + "Addons" + ], + "summary": "Downloads Addon Icon by the specified id.", + "operationId": "DownloadIcon", + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true, + "description": "The addon id.", + "format": "int32", + "x-nullable": false + } + ], + "responses": { + "200": { + "x-nullable": true, + "description": "Addon icon stream.", + "schema": { + "type": "file" + } + } + } + } + }, + "/addon/api/v1/addons/{id}/configurations": { + "put": { + "tags": [ + "Configurations" + ], + "summary": "Upload addon configuration files. Extracts required fields from the containing manifest file.", + "operationId": "UploadConfiguration", + "consumes": [ + "multipart/form-data" + ], + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true, + "description": "The addon id.", + "format": "int32", + "x-nullable": false + }, + { + "type": "file", + "name": "file", + "in": "formData", + "required": true, + "description": "FileStream of the uploading file." + } + ], + "responses": { + "200": { + "x-nullable": true, + "description": "The updated addon.", + "schema": { + "$ref": "#/definitions/UploadResult" + } + } + } + }, + "delete": { + "tags": [ + "Configurations" + ], + "summary": "Deletes the addon configuration with a specified id.", + "operationId": "ConfigurationDelete", + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true, + "description": "The addon id.", + "format": "int32", + "x-nullable": false + } + ], + "responses": { + "200": { + "x-nullable": true, + "description": "", + "schema": { + "type": "file" + } + } + } + }, + "get": { + "tags": [ + "Configurations" + ], + "summary": "Downloads addon configuration by the specified id.", + "description": "When HEAD request is used the method only checks if the addon exists and returns the empty file.", + "operationId": "DownloadAddonConfiguration", + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true, + "description": "The addon id.", + "format": "int32", + "x-nullable": false + } + ], + "responses": { + "200": { + "x-nullable": true, + "description": "Binary addon configuration.", + "schema": { + "type": "file" + } + } + } + } + }, + "/addon/api/v1/extensions/{id}/status": { + "post": { + "tags": [ + "Extensions" + ], + "summary": "Updates the extension status.", + "operationId": "UpdateExtensionStatus", + "consumes": [ + "application/json-patch+json", + "application/json", + "text/json", + "application/*+json" + ], + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true, + "description": "The extension id.", + "format": "int32", + "x-nullable": false + }, + { + "name": "statusReport", + "in": "body", + "required": true, + "description": "The status report.", + "schema": { + "$ref": "#/definitions/StatusReport" + }, + "x-nullable": false + } + ], + "responses": { + "200": { + "x-nullable": true, + "description": "", + "schema": { + "type": "file" + } + } + } + }, + "delete": { + "tags": [ + "Extensions" + ], + "summary": "Deletes the extension status.", + "operationId": "DeleteExtensionStatus", + "parameters": [ + { + "type": "integer", + "name": "id", + "in": "path", + "required": true, + "description": "The extension id.", + "format": "int32", + "x-nullable": false + }, + { + "type": "string", + "name": "clientId", + "in": "query", + "description": "The client id. If it is specified, extension status for that client will be deleted.\n If not specified then extension status will be deleted for all clients.", + "x-nullable": true + } + ], + "responses": { + "200": { + "x-nullable": true, + "description": "", + "schema": { + "type": "file" + } + } + } + } + }, + "/addon/api/v1/health": { + "get": { + "tags": [ + "Health" + ], + "summary": "Checks whether the service is up and running", + "operationId": "Health", + "responses": { + "200": { + "x-nullable": true, + "description": "Ok - in success case, otherwise return the error description.", + "schema": { + "type": "file" + } + } + } + } + }, + "/addon/api/v1/report/heartbeat": { + "post": { + "tags": [ + "Report" + ], + "summary": "Receives heartbeat from all clients.", + "description": "This heartbeat is used to calculate the aggregated status of the Addons.\nIf the service does not receive heartbeat for a certain while,\nall reported status are ignored during status calculation.\nAfter a longer period those ignored status reports are cleaned out.\nBoth these values are configurable in the service.", + "operationId": "Report_Heartbeat", + "parameters": [ + { + "type": "string", + "name": "environment", + "in": "query", + "x-nullable": true + }, + { + "type": "string", + "name": "clientIdentity", + "in": "query", + "x-nullable": true + }, + { + "type": "string", + "name": "process", + "in": "query", + "x-nullable": true + } + ], + "responses": { + "204": { + "description": "" + } + } + } + } + }, + "definitions": { + "Addon": { + "type": "object", + "additionalProperties": false, + "required": [ + "Id", + "RequireConfiguration", + "Enabled", + "Status" + ], + "properties": { + "Id": { + "type": "integer", + "format": "int32" + }, + "ManifestVersion": { + "type": "string", + "description": "Gets the manifest version." + }, + "PackageId": { + "type": "string", + "description": "Gets the unique identifier of the add-on." + }, + "Name": { + "type": "string", + "description": "Gets the descriptive name of add-on." + }, + "Description": { + "type": "string", + "description": "Gets the description of add-on." + }, + "Author": { + "type": "string", + "description": "Gets the Author of add-on." + }, + "MinVersion": { + "type": "string", + "description": "Gets the minimum SDL Tridion Sites version this extension supports." + }, + "MaxVersion": { + "type": "string", + "description": "Gets the maximum SDL Tridion Sites version this extension supports." + }, + "Version": { + "type": "string", + "description": "Gets the version of this add-on." + }, + "Icon": { + "type": "string", + "description": "Gets the add-on icon." + }, + "RequireConfiguration": { + "description": "Describes whether the custom configuration can be uploaded for the addon.", + "$ref": "#/definitions/RequireConfiguration" + }, + "Dependencies": { + "type": "array", + "description": "Gets the collection of add-on dependencies.", + "items": { + "$ref": "#/definitions/Dependency" + } + }, + "Extensions": { + "type": "array", + "description": "Gets the list of extensions this add-on contains.", + "items": { + "$ref": "#/definitions/Extension" + } + }, + "Enabled": { + "type": "boolean" + }, + "Status": { + "$ref": "#/definitions/DeploymentStatus" + }, + "PackageHash": { + "type": "string" + }, + "UploadedAt": { + "type": "string", + "format": "date-time" + }, + "DownloadUri": { + "type": "string", + "format": "uri" + }, + "StatusReports": { + "type": "array", + "items": { + "$ref": "#/definitions/StatusReport" + } + }, + "DownloadIconUri": { + "type": "string", + "format": "uri" + }, + "DownloadConfigurationUri": { + "type": "string", + "format": "uri" + }, + "Configuration": { + "$ref": "#/definitions/Configuration" + } + } + }, + "RequireConfiguration": { + "type": "string", + "description": "Represents whether the Addon requires configuration or not", + "x-enumNames": [ + "Optional", + "Yes", + "No" + ], + "enum": [ + "Optional", + "Yes", + "No" + ], + "x-ms-enum": { + "name": "RequireConfiguration", + "modelAsString": false + } + }, + "Dependency": { + "type": "object", + "description": "Represents add-on dependencies from the add-on manifest file.", + "additionalProperties": false, + "properties": { + "Id": { + "type": "string", + "description": "Gets the name of dependency package" + }, + "Version": { + "type": "string", + "description": "Gets the version of dependency package" + } + } + }, + "Extension": { + "type": "object", + "description": "Represents extension information from the add-on manifest file.", + "additionalProperties": false, + "required": [ + "Id", + "Status" + ], + "properties": { + "Id": { + "type": "integer", + "description": "Add-on service generated ID.", + "format": "int32" + }, + "Name": { + "type": "string", + "description": "Gets the extension name" + }, + "SupportedVersions": { + "type": "string", + "description": "Gets the SDL Tridion Sites component versions this extension support" + }, + "Type": { + "type": "string", + "description": "Gets the identifier of the extension point that this extension extends." + }, + "properties": { + "description": "Gets the custom properties associated with this extension as raw json." + }, + "StatusReports": { + "type": "array", + "description": "List of status reports.", + "items": { + "$ref": "#/definitions/StatusReport" + } + }, + "DisabledClients": { + "type": "array", + "description": "List of the clients where the extension is disabled.", + "items": { + "type": "string" + } + }, + "Status": { + "description": "Calculated status for this extension.", + "$ref": "#/definitions/DeploymentStatus" + } + } + }, + "StatusReport": { + "type": "object", + "description": "Represents the extension status object to be received from the update addon status REST method.", + "additionalProperties": false, + "required": [ + "Status" + ], + "properties": { + "Environment": { + "type": "string", + "description": "The free-form unique identifier of the environment of the client reporting the addon and extension status." + }, + "ClientIdentity": { + "type": "string", + "description": "The free form unique identifier of the client who reporting the addon and extension status.\n\nIs used in order to calculate the addon and extension status based on all the client's reports.\nE.g. at least one reported fail - addon extension gets failed status." + }, + "Process": { + "type": "string", + "description": "The free-form unique identifier of the process of the client reporting the addon and extension status." + }, + "Status": { + "description": "The addon status.", + "$ref": "#/definitions/DeploymentStatus" + }, + "Message": { + "type": "string", + "description": "The exception details for the case of failed status." + } + } + }, + "DeploymentStatus": { + "type": "string", + "description": "Represents the status the Addon or Extension is currently in", + "x-enumNames": [ + "Fail", + "Pending", + "Success", + "WaitingConfiguration", + "Disabled" + ], + "enum": [ + "Fail", + "Pending", + "Success", + "WaitingConfiguration", + "Disabled" + ], + "x-ms-enum": { + "name": "DeploymentStatus", + "modelAsString": false + } + }, + "Configuration": { + "type": "object", + "description": "Represents add-on configuration information", + "additionalProperties": false, + "properties": { + "FileName": { + "type": "string", + "description": "Gets the configuration file name." + }, + "ContentHash": { + "type": "string", + "description": "Gets the hash of configuration file content." + }, + "UploadedAt": { + "type": "string", + "description": "Gets configuration upload date.", + "format": "date-time" + } + } + }, + "UploadResult": { + "type": "object", + "additionalProperties": false, + "required": [ + "Id", + "IsModified" + ], + "properties": { + "Id": { + "type": "integer", + "format": "int32" + }, + "IsModified": { + "type": "boolean" + } + } + }, + "IHeaderDictionary": { + "type": "object", + "x-abstract": true, + "additionalProperties": false, + "required": [ + "Item" + ], + "properties": { + "Item": { + "type": "array", + "items": { + "type": "string" + } + }, + "ContentLength": { + "type": "integer", + "format": "int64" + } + } + }, + "Manifest": { + "type": "object", + "description": "Represents add-on information from the add-on manifest file.", + "additionalProperties": false, + "required": [ + "RequireConfiguration" + ], + "properties": { + "ManifestVersion": { + "type": "string", + "description": "Gets the manifest version." + }, + "Id": { + "type": "string", + "description": "Gets the unique identifier of the add-on." + }, + "Name": { + "type": "string", + "description": "Gets the descriptive name of add-on." + }, + "Description": { + "type": "string", + "description": "Gets the description of add-on." + }, + "Author": { + "type": "string", + "description": "Gets the Author of add-on." + }, + "MinVersion": { + "type": "string", + "description": "Gets the minimum SDL Tridion Sites version this extension supports." + }, + "MaxVersion": { + "type": "string", + "description": "Gets the maximum SDL Tridion Sites version this extension supports." + }, + "Version": { + "type": "string", + "description": "Gets the version of this add-on." + }, + "Icon": { + "type": "string", + "description": "Gets the add-on icon." + }, + "RequireConfiguration": { + "description": "Describes whether the custom configuration can be uploaded for the addon.", + "$ref": "#/definitions/RequireConfiguration" + }, + "Dependencies": { + "type": "array", + "description": "Gets the collection of add-on dependencies.", + "items": { + "$ref": "#/definitions/DependencyManifest" + } + }, + "Extensions": { + "type": "array", + "description": "Gets the list of extensions this add-on contains.", + "items": { + "$ref": "#/definitions/ExtensionManifest" + } + } + } + }, + "DependencyManifest": { + "type": "object", + "description": "Represents add-on dependencies from the add-on manifest file.", + "additionalProperties": false, + "properties": { + "Id": { + "type": "string", + "description": "Gets the name of dependency package" + }, + "Version": { + "type": "string", + "description": "Gets the version of dependency package" + } + } + }, + "ExtensionManifest": { + "type": "object", + "description": "Represents extension information from the add-on manifest file.", + "additionalProperties": false, + "required": [ + "Id" + ], + "properties": { + "Id": { + "type": "integer", + "description": "Add-on service generated ID.", + "format": "int32" + }, + "Name": { + "type": "string", + "description": "Gets the extension name" + }, + "SupportedVersions": { + "type": "string", + "description": "Gets the SDL Tridion Sites component versions this extension support" + }, + "Type": { + "type": "string", + "description": "Gets the identifier of the extension point that this extension extends." + }, + "properties": { + "description": "Gets the additional properties required to configure the extension." + } + } + } + } +} diff --git a/test/mock/v2/test-docs.json b/test/mock/v2/test-docs.json new file mode 100644 index 00000000..6cc75c60 --- /dev/null +++ b/test/mock/v2/test-docs.json @@ -0,0 +1,10503 @@ +{ + "swagger": "2.0", + "info": { + "version": "v1", + "title": "Trisoft.InfoShare.Web" + }, + "host": "localhost:40470", + "basePath": "/infoshareauthor", + "schemes": [ + "https" + ], + "paths": { + "/Api/Annotations/Form/": { + "get": { + "tags": [ + "Annotations" + ], + "summary": "Gets a new annotation creation form for a content object specified in parameters.", + "operationId": "GetCreateForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "formId", + "in": "query", + "description": "The form identifier.", + "required": true, + "type": "string" + }, + { + "name": "clientName", + "in": "query", + "description": "Name of the client.", + "required": false, + "type": "string" + }, + { + "name": "param.publicationId", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "param.publicationVersion", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "param.revisionId", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + } + }, + "/Api/Annotations/": { + "put": { + "tags": [ + "Annotations" + ], + "summary": "Updates multiple annotations", + "operationId": "Update", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "updateRequestParameters", + "in": "body", + "description": "List of request objects (annotationId and metadata) that needs to be updated", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AnnotationUpdateRequest" + } + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AnnotationUpdateResponse" + } + } + } + } + }, + "post": { + "tags": [ + "Annotations" + ], + "summary": "Creates an annotation specified by {param} with the specified metadata.", + "operationId": "Create", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "metadata", + "in": "body", + "description": "Contains information related with annotation to be created.", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + }, + { + "name": "param.publicationId", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "param.publicationVersion", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "param.revisionId", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/Annotations/{annotationId}/Form/": { + "get": { + "tags": [ + "Annotations" + ], + "summary": "Gets a form to update an annotation by the given id.", + "operationId": "GetUpdateForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "annotationId", + "in": "path", + "description": "Annotation Id", + "required": true, + "type": "string" + }, + { + "name": "formId", + "in": "query", + "description": "The form identifier.", + "required": true, + "type": "string" + }, + { + "name": "clientName", + "in": "query", + "description": "Name of the client.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + } + }, + "/Api/Annotations/{annotationId}/": { + "put": { + "tags": [ + "Annotations" + ], + "summary": "Updates the annotation specified by {annotationId} with the specified metadata.", + "description": "The parameter {metadata} can only contain fields of annotation level.", + "operationId": "Update", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "annotationId", + "in": "path", + "description": "The card identifier of the annotation.", + "required": true, + "type": "string" + }, + { + "name": "metadata", + "in": "body", + "description": "Optional. Metadata containing a collection of {Trisoft.InfoShare.XAPI.Models.FieldValue} instances that will be set on the annotation.", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AnnotationDescriptor" + } + } + } + }, + "delete": { + "tags": [ + "Annotations" + ], + "summary": "Deletes an annotation by the given annotation id.", + "description": "Requirements are: \r\nThe user must have write access for the folder in which the object that has annotation with ID.", + "operationId": "Delete", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "annotationId", + "in": "path", + "description": "annotation ID", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/Annotations/Details/": { + "post": { + "tags": [ + "Annotations" + ], + "summary": "Gets the values of requested fields for given annotations ids.", + "operationId": "GetDetails", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "parameter", + "in": "body", + "description": "Contains information about the desired annotation ids and requested fields.", + "required": true, + "schema": { + "$ref": "#/definitions/AnnotationDetailParameters" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AnnotationMetadata" + } + } + } + } + } + }, + "/Api/Annotations/List/": { + "post": { + "tags": [ + "Annotations" + ], + "summary": "Gets the values of requested fields for given filters.", + "operationId": "List", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "parameter", + "in": "body", + "description": "Contains information about the desired publication, metadata filtters and requested fields.", + "required": true, + "schema": { + "$ref": "#/definitions/AnnotationListParameters" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AnnotationMetadata" + } + } + } + } + } + }, + "/Api/Annotations/{annotationId}/Replies/{annotationReplyId}/": { + "put": { + "tags": [ + "Annotations" + ], + "summary": "Updates the reply.", + "operationId": "UpdateReply", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "annotationId", + "in": "path", + "description": "The annotation identifier.", + "required": true, + "type": "string" + }, + { + "name": "annotationReplyId", + "in": "path", + "description": "The annotation reply identifier.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "metadata", + "in": "body", + "description": "The metadata that holds the detail of the annotation reply.", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AnnotationReplyDescriptor" + } + } + } + }, + "delete": { + "tags": [ + "Annotations" + ], + "summary": "Deletes the reply.", + "operationId": "DeleteReply", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "annotationId", + "in": "path", + "description": "The annotation identifier.", + "required": true, + "type": "string" + }, + { + "name": "annotationReplyId", + "in": "path", + "description": "The annotation reply identifier.", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/Annotations/{annotationId}/Replies/": { + "post": { + "tags": [ + "Annotations" + ], + "summary": "Creates the reply.", + "operationId": "CreateReply", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "annotationId", + "in": "path", + "description": "The annotation identifier.", + "required": true, + "type": "string" + }, + { + "name": "metadata", + "in": "body", + "description": "The metadata that holds the detail of the annotation reply.", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AnnotationReplyDescriptor" + } + } + } + } + }, + "/Api/Comments/DeleteMultipleById/": { + "post": { + "tags": [ + "Comments" + ], + "summary": "Deletes the multiple comments by identifier.", + "operationId": "DeleteMultipleById", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "ids", + "in": "body", + "description": "The ids.", + "required": true, + "schema": { + "type": "array", + "items": { + "format": "int64", + "type": "integer" + } + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "format": "int64", + "type": "integer" + } + } + } + } + } + }, + "/Api/Comments/Users/": { + "get": { + "tags": [ + "Comments" + ], + "summary": "Get users for the given parameters", + "operationId": "GetUsers", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/User" + } + } + } + } + } + }, + "/Api/Comments/Languages/": { + "get": { + "tags": [ + "Comments" + ], + "summary": "Gets comment languages", + "operationId": "GetLanguages", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "/Api/Comments/Publications/{language}/": { + "get": { + "tags": [ + "Comments" + ], + "summary": "Gets the publications.", + "operationId": "GetPublications", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "language", + "in": "path", + "description": "The language.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Publication" + } + } + } + } + } + }, + "/Api/Comments/Statuses/": { + "get": { + "tags": [ + "Comments" + ], + "summary": "Gets comment statuses", + "operationId": "GetStatuses", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Status" + } + } + } + } + } + }, + "/api/Comments/": { + "get": { + "tags": [ + "Comments" + ], + "summary": "Get comments for the given parameters", + "operationId": "Get", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "language", + "in": "query", + "description": "Language of the object.", + "required": false, + "type": "string" + }, + { + "name": "from", + "in": "query", + "description": "Start date for filtering.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "to", + "in": "query", + "description": "End date for filtering.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "skipDate", + "in": "query", + "description": "The skip date needed by date based paging.", + "required": false, + "type": "string", + "format": "date-time" + }, + { + "name": "publicationId", + "in": "query", + "description": "The publication identifier.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "status", + "in": "query", + "description": "The status.", + "required": false, + "type": "string" + }, + { + "name": "userId", + "in": "query", + "description": "The user identifier.", + "required": false, + "type": "string" + }, + { + "name": "top", + "in": "query", + "description": "The top.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "skip", + "in": "query", + "description": "The skip.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CommentingResult" + } + } + } + }, + "post": { + "tags": [ + "Comments" + ], + "summary": "Posts the specified value.", + "operationId": "Post", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "value", + "in": "body", + "description": "The value.", + "required": true, + "schema": { + "$ref": "#/definitions/Comment" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Comment" + } + } + } + } + }, + "/api/Comments/{id}/": { + "get": { + "tags": [ + "Comments" + ], + "summary": "Gets the specified identifier.", + "operationId": "Get", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier.", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Comment" + } + } + } + }, + "put": { + "tags": [ + "Comments" + ], + "summary": "Puts the specified identifier.", + "operationId": "Put", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The identifier.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "value", + "in": "body", + "description": "The value.", + "required": true, + "schema": { + "$ref": "#/definitions/Comment" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Comment" + } + } + } + }, + "delete": { + "tags": [ + "Comments" + ], + "summary": "Deletes the comment.", + "operationId": "Delete", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The comment identifier.", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/ContentObjects/": { + "post": { + "tags": [ + "ContentObjects" + ], + "summary": "Creates a new content object in the specified folder.", + "description": "The metadata that will be set on the content object, can be passed in the request body in JSON format.\r\nThe metadata can contain fields of all levels (logical, version, language).\r\nThe logical identifier can explicitly be added to the metadata.\r\nThe version cannot be added to the metadata. By default, it is set to 1.\r\nThe language and resolution can explicitly be added to the metadata. If the language is not provided by the metadata the default language will be used (language on user card). If the resolution is not provided by the metadata the default resolution will be used (resolution on settings card).\r\nWhen content has to be uploaded, it can be passed in the request body in multipart format. The multipart body can contain 2 parts. A part named \"metadata\" containing the metadata in JSON format, and a part named \"data\" containing the content.", + "operationId": "CreateObject", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "folderCardId", + "in": "query", + "description": "The card identifier of the folder where to create the new content object.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "data", + "in": "formData", + "required": false, + "type": "File" + }, + { + "name": "metadata", + "in": "formData", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/ContentObjects/{folderCardId}/": { + "get": { + "tags": [ + "ContentObjects" + ], + "summary": "Gets a new content object in the specified folder.", + "operationId": "GetCreateObjectForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "folderCardId", + "in": "path", + "description": "The card identifier of the folder where to create the new content object.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "referenceLanguageCardId", + "in": "query", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "formId", + "in": "query", + "description": "Form id in metadata xml", + "required": false, + "type": "string" + }, + { + "name": "clientName", + "in": "query", + "description": "The | seperated list of values for client name in the metadataconfig conditions.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + }, + "post": { + "tags": [ + "ContentObjects" + ], + "summary": "Creates a new content object in the specified folder.", + "description": "The metadata that will be set on the content object, can be passed in the request body in JSON format.\r\nThe metadata can contain fields of all levels (logical, version, language).\r\nThe logical identifier can explicitly be added to the metadata.\r\nThe version cannot be added to the metadata. By default, it is set to 1.\r\nThe fields are inherited from the editor template or reference object specified by {referenceLanguageCardId}. If the language or resolution is provided by the metadata, they have to be equal to the language or resolution of the editor template or reference object.\r\nContent cannot be uploaded. A multipart body is not supported.", + "operationId": "Create", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "folderCardId", + "in": "path", + "description": "The card identifier of the folder where to create the new content object.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "referenceLanguageCardId", + "in": "query", + "description": "The editor template card id or reference language card id that can be used to retrieve the data object.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "formId", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "clientNames", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "data", + "in": "formData", + "required": false, + "type": "File" + }, + { + "name": "metadata", + "in": "formData", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/ContentObjects/LanguageCard/{languageCardId}/": { + "get": { + "tags": [ + "ContentObjects" + ], + "summary": "Gets a form containing definition and values needed to generate a form to update an existing object.", + "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.UpdateObject\" is used.\r\nThis method is only to be used in the old web client.", + "operationId": "GetUpdateObjectForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Card identifier of the language object. The card identifier is required.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + }, + { + "name": "clientName", + "in": "query", + "description": "The | seperated list of values for client name in the metadataconfig conditions.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + }, + "put": { + "tags": [ + "ContentObjects" + ], + "summary": "Updates the content object specified by {languageCardId}.", + "description": "The metadata that will be set on the content object, can be passed in the request body in JSON format.\r\nThe metadata can contain fields of all levels (logical, version, language).\r\nWhen content has to be uploaded, it can be passed in the request body in multipart format. The multipart body can contain 2 parts. A part named \"metadata\" containing the metadata in JSON format, and a part named \"data\" containing the content.", + "operationId": "Update", + "consumes": [ + "multipart/form-data" + ], + "produces": [], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Card identifier of the content object.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "data", + "in": "formData", + "required": false, + "type": "File" + }, + { + "name": "metadata", + "in": "formData", + "required": false, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/ContentObjects/LanguageCard/{languageCardId}/CheckIn/": { + "get": { + "tags": [ + "ContentObjects" + ], + "operationId": "GetCheckinObjectForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "formId", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "clientName", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + }, + "put": { + "tags": [ + "ContentObjects" + ], + "summary": "Checks in the content object specified by {languageCardId}.", + "description": "The metadata that will be set on the content object, can be passed in the request body in JSON format.\r\nThe metadata can contain fields of all levels (logical, version, language).\r\nWhen content has to be uploaded, it can be passed in the request body in multipart format. The multipart body can contain 2 parts. A part named \"metadata\" containing the metadata in JSON format, and a part named \"data\" containing the content.", + "operationId": "Checkin", + "consumes": [ + "multipart/form-data" + ], + "produces": [], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Card identifier of the content object.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "keepCheckedOut", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "data", + "in": "formData", + "required": false, + "type": "File" + }, + { + "name": "metadata", + "in": "formData", + "required": false, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/ContentObjects/{logicalId}/": { + "get": { + "tags": [ + "ContentObjects" + ], + "summary": "Gets a form containing definition and values needed to generate a form to update an existing logical object.", + "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.UpdateLogicalObject\" is used.\r\nThis method is only to be used in the old web client.", + "operationId": "GetUpdateObjectForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "The logical identifier of the object.", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "The version of the version object.", + "required": false, + "type": "string" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + }, + { + "name": "clientName", + "in": "query", + "description": "The | seperated list of values for client name in the metadataconfig conditions.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + }, + "post": { + "tags": [ + "ContentObjects" + ], + "summary": "Creates a new version object in the specified logical object.", + "description": "The parameter {metadata} can only contain version level fields.\r\nThe version can explicitly be added to the metadata. If the version is not provided by the metadatas the version will be generated by calculating the next free version number on the main branch for the specified logical object (e.g. 3.1.2 -> 4).\r\nThis method is only to be used in the old web client.", + "operationId": "CreateVersionObject", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "The identifier of the logical object where to create the new version object.", + "required": true, + "type": "string" + }, + { + "name": "metadata", + "in": "body", + "description": "The metadata that will be set on the version object.", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/ContentObjects/{logicalId}/Version/": { + "get": { + "tags": [ + "ContentObjects" + ], + "summary": "Gets a form containing definition and values needed to generate a form to create a new version object.", + "description": "The {fromVersion} is optional. By default, a new version number will be generated.\r\nThe {doBranch} is optional. By default, a new version number will be generated.\r\nThe {formId} is optional. By default, \"Properties_NewVersion_'ObjectType'\" is used.", + "operationId": "GetCreateVersionObjectForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "The identifier of the logical object where to create the new version object. The identifier is required.", + "required": true, + "type": "string" + }, + { + "name": "referenceLanguageCardId", + "in": "query", + "description": "Card identifier of the language object that the method prefills the form.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "fromVersion", + "in": "query", + "description": "The version from which a version or branch has to be created. A new (branched) version number will be generated and returned\r\n as part of the metadata. If not provided a new version number will be generated and returned.", + "required": false, + "type": "string" + }, + { + "name": "doBranch", + "in": "query", + "description": "true if a branch has to be created; otherwise, false.", + "required": false, + "type": "boolean" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + }, + { + "name": "clientName", + "in": "query", + "description": "The | seperated list of values for client name in the metadataconfig conditions.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + } + }, + "/Api/ContentObjects/{logicalId}/DefaultMetadata/": { + "post": { + "tags": [ + "ContentObjects" + ], + "summary": "Creates a new version object (fills the required metadata fields with latest version's default language object field values).", + "operationId": "CreateVersionObjectWithDefaultMetadata", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "The identifier of the logical object where to create the new version object with language and update logical level fields.", + "required": true, + "type": "string" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + }, + { + "name": "clientNames", + "in": "query", + "description": "The list of values for client name in the metadataconfig conditions.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DocumentObjDescriptor" + } + } + } + } + }, + "/Api/ContentObjects/DefaultLanguageCardId/": { + "get": { + "tags": [ + "ContentObjects" + ], + "summary": "Gets the language card id of the default language for related logicalId.", + "operationId": "GetDefaultLanguageCardId", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "query", + "description": "The identifier of the logical object.", + "required": true, + "type": "string" + }, + { + "name": "fromVersion", + "in": "query", + "description": "Version of the object to create version.", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Version of the object to create language.", + "required": false, + "type": "string" + }, + { + "name": "doBranch", + "in": "query", + "description": "true if a branch has to be created; otherwise, false.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "format": "int64", + "type": "integer" + } + } + } + } + }, + "/Api/ContentObjects/{logicalId}/Version/{version}/": { + "get": { + "tags": [ + "ContentObjects" + ], + "summary": "Gets a form containing definition and values needed to generate a form to create a new version object.", + "description": "The {formId} is optional. By default, \"Properties_Create_'ObjectType'\" is used.", + "operationId": "GetCreateLanguageObjectForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "The identifier of the logical object where to create the new version object. The identifier is required.", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The version from which a version or branch has to be created. A new (branched) version number will be generated and returned\r\n as part of the metadata. If not provided a new version number will be generated and returned.", + "required": true, + "type": "string" + }, + { + "name": "referenceLanguageCardId", + "in": "query", + "description": "Card identifier of the language object that the method prefills the form.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + }, + { + "name": "clientName", + "in": "query", + "description": "The | seperated list of values for client name in the metadataconfig conditions.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + }, + "post": { + "tags": [ + "ContentObjects" + ], + "summary": "Creates a new version object in the specified logical object.", + "description": "The parameter {metadata} can only contain version level fields.\r\nThe version can explicitly be added to the metadata. If the version is not provided by the metadatas the version will be generated by calculating the next free version number on the main branch for the specified logical object (e.g. 3.1.2 -> 4).\r\nThis method is only to be used in the old web client.", + "operationId": "CreateLanguageObject", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "The identifier of the logical object where to create the new version object.", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The version from which a version or branch has to be created. A new (branched) version number will be generated and returned\r\n as part of the metadata. If not provided a new version number will be generated and returned.", + "required": true, + "type": "string" + }, + { + "name": "metadata", + "in": "body", + "description": "The metadata that will be set on the version object.", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/ContentObjects/RevisionObject/{revisionId}/Content/": { + "get": { + "tags": [ + "ContentObjects" + ], + "summary": "Get XML content for a document", + "operationId": "GetContent", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "revisionId", + "in": "path", + "description": "RevisionId Id of the object.", + "required": true, + "type": "string" + }, + { + "name": "includeByteOrderMark", + "in": "query", + "description": "Whether to include a Byte Order Mark at the beginning of the Stream", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/ContentObjects/InContext/Metadata/": { + "post": { + "tags": [ + "ContentObjects" + ], + "summary": "Gets the metadata for the given logical id matching the versions specified in the baseline for the given publication version", + "operationId": "GetInContextMetadata", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "InContextMetadataParameters with the parameters for the call including:\r\n Logical Id of the publication, Version of the publication, Logical Ids of the documents or images, Requested metadata, Language and KeepOrder\r\n When null, the working language of the publication is used.", + "required": true, + "schema": { + "$ref": "#/definitions/InContextMetadataParameters" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentObjectMetadata" + } + } + } + } + } + }, + "/Api/ContentObjects/InContext/Content/": { + "post": { + "tags": [ + "ContentObjects" + ], + "summary": "Gets the content for the given logical id matching the versions specified in the baseline for the given publication version", + "operationId": "GetInContextContent", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "InContextContentParameters with the parameters for the call including:\r\n Logical Id of the publication, Version of the publication, revision id of root map of publication, Language, Resolution and IgnoreNavigationTitles flag\r\n When null, the working language of the publication is used.", + "required": true, + "schema": { + "$ref": "#/definitions/InContextContentParameters" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/ContentObjects/InContext/VariableAssignments/": { + "post": { + "tags": [ + "ContentObjects" + ], + "summary": "Gets the metadata and variable assignments for the given publication which has version and language as given", + "operationId": "GetInContextVariableAssignments", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "InContextVariableAssignmentsParameters with the parameters for the call including:\r\n // Logical Id of the publication, Version of the publication, Language of the publication", + "required": true, + "schema": { + "$ref": "#/definitions/InContextVariableAssignmentsParameters" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VariableResources" + } + } + } + } + } + }, + "/Api/ContentObjects/{folderCardId}/ShowModeBehavior/": { + "get": { + "tags": [ + "ContentObjects" + ], + "summary": "Gets the show mode behavior of the form when creating an object", + "operationId": "GetShowModeBehaviorForNewObject", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "folderCardId", + "in": "path", + "description": "The card identifier of the folder where to create the new content object.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "referenceLanguageCardId", + "in": "query", + "description": "Card identifier of the language object that the method prefills the form.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + }, + { + "name": "clientName", + "in": "query", + "description": "The list of values for client name in the metadataconfig conditions.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "enum": [ + "show", + "hide" + ], + "type": "string" + } + } + } + } + }, + "/Api/ContentObjects/{logicalId}/ShowModeBehavior/": { + "get": { + "tags": [ + "ContentObjects" + ], + "summary": "Gets the show mode behavior of the form when creating a version object", + "operationId": "GetShowModeBehaviorForNewVersion", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "The identifier of the logical object.", + "required": true, + "type": "string" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + }, + { + "name": "clientName", + "in": "query", + "description": "The list of values for client name in the metadataconfig conditions.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "enum": [ + "show", + "hide" + ], + "type": "string" + } + } + } + } + }, + "/Api/ContentObjects/InContext/Baseline/BaselineEntry/": { + "put": { + "tags": [ + "ContentObjects" + ], + "summary": "Updates the baseline with the given version of a document", + "operationId": "SetVersionInBaseline", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "publicationId", + "in": "query", + "description": "The publication in which the baseline should be updated", + "required": true, + "type": "string" + }, + { + "name": "publicationVersion", + "in": "query", + "description": "Version of publication", + "required": true, + "type": "string" + }, + { + "name": "logicalId", + "in": "query", + "description": "Logical Id of the document with the new version", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "The new version number of the document which should be updated in the baseline", + "required": true, + "type": "string" + }, + { + "name": "autoCompleteMode", + "in": "query", + "description": "Auto complete mode of baseline for children of the objects", + "required": false, + "type": "string", + "enum": [ + "iSHNone", + "iSHFirstVersion", + "iSHLatestReleased", + "iSHLatestAvailable" + ] + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/DocumentObj/{languageCardId}/CanReview/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Get the can review state for an object.", + "description": "Both objects are dealt seperately, there is no validation if the document is actually part of the publication output.", + "operationId": "CanReview", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Language Card Id of the object.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "publicationOutputCardId", + "in": "query", + "description": "Publication Output Card Id to validate the review end date for.", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "boolean" + } + } + } + } + }, + "/Api/DocumentObj/{languageCardId}/CanCheckOut/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Checks whether the object can be checked out.", + "operationId": "CanCheckOut", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Language Card Id of the object.", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "boolean" + } + } + } + } + }, + "/Api/DocumentObj/MetadataForPublish/": { + "post": { + "tags": [ + "DocumentObj" + ], + "summary": "Gets the metadata fields that would also be created by the PublishService", + "operationId": "MetadataForPublish", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "languageCardIds", + "in": "body", + "description": "Language Card Ids of the objects.", + "required": true, + "schema": { + "type": "array", + "items": { + "format": "int64", + "type": "integer" + } + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/DocumentObj/Metadata/": { + "post": { + "tags": [ + "DocumentObj" + ], + "summary": "Gets the metadata for multiple language objects using the provided filter.", + "operationId": "Metadata", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "filter", + "in": "body", + "description": "Object filter.", + "required": true, + "schema": { + "$ref": "#/definitions/DocumentObjectFilter" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/DocumentObj/{languageCardId}/UndoCheckOut/": { + "put": { + "tags": [ + "DocumentObj" + ], + "summary": "Undo check out", + "operationId": "UndoCheckOut", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Language card id", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/DocumentObj/{languageCardId}/CheckOut/": { + "put": { + "tags": [ + "DocumentObj" + ], + "summary": "Check out document", + "operationId": "CheckOut", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Language card id", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + } + } + } + }, + "/Api/DocumentObj/{languageCardId}/CheckIn/": { + "put": { + "tags": [ + "DocumentObj" + ], + "summary": "Check in document\r\nNote: The actual content (blob) needs to be passed in the request body.", + "description": "The actual content (blob) needs to be passed in the request body.", + "operationId": "CheckIn", + "consumes": [ + "application/octet-stream" + ], + "produces": [], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Language card id", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "payload", + "in": "body", + "required": true, + "type": "string", + "format": "binary" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/DocumentObj/{languageCardId}/Update/": { + "put": { + "tags": [ + "DocumentObj" + ], + "summary": "Update the document\r\nNote: The actual content (blob) needs to be passed in the request body.", + "description": "The actual content (blob) needs to be passed in the request body.", + "operationId": "Update", + "consumes": [ + "application/octet-stream" + ], + "produces": [], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Language card id", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "payload", + "in": "body", + "required": true, + "type": "string", + "format": "binary" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/DocumentObj/LanguageCard/{languageCardId}/ContentInfo/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Get content information for document", + "operationId": "ContentInfo", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Language card id of object", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Item" + } + } + } + } + }, + "/Api/DocumentObj/LogicalObject/{logicalId}/ContentInfo/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Get content information for document", + "operationId": "ContentInfo", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "Logical id of object", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Version of object. Default is the latest available.", + "required": false, + "type": "string" + }, + { + "name": "language", + "in": "query", + "description": "Language of object. Default is the working language of the user.", + "required": false, + "type": "string" + }, + { + "name": "resolution", + "in": "query", + "description": "Resolution of object. Default is the system resolution.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Item" + } + } + } + } + }, + "/Api/DocumentObj/LanguageCard/{languageCardId}/Content/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Get XML content for a document", + "operationId": "Content", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Language Card Id of the object.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "includeSchema", + "in": "query", + "description": "Set the schema information on the root element.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/DocumentObj/LogicalObject/{logicalId}/Content/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Get XML content for a document", + "operationId": "Content", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "LogicalId of the object.", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Version of object. Default is the latest available.", + "required": false, + "type": "string" + }, + { + "name": "language", + "in": "query", + "description": "Language of object. Default is the working language of the user.", + "required": false, + "type": "string" + }, + { + "name": "resolution", + "in": "query", + "description": "Resolution of object. Default is the system resolution.", + "required": false, + "type": "string" + }, + { + "name": "includeSchema", + "in": "query", + "description": "Set the schema information on the root element.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/DocumentObj/{languageCardId}/MetadataAndContent/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Get metadata and xml content for a language card", + "operationId": "MetadataAndContent", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "language card id", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "mode", + "in": "query", + "description": "Mode. If mode is Create (Xopus) the pipeline configuration is included.", + "required": false, + "type": "string", + "enum": [ + "none", + "create" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MetadataAndContent" + } + } + } + } + }, + "/Api/DocumentObj/LanguageCard/{languageCardId}/Thumbnail/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Returns a thumbnail.\r\nSupported formats are jpg, jpeg, gif, bmp and png.", + "description": "When the thumbnail cannot be rendered a dummy image is returned saying that the graphic could not be found.", + "operationId": "Thumbnail", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "LanguageCardId of the object.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "maxWidth", + "in": "query", + "description": "Maximum width.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "maxHeight", + "in": "query", + "description": "Maximum height.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/DocumentObj/RevisionObject/{revisionId}/Thumbnail/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Returns a thumbnail.\r\nSupported formats are jpg, jpeg, gif, bmp and png.", + "description": "When the thumbnail cannot be rendered a dummy image is returned saying that the graphic could not be found.", + "operationId": "Thumbnail", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "revisionId", + "in": "path", + "description": "RevisionId of the requested object.", + "required": true, + "type": "string" + }, + { + "name": "maxWidth", + "in": "query", + "description": "Maximum width.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "maxHeight", + "in": "query", + "description": "Maximum height.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/DocumentObj/LogicalObject/{logicalId}/Thumbnail/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Returns a thumbnail.\r\nSupported formats are jpg, jpeg, gif, bmp and png.", + "description": "When the thumbnail cannot be rendered a dummy image is returned saying that the graphic could not be found.", + "operationId": "Thumbnail", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "LogicalId of the object.", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Version of object. Default is the latest available.", + "required": false, + "type": "string" + }, + { + "name": "language", + "in": "query", + "description": "Language of object. Default is the working language of the user.", + "required": false, + "type": "string" + }, + { + "name": "resolution", + "in": "query", + "description": "Resolution of object. Default is the system resolution.", + "required": false, + "type": "string" + }, + { + "name": "maxWidth", + "in": "query", + "description": "Maximum width.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "maxHeight", + "in": "query", + "description": "Maximum height.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/DocumentObj/LanguageCard/{languageCardId}/SelectionPreview/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Preview an object with option to select target(s).", + "operationId": "SelectionPreview", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "LanguageCardId of the object.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "selectMode", + "in": "query", + "description": "Select mode.", + "required": false, + "type": "string", + "enum": [ + "none", + "link", + "conref", + "variable", + "keyref", + "reusableObject", + "all" + ] + }, + { + "name": "selectableElements", + "in": "query", + "description": "The elements that can be selected. Items are seperated by a '|'.", + "required": false, + "type": "string" + }, + { + "name": "ignoreObjectFragments", + "in": "query", + "description": "Whether to resolve conrefs", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreLinkTexts", + "in": "query", + "description": "Whether to resolve titles with xref and link elements", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreNavigationTitles", + "in": "query", + "description": "Whether to resolve titles with topicref elements", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/DocumentObj/LogicalObject/{logicalId}/SelectionPreview/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Preview an object with option to select target(s).", + "operationId": "SelectionPreview", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "LogicalId of the object.", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Version of object. Default is the latest available.", + "required": false, + "type": "string" + }, + { + "name": "language", + "in": "query", + "description": "Language of object. Default is the working language of the user.", + "required": false, + "type": "string" + }, + { + "name": "selectMode", + "in": "query", + "description": "Select mode.", + "required": false, + "type": "string", + "enum": [ + "none", + "link", + "conref", + "variable", + "keyref", + "reusableObject", + "all" + ] + }, + { + "name": "selectableElements", + "in": "query", + "description": "The elements that can be selected. Items are seperated by a '|'.", + "required": false, + "type": "string" + }, + { + "name": "ignoreObjectFragments", + "in": "query", + "description": "Whether to resolve conrefs", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreLinkTexts", + "in": "query", + "description": "Whether to resolve titles with xref and link elements", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreNavigationTitles", + "in": "query", + "description": "Whether to resolve titles with topicref elements", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/DocumentObj/LanguageCard/{languageCardId}/Preview/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Preview an object by languagecard id", + "operationId": "Preview", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "LanguageCardId of the object.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "embed", + "in": "query", + "description": "The object is embedded in a page or not.", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreObjectFragments", + "in": "query", + "description": "Whether to resolve conrefs", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreLinkTexts", + "in": "query", + "description": "Whether to resolve titles with xref and link elements", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreNavigationTitles", + "in": "query", + "description": "Whether to resolve titles with topicref elements", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/DocumentObj/RevisionObject/{revisionId}/Preview/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Preview an object by revision id", + "operationId": "Preview", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "revisionId", + "in": "path", + "description": "RevisionId of the requested object.", + "required": true, + "type": "string" + }, + { + "name": "embed", + "in": "query", + "description": "The object is embedded in a page or not.", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreObjectFragments", + "in": "query", + "description": "Whether to resolve conrefs", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreLinkTexts", + "in": "query", + "description": "Whether to resolve titles with xref and link elements", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreNavigationTitles", + "in": "query", + "description": "Whether to resolve titles with topicref elements", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/DocumentObj/LogicalObject/{logicalId}/Preview/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Preview an object by logical id", + "operationId": "Preview", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "LogicalId of the object.", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Version of object. Default is the latest available.", + "required": false, + "type": "string" + }, + { + "name": "language", + "in": "query", + "description": "Language of object. Default is the working language of the user.", + "required": false, + "type": "string" + }, + { + "name": "resolution", + "in": "query", + "description": "Resolution of object. Default is the system resolution.", + "required": false, + "type": "string" + }, + { + "name": "embed", + "in": "query", + "description": "The object is embedded in a page or not.", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreObjectFragments", + "in": "query", + "description": "Whether to resolve conrefs", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreLinkTexts", + "in": "query", + "description": "Whether to resolve titles with xref and link elements", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreNavigationTitles", + "in": "query", + "description": "Whether to resolve titles with topicref elements", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/DocumentObj/LanguageCard/{languageCardId}/ComparePreview/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Retrieves preview with changetracking", + "operationId": "ComparePreview", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Language card id", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "languageCardIdToCompare", + "in": "query", + "description": "Language card id to compare", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "embed", + "in": "query", + "description": "If true, only returns html which is inside the \"body\" of the preview output.", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreObjectFragments", + "in": "query", + "description": "Whether to resolve conrefs", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreLinkTexts", + "in": "query", + "description": "Whether to resolve titles with xref and link elements", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreNavigationTitles", + "in": "query", + "description": "Whether to resolve titles with topicref elements", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ComparePreview" + } + } + } + } + }, + "/Api/DocumentObj/RevisionObject/{revisionId}/ComparePreview/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Retrieves preview with changetracking", + "operationId": "ComparePreview", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "revisionId", + "in": "path", + "description": "Revision id", + "required": true, + "type": "string" + }, + { + "name": "revisionIdToCompare", + "in": "query", + "description": "Revision id to compare", + "required": true, + "type": "string" + }, + { + "name": "embed", + "in": "query", + "description": "If true, only returns html which is inside the \"body\" of the preview output.", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreObjectFragments", + "in": "query", + "description": "Whether to resolve conrefs", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreLinkTexts", + "in": "query", + "description": "Whether to resolve titles with xref and link elements", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreNavigationTitles", + "in": "query", + "description": "Whether to resolve titles with topicref elements", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ComparePreview" + } + } + } + } + }, + "/Api/DocumentObj/LogicalObject/{logicalId}/ComparePreview/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Retrieves preview with changetracking", + "operationId": "ComparePreview", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "Logical Object id", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Object version", + "required": false, + "type": "string" + }, + { + "name": "versionToCompare", + "in": "query", + "description": "Object version to compare", + "required": false, + "type": "string" + }, + { + "name": "language", + "in": "query", + "description": "Objet language", + "required": false, + "type": "string" + }, + { + "name": "resolution", + "in": "query", + "description": "Objet resolution", + "required": false, + "type": "string" + }, + { + "name": "embed", + "in": "query", + "description": "If true, only returns html which is inside the \"body\" of the preview output.", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreObjectFragments", + "in": "query", + "description": "Whether to resolve conrefs", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreLinkTexts", + "in": "query", + "description": "Whether to resolve titles with xref and link elements", + "required": false, + "type": "boolean" + }, + { + "name": "ignoreNavigationTitles", + "in": "query", + "description": "Whether to resolve titles with topicref elements", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ComparePreview" + } + } + } + } + }, + "/Api/DocumentObj/LogicalObject/MetadataForm/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Gets a form containing definition and values needed to generate a form to create a new logical object.", + "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.CreateLogicalObject\" is used.\r\nThis method is only to be used in the old web client.", + "operationId": "GetCreateLogicalObjectForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "folderCardId", + "in": "query", + "description": "The card identifier of the folder where to create a new logical object. The identifier is required.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + } + }, + "/Api/DocumentObj/LogicalObject/{logicalId}/MetadataForm/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Gets a form containing definition and values needed to generate a form to update an existing logical object.", + "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.UpdateLogicalObject\" is used.\r\nThis method is only to be used in the old web client.", + "operationId": "GetUpdateLogicalObjectForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "The identifier of the logical object to update. The identifier is required.", + "required": true, + "type": "string" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + } + }, + "/Api/DocumentObj/VersionObject/MetadataForm/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Gets a form containing definition and values needed to generate a form to create a new version object.", + "description": "The {fromVersion} is optional. By default, a new version number will be generated.\r\nThe {doBranch} is optional. By default, a new version number will be generated.\r\nThe {formId} is optional. By default, \"Trisoft.InfoShareAuthor.CreateVersionObject\" is used.\r\nThis method is only to be used in the old web client.", + "operationId": "GetCreateVersionObjectForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "query", + "description": "The identifier of the logical object where to create the new version object. The identifier is required.", + "required": true, + "type": "string" + }, + { + "name": "fromVersion", + "in": "query", + "description": "The version from which a version or branch has to be created. A new (branched) version number will be generated and returned\r\n as part of the metadata. If not provided a new version number will be generated and returned.", + "required": false, + "type": "string" + }, + { + "name": "doBranch", + "in": "query", + "description": "true if a branch has to be created; otherwise, false.", + "required": false, + "type": "boolean" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + } + }, + "/Api/DocumentObj/VersionObject/{logicalId}/{version}/MetadataForm/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Gets a form containing definition and values needed to generate a form to update a version object.", + "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.UpdateVersionObject\" is used.\r\nThis method is only to be used in the old web client.", + "operationId": "GetUpdateVersionObjectForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "The identifier of the logical object containing the version object.", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The version of the version object.", + "required": true, + "type": "string" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + } + }, + "/Api/DocumentObj/LanguageObject/MetadataForm/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Gets a form containing definition and values needed to generate a form to create a new language object.", + "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.CreateLanguageObject\" is used.\r\nThis method is only to be used in the old web client.", + "operationId": "GetCreateLanguageObjectForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "query", + "description": "The identifier of the logical object where to create the new language object. The identifier is required.", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "The version of the version object where to create the new language object. The version is required.", + "required": true, + "type": "string" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + } + }, + "/Api/DocumentObj/LanguageObject/{languageCardId}/MetadataForm/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Gets a form containing definition and values needed to generate a form to update a language object.", + "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.UpdateLanguageObject\" is used.\r\nThis method is only to be used in the old web client.", + "operationId": "GetUpdateLanguageObjectForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Card identifier of the language object. The card identifier is required.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + } + }, + "/Api/DocumentObj/LanguageObject/{languageCardId}/Checkin/MetadataForm/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Gets a form containing definition and values needed to generate a form to check-in a language object.", + "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.UpdateLanguageObject\" is used.\r\nThis method is only to be used in the old web client.", + "operationId": "GetCheckinLanguageObjectForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Card identifier of the language object. The card identifier is required.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + } + }, + "/Api/DocumentObj/LogicalObject/": { + "post": { + "tags": [ + "DocumentObj" + ], + "summary": "Creates a new logical object in the specified folder.", + "description": "The parameter {metadata} can only contain logical level fields.\r\nThe logical identifier can explicitly be added to the metadata.\r\nThis method is only to be used in the old web client.", + "operationId": "CreateLogicalObject", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "folderCardId", + "in": "query", + "description": "The card identifier of the folder where to create the new logical object.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "metadata", + "in": "body", + "description": "The metadata that will be set on the logical object.", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/DocumentObj/LogicalObject/{logicalId}/": { + "put": { + "tags": [ + "DocumentObj" + ], + "summary": "Updates a logical object with the specified metadata.", + "description": "The parameter {metadata} can only contain logical level fields.\r\nThis method is only to be used in the old web client.", + "operationId": "UpdateLogicalObject", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "Logical object id", + "required": true, + "type": "string" + }, + { + "name": "metadata", + "in": "body", + "description": "The metadata that will be set on the logical object.", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + }, + "delete": { + "tags": [ + "DocumentObj" + ], + "summary": "Deletes a logical object.", + "description": "Requirements are: \r\n The user must have write access for the folder in which the object is going to be deleted. \r\n The documentation (DocumentObj 2.5 - Delete describes the behavior depending on your starting situation. [SRQ-3834] ", + "operationId": "DeleteLogicalObject", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "Logical object ID", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/DocumentObj/VersionObject/": { + "post": { + "tags": [ + "DocumentObj" + ], + "summary": "Creates a new version object in the specified logical object.", + "description": "The parameter {metadata} can only contain version level fields.\r\nThe version can explicitly be added to the metadata. If the version is not provided by the metadatas the version will be generated by calculating the next free version number on the main branch for the specified logical object (e.g. 3.1.2 -> 4).\r\nThis method is only to be used in the old web client.", + "operationId": "CreateVersionObject", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "logicalId", + "in": "query", + "description": "The identifier of the logical object where to create the new version object.", + "required": true, + "type": "string" + }, + { + "name": "metadata", + "in": "body", + "description": "The metadata that will be set on the version object.", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/DocumentObj/VersionObject/{logicalId}/{version}/": { + "put": { + "tags": [ + "DocumentObj" + ], + "summary": "Updates the version object specified by {logicalId} and {version} with the specified metadata.", + "description": "The parameter {metadata} can only contain version level fields.\r\nThis method is only to be used in the old web client.", + "operationId": "UpdateVersionObject", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "The identifier of the logical object containing the version object.", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The version of the version object.", + "required": true, + "type": "string" + }, + { + "name": "metadata", + "in": "body", + "description": "The metadata that will be set on the version object.", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + }, + "delete": { + "tags": [ + "DocumentObj" + ], + "summary": "Deletes a version object.", + "description": "Requirements are: \r\n The user must have write access for the folder in which the object is going to be deleted. \r\n The documentation (DocumentObj 2.5 - Delete describes the behavior depending on your starting situation. [SRQ-3834] ", + "operationId": "DeleteVersionObject", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "Lobical object ID", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "Version object version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/DocumentObj/LanguageObject/": { + "post": { + "tags": [ + "DocumentObj" + ], + "summary": "Creates a new language object in the version object specified by {logicalId} and {version}.", + "description": "The metadata can only contain language level fields.\r\nThe language and resolution can explicitly be added to the metadata. If the language is not provided by the metadata the default language will be used (language on user card). If the resolution is not provided by the metadata the default resolution will be used (resolution on settings card).\r\nThis method is only to be used in the old web client.\r\nWhen content has to be uploaded, it can be passed in the request body in multipart format. The multipart body can contain 2 parts. A part named \"metadata\" containing the metadata in JSON format, and a part named \"data\" containing the content.", + "operationId": "CreateLanguageObject", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "logicalId", + "in": "query", + "description": "The identifier of the logical object where to create the new language object.", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "The version of the version object where to create the new language object.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/DocumentObj/LanguageObject/{languageCardId}/": { + "put": { + "tags": [ + "DocumentObj" + ], + "summary": "Updates a language object with the specified metadata.", + "description": "The metadata that will be set on the language object, can be passed in the request body in JSON format.\r\nThe metadata can only contain language level fields.\r\nThis method is only to be used in the old web client.\r\nWhen content has to be uploaded, it can be passed in the request body in multipart format. The multipart body can contain 2 parts. A part named \"metadata\" containing the metadata in JSON format, and a part named \"data\" containing the content.", + "operationId": "UpdateLanguageObject", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Card identifier of the language object.", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + }, + "delete": { + "tags": [ + "DocumentObj" + ], + "summary": "Deletes a language object.", + "description": "Requirements are: \r\n The user must have write access for the folder in which the object is going to be deleted. \r\n The documentation (DocumentObj 2.5 - Delete describes the behavior depending on your starting situation. [SRQ-3834] ", + "operationId": "DeleteLanguageObject", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Card identifier of the language object.", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/DocumentObj/LanguageObject/{languageCardId}/Checkin/": { + "put": { + "tags": [ + "DocumentObj" + ], + "summary": "Checks-in a language object with the specified metadata.", + "description": "The metadata that will be set on the language object, can be passed in the request body in JSON format.\r\nThe metadata can only contain language level fields.\r\nThis method is only to be used in the old web client.\r\nWhen content has to be uploaded, it can be passed in the request body in multipart format. The multipart body can contain 2 parts. A part named \"metadata\" containing the metadata in JSON format, and a part named \"data\" containing the content.", + "operationId": "CheckinLanguageObject", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Card identifier of the language object.", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/DocumentObj/LogicalObject/{logicalId}/Versions/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Get ordered list of versions by logicalId", + "operationId": "GetVersions", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "Logical object id", + "required": true, + "type": "string" + }, + { + "name": "sortDescending", + "in": "query", + "description": "Sort in descending order or not. Default is false (sort in ascending order).", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "/Api/DocumentObj/{languageCardId}/Revisions/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Get revisions log for the object with given language card id.", + "operationId": "GetRevisions", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Language card id of the object.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "sortDescending", + "in": "query", + "description": "Sort in descending order or not. Default is false (sort in ascending order).", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/RevisionInfo" + } + } + } + } + } + }, + "/Api/DocumentObj/PossibleTargetStatuses/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Get the initial target statuses for the given object type.", + "operationId": "GetPossibleTargetStatuses", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "objectType", + "in": "query", + "description": "An object type (e.g. ISHModule).", + "required": false, + "type": "string" + }, + { + "name": "sortOrder", + "in": "query", + "description": "Specifies the sort order of the statuses.. Default: None.", + "required": false, + "type": "string", + "enum": [ + "none", + "ascending", + "descending" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ValueListItem" + } + } + } + } + } + }, + "/Api/DocumentObj/{languageCardId}/PossibleTargetStatuses/": { + "get": { + "tags": [ + "DocumentObj" + ], + "summary": "Get the possible target statuses for the given language card ID.", + "operationId": "GetPossibleTargetStatuses", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Language card ID of the object.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "currentStatus", + "in": "query", + "description": "The element name of the current status (e.g. VSTATUSDRAFT).", + "required": false, + "type": "string" + }, + { + "name": "sortOrder", + "in": "query", + "description": "Specifies the sort order of the statuses. Default: None.", + "required": false, + "type": "string", + "enum": [ + "none", + "ascending", + "descending" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ValueListItem" + } + } + } + } + } + }, + "/Api/ExternalPreview/": { + "get": { + "tags": [ + "ExternalPreview" + ], + "summary": "Returns the HTML form to test the External Preview (read from ExternalPreviewForm.html in the InfoshareAuthor website root).", + "operationId": "Get", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + }, + "post": { + "tags": [ + "ExternalPreview" + ], + "summary": "Get the html preview for the posted object.\r\nThe parameters:\r\nbase64Blob: Base64 encoded blob (XML); \r\npreTranslationType: Source (SRC) or Target (TGT, TARGET) language; \r\nhost: Identifier of the external system. This parameter is passed to the preview xsl. Defaults to 'ExternalPreview'.\r\n", + "operationId": "Post", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "externalPreview", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExternalPreview" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/ExternalPreview/Resource/": { + "get": { + "tags": [ + "ExternalPreview" + ], + "summary": "Get an image resource from the repository.", + "operationId": "Resource", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "logicalId", + "in": "query", + "description": "LogicalId of the object.", + "required": true, + "type": "string" + }, + { + "name": "language", + "in": "query", + "description": "[Optional => Default = Repository default] Language of the object.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/ExternalPreview/UserInfo/": { + "get": { + "tags": [ + "ExternalPreview" + ], + "summary": "Test for the ExternalPreviewModule.", + "operationId": "GetUserInfo", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UserInfo" + } + } + } + } + }, + "/Api/ExternalPreview/Validate/": { + "get": { + "tags": [ + "ExternalPreview" + ], + "summary": "Returns the HTML form to test the External Validate (read from ExternalValidateForm.html in the InfoshareAuthor website root).", + "operationId": "Validate", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + }, + "post": { + "tags": [ + "ExternalPreview" + ], + "summary": "Get the result of validate for the posted object.\r\nThe parameters:\r\nbase64Blob: Base64 encoded blob (XML); \r\npreTranslationType: Source (SRC) or Target (TGT, TARGET) language; \r\n", + "operationId": "Validate", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "externalValidate", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExternalPreview" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/Folder/EditorTemplates/": { + "get": { + "tags": [ + "Folder" + ], + "summary": "Get the editor templates.", + "operationId": "EditorTemplates", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "typesFilter", + "in": "query", + "description": "Filter editor templates for a type. \r\nPossible values: None (No filtering), Module, Library or Master.\r\nDefault value is None.", + "required": false, + "type": "string", + "enum": [ + "none", + "module", + "master", + "library" + ] + }, + { + "name": "languages", + "in": "query", + "description": "The languages for which you wish to retrieve the editor templates.\r\nWhen providing multiple values you should do \"&languages=VLANGUAGEEN&languages=VLANGUAGEFR\".\r\nDefault value is the working language of the current user.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EditorTemplateSpecification" + } + } + } + } + }, + "/Api/Folder/EditorTemplates2/": { + "get": { + "tags": [ + "Folder" + ], + "summary": "Gets the released editor templates speciefied by {objectTypes} and {languages}.", + "operationId": "EditorTemplates", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "objectTypes", + "in": "query", + "description": "The object types for which to return the editor templates.\r\nIf null or an empty list is provided, editor templates for all object types are returned.\r\n(e.g. \"&objectTypes=ISHModule&objectTypes=ISHPublicationOutput\")", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "languages", + "in": "query", + "description": "The languages for which you wish to retrieve the editor templates.\r\nDefault value is the working language of the current user.\r\n(e.g. \"&languages=VLANGUAGEEN&languages=VLANGUAGEFR\")", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EditorTemplateSpecification" + } + } + } + } + }, + "/Api/Folder/Favorites/": { + "get": { + "tags": [ + "Folder" + ], + "summary": "Get the first level items from the user's favorites folder.", + "operationId": "GetFavorites", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Favorites" + } + } + } + } + }, + "/Api/Folder/{folderCardId}/": { + "get": { + "tags": [ + "Folder" + ], + "summary": "Get the specified folder", + "operationId": "Get", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "folderCardId", + "in": "path", + "description": "The unique identifier of the folder", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FolderModel" + } + } + } + }, + "put": { + "tags": [ + "Folder" + ], + "summary": "Update the specified folder", + "operationId": "Put", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [], + "parameters": [ + { + "name": "folderCardId", + "in": "path", + "description": "The unique identifier of the folder", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "folder", + "in": "body", + "description": "The folder model from http body", + "required": true, + "schema": { + "$ref": "#/definitions/FolderModel" + } + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + }, + "delete": { + "tags": [ + "Folder" + ], + "summary": "Delete the specified folder", + "operationId": "Delete", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "folderCardId", + "in": "path", + "description": "The unique identifier of the folder", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/Folder/": { + "post": { + "tags": [ + "Folder" + ], + "summary": "Create the new query folder in the specified parent folder", + "operationId": "Post", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "folder", + "in": "body", + "description": "The folder model from http body", + "required": true, + "schema": { + "$ref": "#/definitions/FolderModel" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/Folder/{folderCardId}/Move/": { + "put": { + "tags": [ + "Folder" + ], + "summary": "Moves folder under new parent folder", + "operationId": "Move", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [], + "parameters": [ + { + "name": "folderCardId", + "in": "path", + "description": "Folder id", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "parentFolderCardId", + "in": "body", + "description": "New folder parent id", + "required": true, + "schema": { + "format": "int64", + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/Folder/{folderCardId}/Folders/": { + "get": { + "tags": [ + "Folder" + ], + "summary": "Gets the sub folders for a specified folderid.", + "operationId": "Folders", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "folderCardId", + "in": "path", + "description": "Folder card id of the folder to get the items for.", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Folders" + } + } + } + } + }, + "/Api/Folder/Folders/": { + "get": { + "tags": [ + "Folder" + ], + "summary": "Gets the sub folders for the base (or root) folder.", + "operationId": "Folders", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Folders" + } + } + } + } + }, + "/Api/Folder/{folderCardId}/List/": { + "get": { + "tags": [ + "Folder" + ], + "summary": "Get the content for a folder", + "operationId": "List", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "folderCardId", + "in": "path", + "description": "Folder Card Id", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "languages", + "in": "query", + "description": "The object languages which should be returned.\r\nWhen providing multiple values you should do \"&languages=en&languages=fr\".\r\nDefault value is the working language of the current user.", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "objectTypes", + "in": "query", + "description": "Object types to return.", + "required": false, + "type": "string", + "enum": [ + "none", + "module", + "master", + "library", + "illustration", + "template", + "publication" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FolderContent" + } + } + } + } + }, + "/Api/Folder/List/": { + "get": { + "tags": [ + "Folder" + ], + "summary": "Get the content for the base (or root) folder.", + "operationId": "List", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FolderContent" + } + } + } + } + }, + "/Api/Folder/RootFolders/": { + "get": { + "tags": [ + "Folder" + ], + "summary": "Gets the sub folders of specified BaseFolder type for the base (or root) folder.", + "operationId": "RootFolders", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "baseFolderTypes", + "in": "query", + "description": "Types of folders", + "required": true, + "type": "array", + "items": { + "type": "string", + "enum": [ + "data", + "system", + "favorites", + "editorTemplate" + ] + }, + "collectionFormat": "multi" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/FolderModel" + } + } + } + } + } + }, + "/Api/Lists/ListOfValues/{name}/": { + "get": { + "tags": [ + "Lists" + ], + "summary": "Get the list of values by Name and Activity Filter.", + "operationId": "GetListOfValues", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "E.g. Languages (DLANGUAGE), Resolutions (DRESOLUTION)", + "required": true, + "type": "string" + }, + { + "name": "activityFilter", + "in": "query", + "description": "Core.ActivityFilter (values = {None=0, Active=1, Inactive=2})", + "required": false, + "type": "string", + "enum": [ + "none", + "active", + "inactive" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ValueListItem" + } + } + } + } + } + }, + "/Api/Lists/Users/": { + "post": { + "tags": [ + "Lists" + ], + "summary": "Get the list of users.", + "operationId": "GetUserList", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "metadataFilter", + "in": "body", + "description": "MetadataFilter, which is retrieved from the Request Body as a JSON object.", + "required": true, + "schema": { + "$ref": "#/definitions/MetadataFilter" + } + }, + { + "name": "activityFilter", + "in": "query", + "description": "Core.ActivityFilter (values = {None=0, Active=1, Inactive=2})", + "required": false, + "type": "string", + "enum": [ + "none", + "active", + "inactive" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ValueListItem" + } + } + } + } + } + }, + "/Api/Lists/UserGroups/": { + "post": { + "tags": [ + "Lists" + ], + "summary": "Get the list of user groups.", + "operationId": "GetUserGroupList", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "metadataFilter", + "in": "body", + "description": "MetadataFilter, which is retrieved from the Request Body as a JSON object.", + "required": true, + "schema": { + "$ref": "#/definitions/MetadataFilter" + } + }, + { + "name": "activityFilter", + "in": "query", + "description": "Core.ActivityFilter (values = {None=0, Active=1, Inactive=2})", + "required": false, + "type": "string", + "enum": [ + "none", + "active", + "inactive" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ValueListItem" + } + } + } + } + } + }, + "/Api/Lists/UserRoles/": { + "post": { + "tags": [ + "Lists" + ], + "summary": "Get the list of user roles.", + "operationId": "GetUserRoleList", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "metadataFilter", + "in": "body", + "description": "MetadataFilter, which is retrieved from the Request Body as a JSON object.", + "required": true, + "schema": { + "$ref": "#/definitions/MetadataFilter" + } + }, + { + "name": "activityFilter", + "in": "query", + "description": "Core.ActivityFilter (values = {None=0, Active=1, Inactive=2})", + "required": false, + "type": "string", + "enum": [ + "none", + "active", + "inactive" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ValueListItem" + } + } + } + } + } + }, + "/Api/Lists/Baselines/": { + "post": { + "tags": [ + "Lists" + ], + "summary": "Get the list of baselines.", + "operationId": "GetBaselines", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "metadataFilter", + "in": "body", + "description": "MetadataFilter, which is retrieved from the Request Body as a JSON object.", + "required": true, + "schema": { + "$ref": "#/definitions/MetadataFilter" + } + }, + { + "name": "activityFilter", + "in": "query", + "description": "Core.ActivityFilter (values = {None=0, Active=1, Inactive=2})", + "required": false, + "type": "string", + "enum": [ + "none", + "active", + "inactive" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ValueListItem" + } + } + } + } + } + }, + "/Api/Lists/Edts/": { + "post": { + "tags": [ + "Lists" + ], + "summary": "Get the list of electronic document types..", + "operationId": "GetEdts", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "metadataFilter", + "in": "body", + "description": "MetadataFilter, which is retrieved from the Request Body as a JSON object.", + "required": true, + "schema": { + "$ref": "#/definitions/MetadataFilter" + } + }, + { + "name": "activityFilter", + "in": "query", + "description": "Core.ActivityFilter (values = {None=0, Active=1, Inactive=2})", + "required": false, + "type": "string", + "enum": [ + "none", + "active", + "inactive" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ValueListItem" + } + } + } + } + } + }, + "/Api/Localization/MetadataForm/": { + "get": { + "tags": [ + "Localization" + ], + "summary": "Get resource file in RESJSON format", + "operationId": "Get", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "language", + "in": "query", + "description": "Requested language. If parameter null or empty the default language are returned.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "/Api/MetadataBinding/RetrieveTags/": { + "post": { + "tags": [ + "MetadataBinding" + ], + "summary": "Retrieve tags", + "operationId": "RetrieveTags", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "fieldName", + "in": "query", + "description": "The element name of the field for which to retrieve information", + "required": true, + "type": "string" + }, + { + "name": "fieldLevel", + "in": "query", + "description": "The IshLevel of the field for which to retrieve information", + "required": true, + "type": "string", + "enum": [ + "none", + "logical", + "version", + "language", + "annotation" + ] + }, + { + "name": "fieldsFilter", + "in": "body", + "description": "The values of other fields which can be used as an additional filter", + "required": true, + "schema": { + "$ref": "#/definitions/FieldsFilter" + } + }, + { + "name": "inputFilter", + "in": "query", + "description": "String with the input of the user", + "required": false, + "type": "string" + }, + { + "name": "language", + "in": "query", + "description": "The language in which to return the label/description. If no language is provide, the user language is used.", + "required": false, + "type": "string" + }, + { + "name": "maxTagsToReturn", + "in": "query", + "description": "The maximum number of tags that must be returned", + "required": false, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RetrieveTagsResult" + } + } + } + } + }, + "/Api/MetadataBinding/RetrieveTags2/": { + "post": { + "tags": [ + "MetadataBinding" + ], + "summary": "Retrieve tags", + "operationId": "RetrieveTags", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "fieldName", + "in": "query", + "description": "The element name of the field for which to retrieve information", + "required": true, + "type": "string" + }, + { + "name": "fieldLevel", + "in": "query", + "description": "The IshLevel of the field for which to retrieve information", + "required": true, + "type": "string" + }, + { + "name": "fieldValues", + "in": "body", + "description": "The values of other fields which can be used as an additional filter", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldValue" + } + } + }, + { + "name": "inputFilter", + "in": "query", + "description": "String with the input of the user", + "required": false, + "type": "string" + }, + { + "name": "language", + "in": "query", + "description": "The language in which to return the label/description. If no language is provide, the user language is used.", + "required": false, + "type": "string" + }, + { + "name": "maxTagsToReturn", + "in": "query", + "description": "The maximum number of tags that must be returned", + "required": false, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RetrieveTagsResult" + } + } + } + } + }, + "/Api/MetadataBinding/ResolveIds/": { + "post": { + "tags": [ + "MetadataBinding" + ], + "summary": "Resolve ids", + "operationId": "ResolveIds", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "fieldTags", + "in": "body", + "description": "The fields with the ids to resolve", + "required": true, + "schema": { + "$ref": "#/definitions/FieldTags" + } + }, + { + "name": "language", + "in": "query", + "description": "The language in which to return the label/description. If no language is provide, the user language is used.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResolveIdsResult" + } + } + } + } + }, + "/Api/MetadataBinding/RetrieveTagStructure/": { + "post": { + "tags": [ + "MetadataBinding" + ], + "summary": "Retrieve Tag Structure", + "operationId": "RetrieveTagStructure", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "fieldName", + "in": "query", + "description": "The element name of the field for which to retrieve information", + "required": true, + "type": "string" + }, + { + "name": "fieldLevel", + "in": "query", + "description": "The IshLevel of the field for which to retrieve information", + "required": true, + "type": "string", + "enum": [ + "none", + "logical", + "version", + "language", + "annotation" + ] + }, + { + "name": "fieldsFilter", + "in": "body", + "description": "The values of other fields which can be used as an additional filter", + "required": true, + "schema": { + "$ref": "#/definitions/FieldsFilter" + } + }, + { + "name": "language", + "in": "query", + "description": "The language in which to return the label/description. If no language is provide, the user language is used.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RetrieveTagsStructureResult" + } + } + } + } + }, + "/Api/MetadataBinding/RetrieveTagStructure2/": { + "post": { + "tags": [ + "MetadataBinding" + ], + "summary": "Retrieve Tag Structure", + "operationId": "RetrieveTagStructure", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "fieldName", + "in": "query", + "description": "The element name of the field for which to retrieve information", + "required": true, + "type": "string" + }, + { + "name": "fieldLevel", + "in": "query", + "description": "The IshLevel of the field for which to retrieve information", + "required": true, + "type": "string" + }, + { + "name": "fieldValues", + "in": "body", + "description": "The values of other fields which can be used as an additional filter", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldValue" + } + } + }, + { + "name": "language", + "in": "query", + "description": "The language in which to return the label/description. If no language is provide, the user language is used.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RetrieveTagsStructureResult" + } + } + } + } + }, + "/Api/Publication/MetadataForm/": { + "get": { + "tags": [ + "Publication" + ], + "summary": "Gets a form containing definition and values needed to generate a form to create a new publication.", + "description": "The {formId} is optional. By default, \"Properties_Create_\" is used.\r\nThis method is only to be used in the old web client.", + "operationId": "GetCreateObjectForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "folderCardId", + "in": "query", + "description": "The card identifier of the folder where to create a new publication. The identifier is required.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "referenceLogicalId", + "in": "query", + "description": "The identifier of the publication to update. The identifier is required.", + "required": true, + "type": "string" + }, + { + "name": "referenceVersion", + "in": "query", + "description": "The identifier of the publication version object to update.", + "required": true, + "type": "string" + }, + { + "name": "clientName", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + } + }, + "/Api/Publication/{folderCardId}/": { + "post": { + "tags": [ + "Publication" + ], + "summary": "Creates a new object in the specified folder.", + "description": "The parameter {metadata} can only contain logical and version level fields.\r\nThe logical identifier can explicitly be added to the metadata.", + "operationId": "CreateObject", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "folderCardId", + "in": "path", + "description": "The card identifier of the folder where to create the new object.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "metadata", + "in": "body", + "description": "The metadata that will be set on the object.", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/Publication/": { + "put": { + "tags": [ + "Publication" + ], + "operationId": "UpdateObject", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [], + "parameters": [ + { + "name": "logicalId", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "metadata", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/Publication/VersionObject/MetadataForm/": { + "get": { + "tags": [ + "Publication" + ], + "summary": "Gets a form containing definition and values needed to generate a form to create a new publication version.", + "description": "The {fromVersion} is optional. By default, a new version number will be generated.\r\nThe {doBranch} is optional. By default, a new version number will be generated.\r\nThe {formId} is optional. By default, \"Trisoft.InfoShareAuthor.CreateVersionPublication\" is used.\r\nThis method is only to be used in the old web client.", + "operationId": "GetCreateVersionForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "query", + "description": "The identifier of the publication where to create the new version object. The identifier is required.", + "required": true, + "type": "string" + }, + { + "name": "referenceLogicalId", + "in": "query", + "description": "The identifier of the publication to update. The identifier is required.", + "required": true, + "type": "string" + }, + { + "name": "referenceVersion", + "in": "query", + "description": "The identifier of the publication version object to update.", + "required": true, + "type": "string" + }, + { + "name": "fromVersion", + "in": "query", + "description": "The version from which a version or branch has to be created. A new (branched) version number will be generated and returned\r\n as part of the metadata. If not provided a new version number will be generated and returned.", + "required": false, + "type": "string" + }, + { + "name": "doBranch", + "in": "query", + "description": "true if a branch has to be created; otherwise, false.", + "required": false, + "type": "boolean" + }, + { + "name": "clientName", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + } + }, + "/Api/Publication/VersionObject/": { + "post": { + "tags": [ + "Publication" + ], + "summary": "Creates a new version object in the specified logical object.", + "description": "The parameter {metadata} can only contain version level fields.\r\nThe version can explicitly be added to the metadata. If the version is not provided by the metadatas the version will be generated by calculating the next free version number on the main branch for the specified logical object (e.g. 3.1.2 -> 4).\r\nThis method is only to be used in the old web client.", + "operationId": "CreateVersionObject", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "logicalId", + "in": "query", + "description": "The identifier of the logical object where to create the new version object.", + "required": true, + "type": "string" + }, + { + "name": "metadata", + "in": "body", + "description": "The metadata that will be set on the version object.", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/Publication/MetadataForm/LatestVersion/": { + "get": { + "tags": [ + "Publication" + ], + "summary": "Gets the latest version of related logicalId.", + "operationId": "GetLatestVersion", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "query", + "description": "The identifier of the logical object.", + "required": true, + "type": "string" + }, + { + "name": "fromVersion", + "in": "query", + "description": "Version of the object.", + "required": false, + "type": "string" + }, + { + "name": "doBranch", + "in": "query", + "description": "true if a branch has to be created; otherwise, false.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + } + } + } + }, + "/Api/Publication/VersionObject/{publicationLogicalId}/{publicationVersion}/Preview/": { + "get": { + "tags": [ + "Publication" + ], + "summary": "Preview an object by logical id", + "operationId": "Preview", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "publicationLogicalId", + "in": "path", + "description": "LogicalId of the publication.", + "required": true, + "type": "string" + }, + { + "name": "publicationVersion", + "in": "path", + "description": "Version of the publication. Default is the latest available.", + "required": true, + "type": "string" + }, + { + "name": "logicalId", + "in": "query", + "description": "LogicalId of the object.", + "required": false, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "Version of object. Default is the latest available.", + "required": false, + "type": "string" + }, + { + "name": "language", + "in": "query", + "description": "Language of object. Default is the working language of the user.", + "required": false, + "type": "string" + }, + { + "name": "resolution", + "in": "query", + "description": "Resolution of object. Default is the system resolution.", + "required": false, + "type": "string" + }, + { + "name": "embed", + "in": "query", + "description": "The object is embedded in a page or not.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/Publication/VersionObject/{publicationLogicalId}/{publicationVersion}/SearchAnywhere/": { + "get": { + "tags": [ + "Publication" + ], + "summary": "Simple search to search for a specific value in the repository.", + "description": "This endpoint does not support searching for the publication object type.", + "operationId": "SearchAnywhere", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "publicationLogicalId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "publicationVersion", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "value", + "in": "query", + "description": "Simple text value to search for.", + "required": true, + "type": "string" + }, + { + "name": "languages", + "in": "query", + "description": "Languages to return.\r\nWhen providing multiple values you should do \"&languages=en&languages=fr\".\r\nDefault value is the working language of the current user.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "resolutions", + "in": "query", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "objectTypes", + "in": "query", + "description": "Object types to return.\r\nBy default all object types are returned.", + "required": false, + "type": "string", + "enum": [ + "none", + "module", + "master", + "library", + "illustration", + "template", + "publication" + ] + }, + { + "name": "baselineAutoCompleteMode", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "maximumHits", + "in": "query", + "description": "Maximum hits to return.\r\nDefault value is 100.", + "required": false, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchResults" + } + } + } + } + }, + "/Api/Publication/Metadata/": { + "post": { + "tags": [ + "Publication" + ], + "summary": "Gets the metadata for publication using the requested metadata filter.", + "operationId": "GetMetadata", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "The parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/PublicationMetadataParameters" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PublicationMetadata" + } + } + } + } + }, + "/Api/PublicationOutput/{publicationOutputCardId}/CanReview/": { + "get": { + "tags": [ + "PublicationOutput" + ], + "summary": "Gets the can review state for a publication output.", + "operationId": "CanReview", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "publicationOutputCardId", + "in": "path", + "description": "Card ID of a publication output to validate the review end date for.", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "boolean" + } + } + } + } + }, + "/Api/PublicationOutput/{publicationOutputCardId}/Download/": { + "get": { + "tags": [ + "PublicationOutput" + ], + "summary": "Downloads a publication output.", + "operationId": "Download", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "publicationOutputCardId", + "in": "path", + "description": "Card ID of a publication output", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/PublicationOutput/LogicalObject/MetadataForm/": { + "get": { + "tags": [ + "PublicationOutput" + ], + "summary": "Gets a form containing definition and values needed to generate a form to create a new publication.", + "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.CreateLogicalPublication\" is used.\r\nThis method is only to be used in the old web client.", + "operationId": "GetCreateLogicalObjectForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "folderCardId", + "in": "query", + "description": "The card identifier of the folder where to create a new publication. The identifier is required.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + } + }, + "/Api/PublicationOutput/LogicalObject/{logicalId}/MetadataForm/": { + "get": { + "tags": [ + "PublicationOutput" + ], + "summary": "Gets a form containing definition and values needed to generate a form to update an existing publication.", + "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.UpdateLogicalPublication\" is used.\r\nThis method is only to be used in the old web client.", + "operationId": "GetUpdateLogicalObjectForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "The identifier of the publication to update. The identifier is required.", + "required": true, + "type": "string" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + } + }, + "/Api/PublicationOutput/VersionObject/MetadataForm/": { + "get": { + "tags": [ + "PublicationOutput" + ], + "summary": "Gets a form containing definition and values needed to generate a form to create a new publication version.", + "description": "The {fromVersion} is optional. By default, a new version number will be generated.\r\nThe {doBranch} is optional. By default, a new version number will be generated.\r\nThe {formId} is optional. By default, \"Trisoft.InfoShareAuthor.CreateVersionPublication\" is used.\r\nThis method is only to be used in the old web client.", + "operationId": "GetCreateVersionObjectForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "query", + "description": "The identifier of the publication where to create the new version object. The identifier is required.", + "required": true, + "type": "string" + }, + { + "name": "fromVersion", + "in": "query", + "description": "The version from which a version or branch has to be created. A new (branched) version number will be generated and returned\r\n as part of the metadata. If not provided a new version number will be generated and returned.", + "required": false, + "type": "string" + }, + { + "name": "doBranch", + "in": "query", + "description": "true if a branch has to be created; otherwise, false.", + "required": false, + "type": "boolean" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + } + }, + "/Api/PublicationOutput/VersionObject/{logicalId}/{version}/MetadataForm/": { + "get": { + "tags": [ + "PublicationOutput" + ], + "summary": "Gets a form containing definition and values needed to generate a form to update a publication version.", + "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.UpdateVersionPublication\" is used.\r\nThis method is only to be used in the old web client.", + "operationId": "GetUpdateVersionObjectForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "The identifier of the publication containing the version object.", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The version of the version object.", + "required": true, + "type": "string" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + } + }, + "/Api/PublicationOutput/LanguageObject/MetadataForm/": { + "get": { + "tags": [ + "PublicationOutput" + ], + "summary": "Gets a form containing definition and values needed to generate a form to create a new publication output.", + "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.CreateLanguagePublication\" is used.\r\nThis method is only to be used in the old web client.", + "operationId": "GetCreateLanguageObjectForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "query", + "description": "The identifier of the logical object where to create the new publication output. The identifier is required.", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "The version of the publication where to create the new publication output. The version is required.", + "required": true, + "type": "string" + }, + { + "name": "outputFormatId", + "in": "query", + "description": "The identifier of the output format that is used to create the new publication output.", + "required": false, + "type": "string" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + } + }, + "/Api/PublicationOutput/LanguageObject/{languageCardId}/MetadataForm/": { + "get": { + "tags": [ + "PublicationOutput" + ], + "summary": "Gets a form containing definition and values needed to generate a form to update a publication output.", + "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.UpdateLanguagePublication\" is used.\r\nThis method is only to be used in the old web client.", + "operationId": "GetUpdateLanguageObjectForm", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Card identifier of the publication output. The card identifier is required.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + } + }, + "/Api/PublicationOutput/LogicalObject/": { + "post": { + "tags": [ + "PublicationOutput" + ], + "summary": "Creates a new logical object in the specified folder.", + "description": "The parameter {metadata} can only contain logical level fields.\r\nThe logical identifier can explicitly be added to the metadata.\r\nThis method is only to be used in the old web client.", + "operationId": "CreateLogicalObject", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "folderCardId", + "in": "query", + "description": "The card identifier of the folder where to create the new logical object.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "metadata", + "in": "body", + "description": "The metadata that will be set on the logical object.", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/PublicationOutput/LogicalObject/{logicalId}/": { + "put": { + "tags": [ + "PublicationOutput" + ], + "summary": "Updates a logical object with the specified metadata.", + "description": "The parameter {metadata} can only contain logical level fields.\r\nThis method is only to be used in the old web client.", + "operationId": "UpdateLogicalObject", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "Logical object id", + "required": true, + "type": "string" + }, + { + "name": "metadata", + "in": "body", + "description": "The metadata that will be set on the logical object.", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + }, + "delete": { + "tags": [ + "PublicationOutput" + ], + "summary": "Deletes a logical object.", + "description": "Requirements are: \r\n The user must have write access for the folder in which the object is going to be deleted. \r\n The documentation (DocumentObj 2.5 - Delete describes the behavior depending on your starting situation. [SRQ-3834] ", + "operationId": "DeleteLogicalObject", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "Logical object id", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/PublicationOutput/VersionObject/": { + "post": { + "tags": [ + "PublicationOutput" + ], + "summary": "Creates a new version object in the specified logical object.", + "description": "The parameter {metadata} can only contain version level fields.\r\nThe version can explicitly be added to the metadata. If the version is not provided by the metadatas the version will be generated by calculating the next free version number on the main branch for the specified logical object (e.g. 3.1.2 -> 4).\r\nThis method is only to be used in the old web client.", + "operationId": "CreateVersionObject", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "logicalId", + "in": "query", + "description": "The identifier of the logical object where to create the new version object.", + "required": true, + "type": "string" + }, + { + "name": "metadata", + "in": "body", + "description": "The metadata that will be set on the version object.", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/PublicationOutput/VersionObject/{logicalId}/{version}/": { + "put": { + "tags": [ + "PublicationOutput" + ], + "summary": "Updates the version object specified by {logicalId} and {version} with the specified metadata.", + "description": "The parameter {metadata} can only contain version level fields.\r\nThis method is only to be used in the old web client.", + "operationId": "UpdateVersionObject", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "The identifier of the logical object containing the version object.", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "The version of the version object.", + "required": true, + "type": "string" + }, + { + "name": "metadata", + "in": "body", + "description": "The metadata that will be set on the version object.", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + }, + "delete": { + "tags": [ + "PublicationOutput" + ], + "summary": "Deletes a version object.", + "description": "Requirements are: \r\n The user must have write access for the folder in which the object is going to be deleted. \r\n The documentation (DocumentObj 2.5 - Delete describes the behavior depending on your starting situation. [SRQ-3834] ", + "operationId": "DeleteVersionObject", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "Lobical object ID", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "description": "Version object version", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/PublicationOutput/LanguageObject/": { + "post": { + "tags": [ + "PublicationOutput" + ], + "summary": "Creates a new language object in the version object specified by {logicalId} and {version}.", + "description": "The metadata can only contain language level fields.\r\nThe language and resolution can explicitly be added to the metadata. If the language is not provided by the metadata the default language will be used (language on user card). If the resolution is not provided by the metadata the default resolution will be used (resolution on settings card).\r\nThis method is only to be used in the old web client.", + "operationId": "CreateLanguageObject", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "logicalId", + "in": "query", + "description": "The identifier of the logical object where to create the new language object.", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "The version of the version object where to create the new language object.", + "required": true, + "type": "string" + }, + { + "name": "metadata", + "in": "body", + "description": "The metadata that will be set on the version object.", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/PublicationOutput/LanguageObject/{languageCardId}/": { + "put": { + "tags": [ + "PublicationOutput" + ], + "summary": "Updates a language object with the specified metadata.", + "description": "The metadata that will be set on the language object, can be passed in the request body in JSON format.\r\nThe metadata can only contain language level fields.\r\nThis method is only to be used in the old web client.\r\nWhen content has to be uploaded, it can be passed in the request body in multipart format. The multipart body can contain 2 parts. A part named \"metadata\" containing the metadata in JSON format, and a part named \"data\" containing the content.", + "operationId": "UpdateLanguageObject", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Card identifier of the language object.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "metadata", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + }, + "delete": { + "tags": [ + "PublicationOutput" + ], + "summary": "Deletes a language object.", + "description": "Requirements are: \r\n The user must have write access for the folder in which the object is going to be deleted. \r\n The documentation (DocumentObj 2.5 - Delete describes the behavior depending on your starting situation. [SRQ-3834] ", + "operationId": "DeleteLanguageObject", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Card identifier of the language object.", + "required": true, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/PublicationOutput/LogicalObject/{logicalId}/Versions/": { + "get": { + "tags": [ + "PublicationOutput" + ], + "summary": "Gets the list of versions for the publication specified by logical ID.", + "operationId": "GetVersions", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "path", + "description": "Logical object ID.", + "required": true, + "type": "string" + }, + { + "name": "sortOrder", + "in": "query", + "description": "Specifies the sort order of the versions. Default: Descending.", + "required": false, + "type": "string", + "enum": [ + "none", + "ascending", + "descending" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "/Api/PublicationOutput/Output/MetadataForm/": { + "get": { + "tags": [ + "PublicationOutput" + ], + "summary": "Gets a form containing definition and values needed to generate a form to create a new publication output.", + "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.CreateLanguagePublication\" is used.\r\nThis method is only to be used in the old web client.", + "operationId": "GetCreateOutput", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "logicalId", + "in": "query", + "description": "The identifier of the logical object where to create the new publication output. The identifier is required.", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "The version of the publication where to create the new publication output. The version is required.", + "required": true, + "type": "string" + }, + { + "name": "outputFormatId", + "in": "query", + "description": "The identifier of the output format that is used to create the new publication output.", + "required": false, + "type": "string" + }, + { + "name": "clientName", + "in": "query", + "description": "The list of values for client name in the metadataconfig conditions.", + "required": false, + "type": "string" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + } + }, + "/Api/PublicationOutput/Output/": { + "post": { + "tags": [ + "PublicationOutput" + ], + "summary": "Creates a new output in the version object specified by {logicalId} and {version}.", + "description": "The metadata can only contain language level fields.\r\nThe language and resolution can explicitly be added to the metadata. If the language is not provided by the metadata the default language will be used (language on user card). If the resolution is not provided by the metadata the default resolution will be used (resolution on settings card).\r\nThis method is only to be used in the old web client.", + "operationId": "CreateOutput", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "logicalId", + "in": "query", + "description": "The identifier of the logical object where to create the new output.", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "query", + "description": "The version of the version object where to create the new output.", + "required": true, + "type": "string" + }, + { + "name": "metadata", + "in": "body", + "description": "The metadata that will be set on the version object.", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/PublicationOutput/Output/{languageCardId}/MetadataForm/": { + "get": { + "tags": [ + "PublicationOutput" + ], + "summary": "Gets a form containing definition and values needed to generate a form to update a publication output.", + "description": "The {formId} is optional. By default, \"Trisoft.InfoShareAuthor.UpdateLanguagePublication\" is used.\r\nThis method is only to be used in the old web client.", + "operationId": "GetUpdateOutput", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Card identifier of the publication output. The card identifier is required.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "clientName", + "in": "query", + "description": "The list of values for client name in the metadataconfig conditions.", + "required": false, + "type": "string" + }, + { + "name": "formId", + "in": "query", + "description": "The identifier of the form definition in the metadata configuration.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Form" + } + } + } + } + }, + "/Api/PublicationOutput/Output/{languageCardId}/": { + "put": { + "tags": [ + "PublicationOutput" + ], + "summary": "Updates a language object with the specified metadata.", + "description": "The metadata that will be set on the language object, can be passed in the request body in JSON format.\r\nThe metadata can only contain language level fields.\r\nThis method is only to be used in the old web client.\r\nWhen content has to be uploaded, it can be passed in the request body in multipart format. The multipart body can contain 2 parts. A part named \"metadata\" containing the metadata in JSON format, and a part named \"data\" containing the content.", + "operationId": "UpdateOutput", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [], + "parameters": [ + { + "name": "languageCardId", + "in": "path", + "description": "Card identifier of the language object.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "name": "metadata", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Metadata" + } + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/Search/Anywhere/": { + "get": { + "tags": [ + "Search" + ], + "summary": "Simple search to search for a specific value in the repository.", + "description": "This endpoint does not support searching for the publication object type.", + "operationId": "Anywhere", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "value", + "in": "query", + "description": "Simple text value to search for.", + "required": true, + "type": "string" + }, + { + "name": "languages", + "in": "query", + "description": "Languages to return.\r\nWhen providing multiple values you should do \"&languages=en&languages=fr\".\r\nDefault value is the working language of the current user.", + "required": false, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + }, + { + "name": "objectTypes", + "in": "query", + "description": "Object types to return.\r\nBy default all object types are returned.", + "required": false, + "type": "string", + "enum": [ + "none", + "module", + "master", + "library", + "illustration", + "template", + "publication" + ] + }, + { + "name": "maximumHits", + "in": "query", + "description": "Maximum hits to return.\r\nDefault value is 100.", + "required": false, + "type": "integer", + "format": "int64" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SearchResults" + } + } + } + } + }, + "/Api/Settings/ApplicationHost/": { + "get": { + "tags": [ + "Settings" + ], + "summary": "Get integration settings for the ApplicationHost.", + "operationId": "ApplicationHost", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationHostSettings" + } + } + } + } + }, + "/Api/Settings/Enrich/": { + "get": { + "tags": [ + "Settings" + ], + "summary": "Get integration settings for Enrich.", + "operationId": "Enrich", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EnrichSettings" + } + } + } + } + }, + "/Api/Settings/Integration/Reach/": { + "get": { + "tags": [ + "Settings" + ], + "summary": "Get integration settings for SDL LiveContent Reach.", + "operationId": "GetReachConfig", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReachConfig" + } + } + } + } + }, + "/Api/Settings/Integration/": { + "get": { + "tags": [ + "Settings" + ], + "summary": "Get integration settings for SDL LiveContent Create.", + "operationId": "GetCreateConfig", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/XopusConfig" + } + } + } + } + }, + "/Api/Settings/Integration/Create/": { + "get": { + "tags": [ + "Settings" + ], + "summary": "Get integration settings for SDL LiveContent Create.", + "operationId": "GetCreateConfig", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/XopusConfig" + } + } + } + } + }, + "/Api/Settings/Metadata/": { + "post": { + "tags": [ + "Settings" + ], + "summary": "Gets the Settings metadata", + "operationId": "GetMetadata", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "settingsMetadataParameters", + "in": "body", + "description": "SettingsMetadataParameters with the parameters for the call including:\r\n Requested metadata", + "required": true, + "schema": { + "$ref": "#/definitions/SettingsMetadataParameters" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SettingsMetadata" + } + } + } + } + }, + "/Api/Settings/CollectiveSpaces/": { + "get": { + "tags": [ + "Settings" + ], + "summary": "Gets the collective space configuration from settings and metadataconfig file.", + "operationId": "GetCollectiveSpaceConfig", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CollectiveSpacesConfig" + } + } + } + } + }, + "/Api/Synchronization/SyncInfo/": { + "get": { + "tags": [ + "Synchronization" + ], + "summary": "Gets the synchronization information required for the client application specified by {clientExe}, {clientExeVersion} and {clientEdition}, and/or for the Authoring Bridge specified by {authoringBridgeVersion}.", + "operationId": "GetSyncInfo", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "clientExe", + "in": "query", + "description": "File name of the client application (e.g. 'xmetal.exe')", + "required": false, + "type": "string" + }, + { + "name": "clientExeVersion", + "in": "query", + "description": "Version of the client application (e.g. 10.0)", + "required": false, + "type": "string" + }, + { + "name": "clientEdition", + "in": "query", + "description": "Edition of the client application (e.g. 'J' - Japanese)", + "required": false, + "type": "string" + }, + { + "name": "authoringBridgeVersion", + "in": "query", + "description": "Version of the Authoring Bridge (e.g. 12.0)", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object" + } + } + } + } + }, + "/Api/User/UserInfo/": { + "get": { + "tags": [ + "User" + ], + "summary": "Get info for the current logged on user", + "operationId": "GetUserInfo", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UserInfo" + } + } + } + } + }, + "/Api/User/ChangePassword/": { + "put": { + "tags": [ + "User" + ], + "summary": "Change password", + "operationId": "ChangePassword", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "userName", + "in": "query", + "description": "User name of the user to change the password for.", + "required": true, + "type": "string" + }, + { + "name": "oldPassword", + "in": "query", + "description": "Old password.", + "required": true, + "type": "string" + }, + { + "name": "newPassword", + "in": "query", + "description": "New password.", + "required": true, + "type": "string" + }, + { + "name": "confirmationPassword", + "in": "query", + "description": "Confirmation of new password.", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/User/Preferences/": { + "get": { + "tags": [ + "User" + ], + "summary": "Gets user preference sets", + "operationId": "GetPreferenceSets", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "preferenceSetNames", + "in": "query", + "description": "The set name filter used for filtering preference sets.", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/UserPreferenceSet" + } + } + } + } + }, + "put": { + "tags": [ + "User" + ], + "summary": "Sets user preference sets", + "operationId": "SetPreferenceSets", + "consumes": [ + "application/x-www-form-urlencoded", + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "produces": [], + "parameters": [ + { + "name": "preferenceSets", + "in": "body", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/UserPreferenceSet" + } + } + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + }, + "/Api/User/Preferences/UILanguage/": { + "get": { + "tags": [ + "User" + ], + "summary": "Gets user UILanguage preference for WebClient", + "operationId": "GetUiLanguagePreference", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "string" + } + } + } + }, + "put": { + "tags": [ + "User" + ], + "summary": "Sets user UILanguage preference for WebClient", + "operationId": "SetUiLanguagePreference", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "languageCode", + "in": "query", + "description": "Language code", + "required": true, + "type": "string" + } + ], + "responses": { + "204": { + "description": "No Content" + } + } + } + } + }, + "definitions": { + "AnnotationParameters": { + "type": "object", + "properties": { + "publicationId": { + "type": "string" + }, + "publicationVersion": { + "type": "string" + }, + "revisionId": { + "type": "string" + } + } + }, + "Form": { + "type": "object", + "properties": { + "definition": { + "$ref": "#/definitions/FormDefinition" + }, + "metadata": { + "$ref": "#/definitions/Metadata" + }, + "objectDescriptor": { + "$ref": "#/definitions/ObjectDescriptor" + } + } + }, + "FormDefinition": { + "type": "object", + "properties": { + "label": { + "$ref": "#/definitions/TranslatableValue" + }, + "description": { + "$ref": "#/definitions/TranslatableValue" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/FormChild" + } + }, + "id": { + "type": "string" + }, + "width": { + "type": "string" + }, + "height": { + "type": "string" + } + } + }, + "Metadata": { + "type": "object", + "properties": { + "fieldValues": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldValue" + } + } + } + }, + "ObjectDescriptor": { + "type": "object", + "properties": { + "objectType": { + "type": "string" + } + } + }, + "TranslatableValue": { + "type": "object", + "properties": { + "default": { + "type": "string" + }, + "resourceId": { + "type": "string" + } + } + }, + "FormChild": { + "required": [ + "discriminator" + ], + "type": "object", + "properties": { + "typeName": { + "type": "string", + "readOnly": true + }, + "label": { + "$ref": "#/definitions/TranslatableValue" + }, + "description": { + "$ref": "#/definitions/TranslatableValue" + }, + "discriminator": { + "type": "string" + } + }, + "discriminator": "discriminator" + }, + "FieldValue": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "level": { + "type": "string" + }, + "value": { + "type": "object" + }, + "originalValue": { + "type": "object" + }, + "valueType": { + "enum": [ + "undefined", + "string", + "number", + "dateTime", + "reference" + ], + "type": "string" + }, + "multiValue": { + "type": "boolean" + }, + "originalValueProvided": { + "type": "boolean" + } + } + }, + "AnnotationUpdateRequest": { + "type": "object", + "properties": { + "annotationId": { + "type": "string" + }, + "metadata": { + "$ref": "#/definitions/Metadata" + } + } + }, + "AnnotationUpdateResponse": { + "type": "object", + "properties": { + "errorNumber": { + "format": "int32", + "type": "integer" + }, + "errorMessage": { + "type": "string" + }, + "annotationId": { + "type": "string" + }, + "modifiedOn": { + "format": "date-time", + "type": "string" + }, + "createdOn": { + "format": "date-time", + "type": "string" + }, + "objectType": { + "type": "string" + } + } + }, + "AnnotationDescriptor": { + "type": "object", + "properties": { + "annotationId": { + "type": "string" + }, + "modifiedOn": { + "format": "date-time", + "type": "string" + }, + "createdOn": { + "format": "date-time", + "type": "string" + }, + "objectType": { + "type": "string" + } + } + }, + "AnnotationDetailParameters": { + "type": "object", + "properties": { + "annotationIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "requestedMetadata": { + "$ref": "#/definitions/RequestedMetadata" + } + } + }, + "RequestedMetadata": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataField" + } + } + } + }, + "MetadataField": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "level": { + "type": "string" + }, + "valueType": { + "type": "string" + } + } + }, + "AnnotationMetadata": { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/definitions/ResolvedMetadata" + }, + "annotationReplyMetadata": { + "type": "array", + "items": { + "$ref": "#/definitions/AnnotationReplyMetadata" + } + }, + "annotationId": { + "type": "string" + }, + "modifiedOn": { + "format": "date-time", + "type": "string" + }, + "createdOn": { + "format": "date-time", + "type": "string" + }, + "objectType": { + "type": "string" + } + } + }, + "ResolvedMetadata": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/ResolvedFieldValue" + } + } + } + }, + "AnnotationReplyMetadata": { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/definitions/ResolvedMetadata" + }, + "annotationReplyId": { + "format": "int64", + "type": "integer" + }, + "annotationId": { + "type": "string" + }, + "modifiedOn": { + "format": "date-time", + "type": "string" + }, + "createdOn": { + "format": "date-time", + "type": "string" + }, + "objectType": { + "type": "string" + } + } + }, + "ResolvedFieldValue": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true + }, + "level": { + "enum": [ + "none", + "logical", + "version", + "lng", + "annotation" + ], + "type": "string", + "readOnly": true + }, + "value": { + "type": "object", + "readOnly": true + }, + "valueType": { + "enum": [ + "none", + "id", + "value", + "element" + ], + "type": "string", + "readOnly": true + }, + "multiValue": { + "type": "boolean", + "readOnly": true + }, + "dataType": { + "type": "string", + "readOnly": true + } + } + }, + "AnnotationListParameters": { + "type": "object", + "properties": { + "requestedMetadata": { + "$ref": "#/definitions/RequestedMetadata" + }, + "metadataFilter": { + "$ref": "#/definitions/MetadataFilter" + } + } + }, + "MetadataFilter": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataFilterField" + } + } + } + }, + "MetadataFilterField": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "level": { + "type": "string" + }, + "operator": { + "type": "string" + }, + "valueType": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "AnnotationReplyDescriptor": { + "type": "object", + "properties": { + "annotationReplyId": { + "format": "int64", + "type": "integer" + }, + "annotationId": { + "type": "string" + }, + "modifiedOn": { + "format": "date-time", + "type": "string" + }, + "createdOn": { + "format": "date-time", + "type": "string" + }, + "objectType": { + "type": "string" + } + } + }, + "User": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "username": { + "type": "string" + }, + "email": { + "type": "string" + } + } + }, + "Publication": { + "type": "object", + "properties": { + "id": { + "format": "int32", + "type": "integer" + }, + "title": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "Status": { + "type": "object", + "properties": { + "id": { + "format": "int32", + "type": "integer" + }, + "title": { + "type": "string" + } + } + }, + "CommentingResult": { + "type": "object", + "properties": { + "comments": { + "type": "array", + "items": { + "$ref": "#/definitions/Comment" + } + }, + "total": { + "format": "int32", + "type": "integer" + } + } + }, + "Comment": { + "type": "object", + "properties": { + "id": { + "format": "int64", + "type": "integer" + }, + "content": { + "type": "string" + }, + "itemUri": { + "type": "string" + }, + "pageId": { + "format": "int32", + "type": "integer" + }, + "pageTitle": { + "type": "string" + }, + "pageUrl": { + "type": "string" + }, + "publicationId": { + "format": "int32", + "type": "integer" + }, + "publicationTitle": { + "type": "string" + }, + "publicationUrl": { + "type": "string" + }, + "creationDate": { + "format": "date-time", + "type": "string" + }, + "modifiedDate": { + "format": "date-time", + "type": "string" + }, + "parentId": { + "format": "int64", + "type": "integer" + }, + "status": { + "enum": [ + "new", + "approved", + "declined", + "completed" + ], + "type": "string" + }, + "user": { + "$ref": "#/definitions/User" + }, + "replyCount": { + "format": "int32", + "type": "integer" + }, + "language": { + "type": "string" + }, + "replies": { + "type": "array", + "items": { + "$ref": "#/definitions/Comment" + } + } + } + }, + "DocumentObjDescriptor": { + "type": "object", + "properties": { + "logicalId": { + "type": "string" + }, + "version": { + "type": "string" + }, + "language": { + "type": "string" + }, + "resolution": { + "type": "string" + }, + "logicalCardId": { + "format": "int64", + "type": "integer" + }, + "versionCardId": { + "format": "int64", + "type": "integer" + }, + "languageCardId": { + "format": "int64", + "type": "integer" + }, + "objectType": { + "type": "string" + } + } + }, + "InContextMetadataParameters": { + "type": "object", + "properties": { + "language": { + "type": "string" + }, + "resolution": { + "type": "string" + }, + "publicationId": { + "type": "string" + }, + "publicationVersion": { + "type": "string" + }, + "logicalIds": { + "type": "array", + "items": { + "type": "string" + } + }, + "requestedMetadata": { + "$ref": "#/definitions/RequestedMetadata" + }, + "keepOrder": { + "type": "boolean" + } + } + }, + "ContentObjectMetadata": { + "type": "object", + "properties": { + "resultType": { + "enum": [ + "notInitialized", + "objectInvalidId", + "objectNotFound", + "objectFound" + ], + "type": "string" + }, + "metadata": { + "$ref": "#/definitions/ResolvedMetadata" + }, + "logicalId": { + "type": "string" + }, + "version": { + "type": "string" + }, + "language": { + "type": "string" + }, + "resolution": { + "type": "string" + }, + "logicalCardId": { + "format": "int64", + "type": "integer" + }, + "versionCardId": { + "format": "int64", + "type": "integer" + }, + "languageCardId": { + "format": "int64", + "type": "integer" + }, + "objectType": { + "type": "string" + } + } + }, + "InContextContentParameters": { + "type": "object", + "properties": { + "language": { + "type": "string" + }, + "resolution": { + "type": "string" + }, + "publicationId": { + "type": "string" + }, + "publicationVersion": { + "type": "string" + }, + "revisionId": { + "type": "string" + }, + "ignoreNavigationTitles": { + "type": "boolean" + }, + "includeByteOrderMark": { + "type": "boolean" + } + } + }, + "InContextVariableAssignmentsParameters": { + "type": "object", + "properties": { + "publicationId": { + "type": "string" + }, + "publicationVersion": { + "type": "string" + }, + "language": { + "type": "string" + } + } + }, + "VariableResources": { + "type": "object", + "properties": { + "revisionId": { + "type": "string" + }, + "variableAssignments": { + "$ref": "#/definitions/VariableAssignments" + }, + "logicalId": { + "type": "string" + }, + "version": { + "type": "string" + }, + "language": { + "type": "string" + }, + "resolution": { + "type": "string" + }, + "logicalCardId": { + "format": "int64", + "type": "integer" + }, + "versionCardId": { + "format": "int64", + "type": "integer" + }, + "languageCardId": { + "format": "int64", + "type": "integer" + }, + "objectType": { + "type": "string" + } + } + }, + "VariableAssignments": { + "type": "object", + "properties": { + "variables": { + "type": "array", + "items": { + "$ref": "#/definitions/VariableAssignment" + } + } + } + }, + "VariableAssignment": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "content": { + "type": "string" + } + } + }, + "DocumentObjectFilter": { + "type": "object", + "properties": { + "languageCardIds": { + "type": "array", + "items": { + "format": "int64", + "type": "integer" + } + }, + "statusFilter": { + "enum": [ + "latestReleasedVersions", + "draftOrLatestReleasedVersions", + "allReleasedVersions", + "noStatusFilter" + ], + "type": "string" + }, + "metadataFilter": { + "$ref": "#/definitions/MetadataFilter" + }, + "requestedMetadata": { + "$ref": "#/definitions/RequestedMetadata" + } + } + }, + "Item": { + "type": "object", + "properties": { + "checkedOutBy": { + "type": "string" + }, + "language": { + "type": "string" + }, + "languageCardId": { + "format": "int64", + "type": "integer" + }, + "logicalId": { + "type": "string" + }, + "resolution": { + "type": "string" + }, + "status": { + "type": "string" + }, + "version": { + "type": "string" + }, + "title": { + "type": "string" + }, + "revision": { + "format": "int64", + "type": "integer" + }, + "revisionId": { + "type": "string" + }, + "electronicDocumentType": { + "$ref": "#/definitions/ElectronicDocumentType" + } + } + }, + "ElectronicDocumentType": { + "type": "object", + "properties": { + "defaultExtension": { + "type": "string" + }, + "mimeType": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, + "MetadataAndContent": { + "type": "object", + "properties": { + "item": { + "$ref": "#/definitions/MetadataAndContentItem" + }, + "content": { + "type": "string" + } + } + }, + "MetadataAndContentItem": { + "type": "object", + "properties": { + "canCheckIn": { + "type": "boolean" + }, + "canCheckOut": { + "type": "boolean" + }, + "canUndoCheckOut": { + "type": "boolean" + }, + "css": { + "type": "string" + }, + "docType": { + "type": "string" + }, + "publicId": { + "type": "string" + }, + "xsd": { + "type": "string" + }, + "title": { + "type": "string" + }, + "revision": { + "format": "int64", + "type": "integer" + }, + "pipeline": { + "$ref": "#/definitions/Pipeline" + }, + "checkedOutBy": { + "type": "string" + }, + "language": { + "type": "string" + }, + "languageCardId": { + "format": "int64", + "type": "integer" + }, + "logicalId": { + "type": "string" + }, + "resolution": { + "type": "string" + }, + "status": { + "type": "string" + }, + "version": { + "type": "string" + }, + "revisionId": { + "type": "string" + }, + "electronicDocumentType": { + "$ref": "#/definitions/ElectronicDocumentType" + } + } + }, + "Pipeline": { + "type": "object", + "properties": { + "version": { + "type": "string" + }, + "xml": { + "type": "string" + }, + "xsd": { + "type": "string" + }, + "views": { + "type": "array", + "items": { + "$ref": "#/definitions/XopusConfigView" + } + } + } + }, + "XopusConfigView": { + "type": "object", + "properties": { + "actions": { + "type": "array", + "items": { + "$ref": "#/definitions/XopusConfigAction" + } + }, + "name": { + "type": "string" + } + } + }, + "XopusConfigAction": { + "type": "object", + "properties": { + "type": { + "type": "string", + "readOnly": true + } + } + }, + "ComparePreview": { + "type": "object", + "properties": { + "hasDifferences": { + "type": "boolean" + }, + "content": { + "type": "string" + } + } + }, + "RevisionInfo": { + "type": "object", + "properties": { + "revisionId": { + "type": "string" + }, + "revision": { + "format": "int64", + "type": "integer" + } + } + }, + "ValueListItem": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "text": { + "$ref": "#/definitions/TranslatableValue" + }, + "description": { + "$ref": "#/definitions/TranslatableValue" + } + } + }, + "ExternalPreview": { + "type": "object", + "properties": { + "base64Blob": { + "type": "string" + }, + "preTranslationType": { + "type": "string" + }, + "host": { + "type": "string" + }, + "ignoreObjectFragments": { + "type": "boolean" + }, + "ignoreLinkTexts": { + "type": "boolean" + }, + "ignoreNavigationTitles": { + "type": "boolean" + } + } + }, + "UserInfo": { + "type": "object", + "properties": { + "userName": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "canChangePassword": { + "type": "boolean" + }, + "isAdmin": { + "type": "boolean" + } + } + }, + "EditorTemplateSpecification": { + "type": "object", + "properties": { + "editorTemplateGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/EditorTemplateGroup" + } + }, + "editorTemplates": { + "type": "array", + "items": { + "$ref": "#/definitions/EditorTemplate" + } + } + } + }, + "EditorTemplateGroup": { + "type": "object", + "properties": { + "id": { + "format": "int64", + "type": "integer" + }, + "name": { + "type": "string" + }, + "objectType": { + "type": "string" + } + } + }, + "EditorTemplate": { + "type": "object", + "properties": { + "logicalId": { + "type": "string" + }, + "languageCardId": { + "format": "int64", + "type": "integer" + }, + "editorTemplateGroupId": { + "format": "int64", + "type": "integer" + }, + "language": { + "type": "string" + }, + "title": { + "type": "string" + }, + "icon": { + "type": "string" + }, + "description": { + "type": "string" + }, + "version": { + "type": "string" + } + } + }, + "Favorites": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/Favorite" + } + } + } + }, + "Favorite": { + "type": "object", + "properties": { + "logicalId": { + "type": "string" + }, + "logicalCardId": { + "format": "int64", + "type": "integer" + }, + "title": { + "type": "string" + }, + "type": { + "enum": [ + "none", + "module", + "master", + "library", + "template", + "illustration", + "publication", + "referenceFolder", + "queryFolder", + "folder" + ], + "type": "string" + }, + "folderPath": { + "$ref": "#/definitions/FolderPath" + } + } + }, + "FolderPath": { + "type": "object", + "properties": { + "folderPathSegments": { + "type": "array", + "items": { + "$ref": "#/definitions/FolderPathSegment" + } + } + } + }, + "FolderPathSegment": { + "type": "object", + "properties": { + "folderCardId": { + "format": "int64", + "type": "integer" + }, + "depth": { + "format": "int64", + "type": "integer" + }, + "label": { + "type": "string" + } + } + }, + "FolderModel": { + "type": "object", + "properties": { + "folderCardId": { + "format": "int64", + "type": "integer" + }, + "parentFolderCardId": { + "format": "int64", + "type": "integer" + }, + "isBaseFolder": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "ownedBy": { + "type": "string" + }, + "readAccess": { + "type": "array", + "items": { + "type": "string" + } + }, + "xmlQuery": { + "type": "string" + }, + "folderType": { + "enum": [ + "none", + "module", + "master", + "library", + "template", + "illustration", + "publication", + "reference", + "query" + ], + "type": "string" + } + } + }, + "Folders": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/NavigationFolder" + } + } + } + }, + "NavigationFolder": { + "type": "object", + "properties": { + "folderType": { + "enum": [ + "none", + "module", + "master", + "library", + "template", + "illustration", + "publication", + "reference", + "query" + ], + "type": "string" + }, + "cardId": { + "format": "int64", + "type": "integer" + }, + "isBaseFolder": { + "type": "boolean" + }, + "parentId": { + "format": "int64", + "type": "integer" + }, + "title": { + "type": "string" + } + } + }, + "FolderContent": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/FolderContentItem" + } + } + } + }, + "FolderContentItem": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "logicalId": { + "type": "string" + }, + "canCheckIn": { + "type": "boolean" + }, + "canCheckOut": { + "type": "boolean" + }, + "canUndoCheckOut": { + "type": "boolean" + }, + "exception": { + "type": "string" + }, + "itemType": { + "enum": [ + "none", + "module", + "master", + "library", + "template", + "illustration", + "publication", + "referenceFolder", + "queryFolder", + "folder" + ], + "type": "string" + }, + "version": { + "type": "string" + }, + "language": { + "type": "string" + }, + "resolution": { + "type": "string" + }, + "cardId": { + "format": "int64", + "type": "integer" + }, + "isBaseFolder": { + "type": "boolean" + }, + "parentId": { + "format": "int64", + "type": "integer" + }, + "title": { + "type": "string" + } + } + }, + "FieldsFilter": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/Field" + } + } + } + }, + "Field": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "level": { + "enum": [ + "none", + "logical", + "version", + "language", + "annotation" + ], + "type": "string" + }, + "valueType": { + "enum": [ + "none", + "id", + "value", + "element" + ], + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "RetrieveTagsResult": { + "type": "object", + "properties": { + "tags": { + "type": "array", + "items": { + "$ref": "#/definitions/Tag" + } + }, + "messages": { + "type": "array", + "items": { + "$ref": "#/definitions/Message" + } + } + } + }, + "Tag": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "label": { + "type": "string" + }, + "annotatedLabel": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "Message": { + "type": "object", + "properties": { + "baseDescription": { + "type": "string" + }, + "description": { + "type": "string" + }, + "resourceId": { + "type": "string" + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/Parameter" + } + }, + "type": { + "enum": [ + "error", + "warning", + "info" + ], + "type": "string" + } + } + }, + "Parameter": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "FieldTags": { + "type": "object", + "properties": { + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldTag" + } + } + } + }, + "FieldTag": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "ids": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ResolveIdsResult": { + "type": "object", + "properties": { + "resolveIdResults": { + "type": "array", + "items": { + "$ref": "#/definitions/ResolveIdResult" + } + } + } + }, + "ResolveIdResult": { + "type": "object", + "properties": { + "messages": { + "type": "array", + "items": { + "$ref": "#/definitions/Message" + } + }, + "fieldName": { + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/definitions/Tag" + } + } + } + }, + "RetrieveTagsStructureResult": { + "type": "object", + "properties": { + "tags": { + "type": "array", + "items": { + "$ref": "#/definitions/StructureTag" + } + }, + "relations": { + "type": "array", + "items": { + "$ref": "#/definitions/TagRelation" + } + }, + "messages": { + "type": "array", + "items": { + "$ref": "#/definitions/Message" + } + } + } + }, + "StructureTag": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "label": { + "type": "string" + }, + "isSelectable": { + "type": "boolean" + }, + "description": { + "type": "string" + } + } + }, + "TagRelation": { + "type": "object", + "properties": { + "fromId": { + "type": "string" + }, + "toId": { + "type": "string" + } + } + }, + "SearchResults": { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchResult" + } + }, + "totalHits": { + "format": "int64", + "type": "integer" + } + } + }, + "SearchResult": { + "type": "object", + "properties": { + "languageCardId": { + "format": "int64", + "type": "integer" + }, + "logicalId": { + "type": "string" + }, + "type": { + "enum": [ + "none", + "module", + "master", + "library", + "illustration", + "template", + "publication" + ], + "type": "string" + }, + "language": { + "type": "string" + }, + "version": { + "type": "string" + }, + "resolution": { + "type": "string" + }, + "title": { + "type": "string" + }, + "folderPath": { + "$ref": "#/definitions/FolderPath" + }, + "score": { + "format": "double", + "type": "number" + } + } + }, + "PublicationMetadataParameters": { + "type": "object", + "properties": { + "publicationId": { + "type": "string" + }, + "publicationVersion": { + "type": "string" + }, + "requestedMetadata": { + "$ref": "#/definitions/RequestedMetadata" + } + } + }, + "PublicationMetadata": { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/definitions/ResolvedMetadata" + }, + "logicalId": { + "type": "string" + }, + "version": { + "type": "string" + }, + "logicalCardId": { + "format": "int64", + "type": "integer" + }, + "versionCardId": { + "format": "int64", + "type": "integer" + }, + "languageCardId": { + "format": "int64", + "type": "integer" + }, + "objectType": { + "type": "string" + } + } + }, + "ApplicationHostSettings": { + "type": "object", + "properties": { + "enrichUri": { + "type": "string" + }, + "reachUri": { + "type": "string" + }, + "ugcUri": { + "type": "string" + } + } + }, + "EnrichSettings": { + "type": "object", + "properties": { + "uri": { + "type": "string" + } + } + }, + "ReachConfig": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "reachRelativeUrl": { + "type": "string" + }, + "architectRelativeUrl": { + "type": "string" + } + } + }, + "XopusConfig": { + "type": "object", + "properties": { + "version": { + "type": "string" + }, + "import": { + "$ref": "#/definitions/Import" + }, + "catalog": { + "$ref": "#/definitions/Catalog" + }, + "changeTracking": { + "$ref": "#/definitions/ChangeTracking" + }, + "nodeConfig": { + "$ref": "#/definitions/NodeConfig" + }, + "javascript": { + "$ref": "#/definitions/Javascript" + }, + "lookupConfig": { + "$ref": "#/definitions/LookupConfig" + }, + "miscellaneous": { + "$ref": "#/definitions/Miscellaneous" + }, + "spellChecker": { + "$ref": "#/definitions/SpellChecker" + }, + "overlay": { + "$ref": "#/definitions/Overlay" + }, + "pipeline": { + "$ref": "#/definitions/Pipeline" + }, + "validation": { + "$ref": "#/definitions/Validation" + } + } + }, + "Import": { + "type": "object", + "properties": { + "source": { + "type": "string" + } + } + }, + "Catalog": { + "type": "object", + "properties": { + "source": { + "type": "string" + } + } + }, + "ChangeTracking": { + "type": "object", + "properties": { + "visible": { + "type": "boolean" + }, + "enabled": { + "type": "boolean" + }, + "allowAccept": { + "type": "boolean" + }, + "allowReject": { + "type": "boolean" + } + } + }, + "NodeConfig": { + "type": "object", + "properties": { + "node": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeConfigNode" + } + } + } + }, + "Javascript": { + "type": "object", + "properties": { + "source": { + "type": "string" + }, + "content": { + "type": "string" + } + } + }, + "LookupConfig": { + "type": "object", + "properties": { + "lookup": { + "type": "array", + "items": { + "$ref": "#/definitions/LookupConfigLookup" + } + } + } + }, + "Miscellaneous": { + "type": "object", + "properties": { + "attentionBorders": { + "type": "boolean" + }, + "debugMode": { + "type": "boolean" + }, + "disableContextMenu": { + "type": "boolean" + }, + "disableQuickInsertMenu": { + "type": "boolean" + }, + "extensiveInsertMenu": { + "type": "boolean" + }, + "hideStatusbar": { + "type": "boolean" + }, + "ignoreUnsavedChanges": { + "type": "boolean" + }, + "reproducerSupportEmailAddress": { + "type": "string" + }, + "saveWithIndentation": { + "type": "string" + }, + "hideMaximizeViewportButton": { + "type": "boolean" + }, + "skipPrecalculationForNS": { + "type": "string" + }, + "useSchemaOrderInUI": { + "type": "string" + } + } + }, + "SpellChecker": { + "type": "object", + "properties": { + "defaultLanguage": { + "type": "string" + } + } + }, + "Overlay": { + "type": "object", + "properties": { + "ribbonElements": { + "type": "array", + "items": { + "$ref": "#/definitions/OverlayRibbonElement" + } + } + } + }, + "Validation": { + "type": "object", + "properties": { + "autoMakeValid": { + "type": "boolean" + }, + "validateSimpleTypes": { + "type": "boolean" + } + } + }, + "NodeConfigNode": { + "type": "object", + "properties": { + "match": { + "type": "string" + }, + "description": { + "type": "string" + }, + "enumeration": { + "$ref": "#/definitions/NodeConfigNodeEnumeration" + }, + "invalidValueMessage": { + "type": "boolean" + }, + "inputType": { + "type": "string" + }, + "lookup": { + "type": "array", + "items": { + "$ref": "#/definitions/LookupConfigLookup" + } + }, + "name": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeConfigElementWithLang" + } + }, + "placeholder": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeConfigElementWithLang" + } + }, + "role": { + "type": "string" + }, + "templates": { + "$ref": "#/definitions/NodeConfigNodeTemplates" + }, + "uiGroup": { + "type": "string" + } + } + }, + "LookupConfigLookup": { + "type": "object", + "properties": { + "parentPattern": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string" + }, + "forceLooup": { + "type": "boolean" + }, + "autoOpen": { + "type": "boolean" + } + } + }, + "OverlayRibbonElement": { + "type": "object", + "properties": { + "type": { + "type": "string", + "readOnly": true + }, + "after": { + "type": "string" + }, + "before": { + "type": "string" + }, + "id": { + "type": "string" + }, + "label": { + "type": "string" + } + } + }, + "NodeConfigNodeEnumeration": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "name": { + "$ref": "#/definitions/NodeConfigElementWithLang" + } + } + }, + "NodeConfigElementWithLang": { + "type": "object", + "properties": { + "lang": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "NodeConfigNodeTemplates": { + "type": "object", + "properties": { + "template": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeConfigNodeTemplate" + } + } + } + }, + "NodeConfigNodeTemplate": { + "type": "object", + "properties": { + "color": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "SettingsMetadataParameters": { + "type": "object", + "properties": { + "requestedMetadata": { + "$ref": "#/definitions/RequestedMetadata" + } + } + }, + "SettingsMetadata": { + "type": "object", + "properties": { + "metadata": { + "$ref": "#/definitions/ResolvedMetadata" + } + } + }, + "CollectiveSpacesConfig": { + "required": [ + "fileAssociations", + "previewResolution", + "collectiveSpacesConfiguration", + "supportedUiLanguages", + "experienceConfiguration" + ], + "type": "object", + "properties": { + "fileAssociations": { + "type": "array", + "items": { + "$ref": "#/definitions/FileExtensionAssociation" + } + }, + "previewResolution": { + "type": "string" + }, + "collectiveSpacesConfiguration": { + "$ref": "#/definitions/CollectiveSpacesXmlConfiguration" + }, + "supportedUiLanguages": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "experienceConfiguration": { + "$ref": "#/definitions/CollectiveSpacesExperienceConfig" + } + } + }, + "FileExtensionAssociation": { + "required": [ + "fileExtension", + "editorTemplateId" + ], + "type": "object", + "properties": { + "fileExtension": { + "type": "string" + }, + "editorTemplateId": { + "type": "string" + } + } + }, + "CollectiveSpacesXmlConfiguration": { + "required": [ + "draftSpaceSettings" + ], + "type": "object", + "properties": { + "commonSettings": { + "$ref": "#/definitions/CommonCollectiveSpacesSettings" + }, + "draftSpaceSettings": { + "$ref": "#/definitions/DraftSpaceSettings" + }, + "reviewSpaceSettings": { + "$ref": "#/definitions/ReviewSpaceSettings" + } + } + }, + "CollectiveSpacesExperienceConfig": { + "required": [ + "behaviorConfigXml", + "schemaLocationConfigXml" + ], + "type": "object", + "properties": { + "behaviorConfigXml": { + "type": "string" + }, + "schemaLocationConfigXml": { + "type": "string" + } + } + }, + "CommonCollectiveSpacesSettings": { + "type": "object", + "properties": {} + }, + "DraftSpaceSettings": { + "required": [ + "imageUpload" + ], + "type": "object", + "properties": { + "imageUpload": { + "$ref": "#/definitions/ImageUploadSettings" + } + } + }, + "ReviewSpaceSettings": { + "type": "object", + "properties": {} + }, + "ImageUploadSettings": { + "required": [ + "isEnabled", + "preferredResolution" + ], + "type": "object", + "properties": { + "isEnabled": { + "type": "boolean" + }, + "preferredResolution": { + "$ref": "#/definitions/PreferredResolution" + } + } + }, + "PreferredResolution": { + "required": [ + "ishValueType", + "value" + ], + "type": "object", + "properties": { + "ishValueType": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "UserPreferenceSet": { + "required": [ + "name", + "items" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/UserPreferenceItem" + } + } + } + }, + "UserPreferenceItem": { + "required": [ + "name", + "value" + ], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "FormField": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormChild" + }, + { + "type": "object", + "properties": { + "displayType": { + "$ref": "#/definitions/DisplayType" + }, + "allowDuplicates": { + "type": "boolean" + }, + "hidden": { + "type": "boolean" + }, + "mandatory": { + "type": "boolean" + }, + "pattern": { + "$ref": "#/definitions/Pattern" + }, + "readOnly": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "requestedField": { + "$ref": "#/definitions/RequestedField" + }, + "typeName": { + "type": "string", + "readOnly": true + }, + "label": { + "$ref": "#/definitions/TranslatableValue" + }, + "description": { + "$ref": "#/definitions/TranslatableValue" + } + } + } + ], + "properties": {} + }, + "DisplayType": { + "required": [ + "discriminator" + ], + "type": "object", + "properties": { + "typeName": { + "type": "string", + "readOnly": true + }, + "discriminator": { + "type": "string" + } + }, + "discriminator": "discriminator" + }, + "Pattern": { + "type": "object", + "properties": { + "type": { + "enum": [ + "formatString", + "regex" + ], + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "RequestedField": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "level": { + "type": "string" + } + } + }, + "FormGroup": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormChild" + }, + { + "type": "object", + "properties": { + "expandState": { + "enum": [ + "none", + "expanded", + "collapsed" + ], + "type": "string" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/FormChild" + } + }, + "typeName": { + "type": "string", + "readOnly": true + }, + "label": { + "$ref": "#/definitions/TranslatableValue" + }, + "description": { + "$ref": "#/definitions/TranslatableValue" + } + } + } + ], + "properties": {} + }, + "FormLeaf": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormChild" + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "requestedField": { + "$ref": "#/definitions/RequestedField" + }, + "typeName": { + "type": "string", + "readOnly": true + }, + "label": { + "$ref": "#/definitions/TranslatableValue" + }, + "description": { + "$ref": "#/definitions/TranslatableValue" + } + } + } + ], + "properties": {} + }, + "FormTab": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormChild" + }, + { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/FormChild" + } + }, + "typeName": { + "type": "string", + "readOnly": true + }, + "label": { + "$ref": "#/definitions/TranslatableValue" + }, + "description": { + "$ref": "#/definitions/TranslatableValue" + } + } + } + ], + "properties": {} + }, + "FormContainer": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormChild" + }, + { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/FormChild" + } + }, + "typeName": { + "type": "string", + "readOnly": true + }, + "label": { + "$ref": "#/definitions/TranslatableValue" + }, + "description": { + "$ref": "#/definitions/TranslatableValue" + } + } + } + ], + "properties": {} + }, + "BaseList": { + "required": [ + "discriminator" + ], + "type": "object", + "properties": { + "typeName": { + "type": "string", + "readOnly": true + }, + "discriminator": { + "type": "string" + } + }, + "discriminator": "discriminator" + }, + "BaselineList": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BaseList" + }, + { + "type": "object", + "properties": { + "activityFilter": { + "enum": [ + "none", + "active", + "inactive" + ], + "type": "string" + }, + "metadataFilter": { + "$ref": "#/definitions/MetadataFilter" + }, + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "ElectronicDocumentTypeList": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BaseList" + }, + { + "type": "object", + "properties": { + "activityFilter": { + "enum": [ + "none", + "active", + "inactive" + ], + "type": "string" + }, + "metadataFilter": { + "$ref": "#/definitions/MetadataFilter" + }, + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "EnumList": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BaseList" + }, + { + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/ValueListItem" + } + }, + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "LovList": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BaseList" + }, + { + "type": "object", + "properties": { + "activityFilter": { + "enum": [ + "none", + "active", + "inactive" + ], + "type": "string" + }, + "lovReference": { + "type": "string" + }, + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "TagList": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BaseList" + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "level": { + "type": "string" + }, + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "TransitionStateList": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BaseList" + }, + { + "type": "object", + "properties": { + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "TranslationTemplatesList": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BaseList" + }, + { + "type": "object", + "properties": { + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "UserGroupList": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BaseList" + }, + { + "type": "object", + "properties": { + "activityFilter": { + "enum": [ + "none", + "active", + "inactive" + ], + "type": "string" + }, + "metadataFilter": { + "$ref": "#/definitions/MetadataFilter" + }, + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "UserList": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BaseList" + }, + { + "type": "object", + "properties": { + "activityFilter": { + "enum": [ + "none", + "active", + "inactive" + ], + "type": "string" + }, + "metadataFilter": { + "$ref": "#/definitions/MetadataFilter" + }, + "restrictUserGroup": { + "type": "boolean" + }, + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "UserRoleList": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BaseList" + }, + { + "type": "object", + "properties": { + "activityFilter": { + "enum": [ + "none", + "active", + "inactive" + ], + "type": "string" + }, + "metadataFilter": { + "$ref": "#/definitions/MetadataFilter" + }, + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "VersionList": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BaseList" + }, + { + "type": "object", + "properties": { + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "TypeCheckBox": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DisplayType" + }, + { + "type": "object", + "properties": { + "checkedValue": { + "type": "string" + }, + "uncheckedValue": { + "type": "string" + }, + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "TypeCondition": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DisplayType" + }, + { + "type": "object", + "properties": { + "assist": { + "type": "boolean" + }, + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "TypeCustom": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DisplayType" + }, + { + "type": "object", + "properties": { + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "TypeDate": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DisplayType" + }, + { + "type": "object", + "properties": { + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "TypeFile": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DisplayType" + }, + { + "type": "object", + "properties": { + "valueList": { + "$ref": "#/definitions/ValueList" + }, + "assist": { + "type": "boolean" + }, + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "ValueList": { + "type": "object", + "properties": { + "list": { + "$ref": "#/definitions/BaseList" + }, + "isStatic": { + "type": "boolean" + }, + "sortOrder": { + "enum": [ + "none", + "ascending", + "descending" + ], + "type": "string" + } + } + }, + "TypeLabel": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DisplayType" + }, + { + "type": "object", + "properties": { + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "TypeMultilineText": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DisplayType" + }, + { + "type": "object", + "properties": { + "lines": { + "format": "int32", + "type": "integer" + }, + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "TypeNumeric": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DisplayType" + }, + { + "type": "object", + "properties": { + "decimalPlaces": { + "format": "int32", + "type": "integer" + }, + "increment": { + "format": "double", + "type": "number" + }, + "minimum": { + "format": "double", + "type": "number" + }, + "maximum": { + "format": "double", + "type": "number" + }, + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "TypeOptions": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DisplayType" + }, + { + "type": "object", + "properties": { + "valueList": { + "$ref": "#/definitions/ValueList" + }, + "flowDirection": { + "enum": [ + "vertical", + "horizontal" + ], + "type": "string" + }, + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "TypePullDown": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DisplayType" + }, + { + "type": "object", + "properties": { + "valueList": { + "$ref": "#/definitions/ValueList" + }, + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "TypeReference": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DisplayType" + }, + { + "type": "object", + "properties": { + "selectableTypes": { + "type": "array", + "items": { + "type": "string" + } + }, + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "TypeTagList": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DisplayType" + }, + { + "type": "object", + "properties": { + "autosuggest": { + "$ref": "#/definitions/Autosuggest" + }, + "recentCache": { + "type": "boolean" + }, + "structureView": { + "$ref": "#/definitions/StructureView" + }, + "valuePanel": { + "$ref": "#/definitions/ValuePanel" + }, + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + }, + "Autosuggest": { + "type": "object", + "properties": { + "valueList": { + "$ref": "#/definitions/ValueList" + } + } + }, + "StructureView": { + "type": "object", + "properties": { + "valueList": { + "$ref": "#/definitions/ValueList" + } + } + }, + "ValuePanel": { + "type": "object", + "properties": { + "valueList": { + "$ref": "#/definitions/ValueList" + } + } + }, + "TypeText": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DisplayType" + }, + { + "type": "object", + "properties": { + "password": { + "type": "boolean" + }, + "typeName": { + "type": "string", + "readOnly": true + } + } + } + ], + "properties": {} + } + } +} diff --git a/test/mock/v2/test-sites.json b/test/mock/v2/test-sites.json new file mode 100644 index 00000000..4e88e794 --- /dev/null +++ b/test/mock/v2/test-sites.json @@ -0,0 +1,18116 @@ +{ + "swagger": "2.0", + "info": { + "version": "V1.0", + "title": "CMS" + }, + "host": "global.cms.corp:8080", + "basePath": "/OpenApi", + "schemes": [ + "http" + ], + "paths": { + "/api/v{api-version}/cm/applicationids": { + "get": { + "tags": [ + "ApplicationData" + ], + "summary": "Fetches all Application Id's.", + "description": "", + "operationId": "GetApplicationIds", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/appdata/{itemId}": { + "get": { + "tags": [ + "ApplicationData" + ], + "summary": "Fetches an Item's ApplicationData for all Applications.", + "description": "", + "operationId": "GetApplicationData", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/ApplicationData" + }, + "xml": { + "name": "ApplicationData", + "wrapped": true + }, + "type": "array" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + }, + "put": { + "tags": [ + "ApplicationData" + ], + "summary": "Updates an Item's ApplicationData for a specific Application.", + "description": "", + "operationId": "SaveAppData", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "applicationDataDtos", + "in": "body", + "required": true, + "schema": { + "items": { + "$ref": "#/definitions/ApplicationData" + }, + "xml": { + "name": "ApplicationData", + "wrapped": true + }, + "type": "array" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "204": { + "description": "The request was succesful and there is no content in the body of the response." + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/appdata/{itemId}/{applicationId}": { + "post": { + "tags": [ + "ApplicationData" + ], + "summary": "Fetches an Item's ApplicationData for a specific Application.", + "description": "", + "operationId": "GetApplicationDataForApplication", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "applicationId", + "in": "path", + "description": "The id of an Application.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/ApplicationData" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/appdata/multiple": { + "post": { + "tags": [ + "ApplicationData" + ], + "summary": "Fetches ApplicationData for multiple Items and Applications.", + "description": "", + "operationId": "GetApplicationDataForMultipleSubjectsAndAppIds", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestBody", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MultiSubjectMultiAppDataRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "additionalProperties": { + "items": { + "$ref": "#/definitions/ApplicationData" + }, + "xml": { + "name": "ApplicationData", + "wrapped": true + }, + "type": "array" + }, + "type": "object" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/appdata/{itemId}/{applicationId}/delete": { + "post": { + "tags": [ + "ApplicationData" + ], + "summary": "Deletes an Item's ApplicationData for a specific Application.", + "description": "", + "operationId": "DeleteApplicationData", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "applicationId", + "in": "path", + "description": "The id of an Application.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "204": { + "description": "The request was succesful and there is no content in the body of the response." + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/appdata/purge/{applicationId}": { + "post": { + "tags": [ + "ApplicationData" + ], + "summary": "Remove all ApplicationData in the system for a given Application.", + "description": "", + "operationId": "PurgeApplicationData", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationId", + "in": "path", + "description": "The id of an Application.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "204": { + "description": "The request was succesful and there is no content in the body of the response." + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/checkin": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Checks in a batch of items.", + "description": "", + "operationId": "BatchCheckIn", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchCheckinRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/checkout": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Checks out a batch of items.", + "description": "", + "operationId": "BatchCheckIn", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchOperationWithLockingRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/classify": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Classifies a batch of items.", + "description": "", + "operationId": "BatchClassify", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchClassifyOrUnClassifyRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/copy": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Copies a batch of items.", + "description": "", + "operationId": "BatchCopy", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchCopyRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/copytokeyword": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "", + "description": "", + "operationId": "BatchCopyToKeyword", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchCopyOrMoveRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/delete": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Deletes a batch of items.", + "description": "", + "operationId": "BatchDelete", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchOperationRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/deletetaxonomynode": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Deletes a batch of taxonomy nodes.", + "description": "", + "operationId": "BatchDeleteTaxonomyNode", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchDeleteTaxonomyNodeRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/demote": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Demotes a batch of items.", + "description": "", + "operationId": "BatchDemote", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchPromoteDemoteRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/finishactivity": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Finishes a batch of activities.", + "description": "", + "operationId": "BatchFinishActivity", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchFinishActivityRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/forcefinishprocess": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Forces a batch of processes to finish.", + "description": "", + "operationId": "BatchForceFinishProcess", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchForceFinishRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/localize": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Localizes a batch of items.", + "description": "", + "operationId": "BatchLocalize", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchOperationRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/move": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Moves a batch of items.", + "description": "", + "operationId": "BatchMove", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchCopyOrMoveRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/movetokeyword": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "", + "description": "", + "operationId": "BatchMoveToKeyword", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchCopyOrMoveRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/promote": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Promotes a batch of items.", + "description": "", + "operationId": "BatchPromote", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchPromoteDemoteRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/publish": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Publishes a batch of items.", + "description": "", + "operationId": "BatchPublish", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchPublishRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/reassignactivity": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Reassignes a batch of activities.", + "description": "", + "operationId": "BatchReAssignActivity", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchReAssignActivityRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/reclassify": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Reclassifies a batch of items.", + "description": "", + "operationId": "BatchReclassify", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchReClassifyRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/restartactivity": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Restarts a batch of activities.", + "description": "", + "operationId": "RestartActivity", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchOperationRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/resumeactivity": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Resumes a batch of activities.", + "description": "", + "operationId": "BatchResumeActivity", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchOperationRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/startactivity": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Starts a batch of activities.", + "description": "", + "operationId": "BatchStartActivity", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchOperationRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/suspendactivity": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Suspends a batch of activities.", + "description": "", + "operationId": "BatchSuspendActivity", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchSuspendActivityRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/switchuserenabledstate": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Switches the enabled state for a batch of Users.", + "description": "", + "operationId": "BatchSwitchUserEnabledState", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchSwitchUserEnabledStateRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/synchronizewithschemaandupdate": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "", + "description": "", + "operationId": "BatchSynchronizeWithSchemaAndUpdate", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchSynchronizeSchemaRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/unclassify": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Unclassifies a batch of items.", + "description": "", + "operationId": "BatchUnClassify", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchClassifyOrUnClassifyRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/undocheckout": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Undo the checkout of a batch of items.", + "description": "", + "operationId": "BatchUndoCheckOut", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchOperationWithLockingRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/unlocalize": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Unlocalizes a batch of items.", + "description": "", + "operationId": "BatchUnLocalize", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchOperationRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/batch/unpublish": { + "post": { + "tags": [ + "BatchOperations" + ], + "summary": "Unpublishes a batch of items.", + "description": "", + "operationId": "BatchUnPublish", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/BatchUnPublishRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/binary/upload": { + "post": { + "tags": [ + "Binaries" + ], + "summary": "Upload one or more binaries as multipart content.", + "description": "", + "operationId": "Upload", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but the processing has not been completed." + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/binary/uploadbytes/{fileName}": { + "post": { + "tags": [ + "Binaries" + ], + "description": "", + "operationId": "UploadBytes", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "fileName", + "in": "path", + "description": "The name of the file.", + "required": true, + "type": "string" + }, + { + "name": "bytes", + "in": "body", + "required": true, + "schema": { + "type": "string", + "format": "byte" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/binary/uploadbytesasync/{fileName}": { + "post": { + "tags": [ + "Binaries" + ], + "summary": "Upload a binary (asynchronous).", + "description": "", + "operationId": "UploadBytesAsync", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "fileName", + "in": "path", + "description": "The name of the file.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/binary/{itemIdOrTempFileId}": { + "get": { + "tags": [ + "Binaries" + ], + "summary": "Download a binary.", + "description": "", + "operationId": "DownloadBinaryContent", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemIdOrTempFileId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "width", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 0 + }, + { + "name": "height", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 0 + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/binary": { + "get": { + "tags": [ + "Binaries" + ], + "summary": "Download a binary.", + "description": "", + "operationId": "DownloadBinaryContent", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "width", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 0 + }, + { + "name": "height", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 0 + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/blueprintcontext": { + "get": { + "tags": [ + "Blueprinting" + ], + "summary": "Fetch the blueprint context of an Item in the Blueprint hierarchy.", + "description": "", + "operationId": "BlueprintContext", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/BlueprintItemDescriptor" + }, + "type": "object" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/blueprintcontextoverrides": { + "get": { + "tags": [ + "Blueprinting" + ], + "summary": "Gets the blueprint context overrides for a Publication.", + "description": "Blueprint context overrides can be used to save components or pages to different publications (blueprint contexts).", + "operationId": "BlueprintContextOverrides", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/BlueprintContextOverrides" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + }, + "put": { + "tags": [ + "Blueprinting" + ], + "summary": "Updates the blueprint context overrides for a Publication.", + "description": "Blueprint context overrides can be used to save components or pages to different publications (blueprint contexts).", + "operationId": "BlueprintContextOverrides", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "blueprintContextOverrides", + "in": "body", + "description": "Specification of alternate publications where components and pages are stored.", + "required": true, + "schema": { + "$ref": "#/definitions/BlueprintContextOverrides" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/BlueprintContextOverrides" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/blueprinthierarchy": { + "get": { + "tags": [ + "Blueprinting" + ], + "summary": "Gets the blueprint hierarchy.", + "description": "", + "operationId": "BlueprintHierarchy", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/BlueprintNodeDescriptor" + }, + "type": "object" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/demote": { + "post": { + "tags": [ + "Blueprinting" + ], + "summary": "Demotes an Item in the Blueprint.", + "description": "", + "operationId": "DemoteRepositoryLocalObject", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PromoteDemoteRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/OperationResult" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/promote": { + "post": { + "tags": [ + "Blueprinting" + ], + "summary": "Promotes an Item in the Blueprint.", + "description": "", + "operationId": "PromoteRepositoryLocalObject", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PromoteDemoteRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/OperationResult" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/localize": { + "post": { + "tags": [ + "Blueprinting" + ], + "summary": "Localizes an Item in the Blueprint.", + "description": "This operation returns an implementation of the abstract type 'RepositoryLocalObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Keyword
  • Page
  • PageTemplate
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TemplateBuildingBlock
  • CmsProcessDefinition
  • VirtualFolder
", + "operationId": "LocalizeRepositoryLocalObject", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/RepositoryLocalObject" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/unlocalize": { + "post": { + "tags": [ + "Blueprinting" + ], + "summary": "UnLocalizes an Item in the Blueprint.", + "description": "This operation returns an implementation of the abstract type 'RepositoryLocalObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Keyword
  • Page
  • PageTemplate
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TemplateBuildingBlock
  • CmsProcessDefinition
  • VirtualFolder
", + "operationId": "UnLocalizeRepositoryLocalObject", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/RepositoryLocalObject" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/fasttrackpublishing/preview/{targetTypeOrPublicationTargetId}": { + "post": { + "tags": [ + "FastTrackPublishing" + ], + "summary": "Triggers Fast Track Publishing preview.", + "description": "Fast Track Publishing can only be triggered for target types or publication targets.", + "operationId": "FastTrackPublish", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "targetTypeOrPublicationTargetId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "publishedItemInfos", + "in": "body", + "required": true, + "schema": { + "items": { + "$ref": "#/definitions/PublishedItemInfo" + }, + "xml": { + "name": "PublishedItemInfo", + "wrapped": true + }, + "type": "array" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but the processing has not been completed.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/fasttrackpublishing/resolvepublishingtarget": { + "post": { + "tags": [ + "FastTrackPublishing" + ], + "summary": "Resolves a URL to a publishing target.", + "description": "", + "operationId": "ResolvePublishingTarget", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "siteUrl", + "in": "body", + "description": "The URL of a website.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/healthcheck": { + "get": { + "tags": [ + "HealthCheck" + ], + "summary": "View the health status of the API.", + "description": "", + "operationId": "HealthCheck", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/ApiStatus" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}": { + "get": { + "tags": [ + "Item" + ], + "summary": "Fetches an item.", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "operationId": "FetchIdentifableObject", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "useDynamicVersion", + "in": "query", + "description": "Loads a dynamic version (if available for your user).", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "useBlueprintContextOverridesIfAvailable", + "in": "query", + "description": "Loads the item using blueprint content override settings (if applicable).", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/IdentifiableObject" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + }, + "put": { + "tags": [ + "Item" + ], + "summary": "Updates an existing item.", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "operationId": "UpdateIdentifableObject", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/IdentifiableObject" + } + }, + { + "name": "useBlueprintContextOverridesIfAvailable", + "in": "query", + "description": "Loads the item using blueprint content override settings (if applicable).", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/IdentifiableObject" + } + }, + "204": { + "description": "The request was succesful and there is no content in the body of the response." + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + }, + "delete": { + "tags": [ + "Item" + ], + "summary": "Deletes an item.", + "description": "", + "operationId": "DeleteIdentifableObject", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "204": { + "description": "The request was succesful and there is no content in the body of the response." + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/items": { + "get": { + "tags": [ + "Item" + ], + "summary": "Fetches one or more items based on the Id's provided in the querystring.", + "description": "", + "operationId": "FetchIdentifableObjects", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemIds", + "in": "query", + "description": "A list of (escaped) TCM item id's.", + "required": true, + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "type": "array" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/IdentifiableObject" + }, + "type": "object" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/validate": { + "post": { + "tags": [ + "Item" + ], + "summary": "Validates the state of an IdentifiableObjectData delta object.", + "description": "", + "operationId": "ValidateIdentifableObject", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/IdentifiableObject" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/ValidationError" + }, + "xml": { + "name": "ValidationError", + "wrapped": true + }, + "type": "array" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item": { + "post": { + "tags": [ + "Item" + ], + "summary": "Creates an item.", + "description": "", + "operationId": "CreateIdentifableObject", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/IdentifiableObject" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "201": { + "description": "The request has completed and has resulted in one or more new resources being created.", + "schema": { + "$ref": "#/definitions/IdentifiableObject" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/exists": { + "get": { + "tags": [ + "Item" + ], + "summary": "Checks if an item exists.", + "description": "", + "operationId": "ItemExists", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "boolean" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/defaultdata/{itemType}/{containerUri}": { + "get": { + "tags": [ + "Item" + ], + "summary": "Returns a default data type for the given Item Type and Container Id.", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "operationId": "GetDefaultData", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemType", + "in": "path", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "containerUri", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/IdentifiableObject" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/copy/{destinationUri}": { + "put": { + "tags": [ + "Item" + ], + "summary": "Copies a RepositoryLocalObject.", + "description": "This operation returns an implementation of the abstract type 'RepositoryLocalObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Keyword
  • Page
  • PageTemplate
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TemplateBuildingBlock
  • CmsProcessDefinition
  • VirtualFolder
", + "operationId": "CopyRepositoryLocalObject", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "destinationId", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "makeUnique", + "in": "query", + "required": false, + "type": "boolean", + "default": true + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "destinationUri", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/RepositoryLocalObject" + } + }, + "204": { + "description": "The request was succesful and there is no content in the body of the response." + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/move/{destinationUri}": { + "put": { + "tags": [ + "Item" + ], + "summary": "Moves a RepositoryLocalObject.", + "description": "This operation returns an implementation of the abstract type 'RepositoryLocalObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Keyword
  • Page
  • PageTemplate
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TemplateBuildingBlock
  • CmsProcessDefinition
  • VirtualFolder
", + "operationId": "MoveRepositoryLocalObject", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "destinationUri", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/RepositoryLocalObject" + } + }, + "204": { + "description": "The request was succesful and there is no content in the body of the response." + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/templatetypes/{itemType}": { + "get": { + "tags": [ + "Lists" + ], + "summary": "List all Template Types.", + "description": "", + "operationId": "GetTemplateTypes", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemType", + "in": "path", + "required": true, + "type": "integer", + "format": "int32", + "default": -1 + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/TemplateType" + }, + "xml": { + "name": "TemplateType", + "wrapped": true + }, + "type": "array" + } + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/publicationtypes": { + "get": { + "tags": [ + "Lists" + ], + "summary": "Gets a list of Publication Types.", + "description": "", + "operationId": "GetPublicationTypes", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/PublicationType" + }, + "xml": { + "name": "PublicationType", + "wrapped": true + }, + "type": "array" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/systemprivileges": { + "get": { + "tags": [ + "Lists" + ], + "summary": "Gets a list of System Priviliges.", + "description": "", + "operationId": "GetSystemPrivileges", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/SystemPrivilege" + }, + "xml": { + "name": "SystemPrivilege", + "wrapped": true + }, + "type": "array" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/systemwidelist": { + "post": { + "tags": [ + "Lists" + ], + "summary": "Gets a system wide list.", + "description": "Use an implementation of the abstract SystemWideListFilter (for example a 'MultimediaTypesFilter' to get specific item types.", + "operationId": "GetSystemWideListData", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "filter", + "in": "body", + "description": "The filter to apply to the output.", + "required": true, + "schema": { + "$ref": "#/definitions/SystemWideListFilter" + } + }, + { + "name": "listItemProperties", + "in": "query", + "description": "The properties to load for items in a list.", + "required": false, + "type": "string", + "default": 0, + "enum": [ + "All", + "Id", + "IdAndTitle" + ] + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/IdentifiableObject" + }, + "xml": { + "name": "IdentifiableObject", + "wrapped": true + }, + "type": "array" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/listdata/{itemId}": { + "post": { + "tags": [ + "Lists" + ], + "summary": "Gets a list of related items.", + "description": "", + "operationId": "GetListData", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "filter", + "in": "body", + "description": "The filter to apply to the output.", + "required": true, + "schema": { + "$ref": "#/definitions/SubjectRelatedListFilter" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/list/{itemId}": { + "post": { + "tags": [ + "Lists" + ], + "summary": "Gets a list of related items.", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "operationId": "GetList", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "filter", + "in": "body", + "description": "The filter to apply to the output.", + "required": true, + "schema": { + "$ref": "#/definitions/SubjectRelatedListFilter" + } + }, + { + "name": "listItemProperties", + "in": "query", + "description": "The properties to load for items in a list.", + "required": false, + "type": "string", + "default": 0, + "enum": [ + "All", + "Id", + "IdAndTitle" + ] + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/IdentifiableObject" + }, + "xml": { + "name": "IdentifiableObject", + "wrapped": true + }, + "type": "array" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/classifieditems": { + "get": { + "tags": [ + "OrganizationalItems" + ], + "summary": "Gets a list of classified items.", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "operationId": "ClassifiedItems", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "listItemProperties", + "in": "query", + "description": "The properties to load for items in a list.", + "required": false, + "type": "string", + "default": 0, + "enum": [ + "All", + "Id", + "IdAndTitle" + ] + }, + { + "name": "useDynamicVersion", + "in": "query", + "description": "Loads a dynamic version (if available for your user).", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "itemType", + "in": "query", + "required": false, + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Publication", + "Folder", + "StructureGroup", + "Schema", + "Component", + "ComponentTemplate", + "Page", + "PageTemplate", + "TargetGroup", + "Category", + "Keyword", + "TemplateBuildingBlock", + "BusinessProcessType", + "VirtualFolder", + "PublicationTarget", + "TargetType", + "TargetDestination", + "MultimediaType", + "User", + "Group", + "DirectoryService", + "DirectoryGroupMapping", + "Batch", + "MultipleOperations", + "PublishTransaction", + "WorkflowType", + "ApprovalStatus", + "ProcessDefinition", + "ProcessInstance", + "ProcessHistory", + "ActivityDefinition", + "ActivityInstance", + "ActivityHistory", + "WorkItem" + ] + }, + "collectionFormat": "multi", + "type": "array" + }, + { + "name": "resolveDescendantKeywords", + "in": "query", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/IdentifiableObject" + }, + "xml": { + "name": "IdentifiableObject", + "wrapped": true + }, + "type": "array" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/items": { + "get": { + "tags": [ + "OrganizationalItems" + ], + "summary": "Gets a list of child items.", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "operationId": "Items", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "listItemProperties", + "in": "query", + "description": "The properties to load for items in a list.", + "required": false, + "type": "string", + "default": 0, + "enum": [ + "All", + "Id", + "IdAndTitle" + ] + }, + { + "name": "useDynamicVersion", + "in": "query", + "description": "Loads a dynamic version (if available for your user).", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "itemType", + "in": "query", + "required": false, + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Publication", + "Folder", + "StructureGroup", + "Schema", + "Component", + "ComponentTemplate", + "Page", + "PageTemplate", + "TargetGroup", + "Category", + "Keyword", + "TemplateBuildingBlock", + "BusinessProcessType", + "VirtualFolder", + "PublicationTarget", + "TargetType", + "TargetDestination", + "MultimediaType", + "User", + "Group", + "DirectoryService", + "DirectoryGroupMapping", + "Batch", + "MultipleOperations", + "PublishTransaction", + "WorkflowType", + "ApprovalStatus", + "ProcessDefinition", + "ProcessInstance", + "ProcessHistory", + "ActivityDefinition", + "ActivityInstance", + "ActivityHistory", + "WorkItem" + ] + }, + "collectionFormat": "multi", + "type": "array" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/IdentifiableObject" + }, + "xml": { + "name": "IdentifiableObject", + "wrapped": true + }, + "type": "array" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/uses": { + "get": { + "tags": [ + "Blueprinting" + ], + "summary": "Gets a list of items that are used by a specific item.", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "operationId": "Uses", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "listItemProperties", + "in": "query", + "description": "The properties to load for items in a list.", + "required": false, + "type": "string", + "default": 0, + "enum": [ + "All", + "Id", + "IdAndTitle" + ] + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "filter.$type", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.baseColumns", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + { + "name": "filter.extensionProperties", + "in": "query", + "required": false, + "type": "object" + }, + { + "name": "filter.includeAllowedActionsColumns", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "filter.includeBlueprintParentItem", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "filter.includeExternalLinks", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "filter.inRepository.idRef", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.inRepository.title", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.inRepository.$type", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.inRepository.description", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.inRepository.webDavUrl", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.itemTypes", + "in": "query", + "required": false, + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Publication", + "Folder", + "StructureGroup", + "Schema", + "Component", + "ComponentTemplate", + "Page", + "PageTemplate", + "TargetGroup", + "Category", + "Keyword", + "TemplateBuildingBlock", + "BusinessProcessType", + "VirtualFolder", + "PublicationTarget", + "TargetType", + "TargetDestination", + "MultimediaType", + "User", + "Group", + "DirectoryService", + "DirectoryGroupMapping", + "Batch", + "MultipleOperations", + "PublishTransaction", + "WorkflowType", + "ApprovalStatus", + "ProcessDefinition", + "ProcessInstance", + "ProcessHistory", + "ActivityDefinition", + "ActivityInstance", + "ActivityHistory", + "WorkItem" + ] + }, + "collectionFormat": "multi", + "type": "array" + }, + { + "name": "filter.sortExpression", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/IdentifiableObject" + }, + "xml": { + "name": "IdentifiableObject", + "wrapped": true + }, + "type": "array" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/usedby": { + "get": { + "tags": [ + "Blueprinting" + ], + "summary": "Gets a list of items that use a specific item.", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "operationId": "UsedBy", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "listItemProperties", + "in": "query", + "description": "The properties to load for items in a list.", + "required": false, + "type": "string", + "default": 0, + "enum": [ + "All", + "Id", + "IdAndTitle" + ] + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "filter.$type", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.baseColumns", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + { + "name": "filter.excludeTaxonomyRelations", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "filter.extensionProperties", + "in": "query", + "required": false, + "type": "object" + }, + { + "name": "filter.includeAllowedActionsColumns", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "filter.includedVersions", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "AllVersions", + "OnlyLatestVersions", + "OnlyLatestAndCheckedOutVersions" + ] + }, + { + "name": "filter.includeLocalCopies", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "filter.includeVersionsColumn", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "filter.inRepository.idRef", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.inRepository.title", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.inRepository.$type", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.inRepository.description", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.inRepository.webDavUrl", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "filter.itemTypes", + "in": "query", + "required": false, + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Publication", + "Folder", + "StructureGroup", + "Schema", + "Component", + "ComponentTemplate", + "Page", + "PageTemplate", + "TargetGroup", + "Category", + "Keyword", + "TemplateBuildingBlock", + "BusinessProcessType", + "VirtualFolder", + "PublicationTarget", + "TargetType", + "TargetDestination", + "MultimediaType", + "User", + "Group", + "DirectoryService", + "DirectoryGroupMapping", + "Batch", + "MultipleOperations", + "PublishTransaction", + "WorkflowType", + "ApprovalStatus", + "ProcessDefinition", + "ProcessInstance", + "ProcessHistory", + "ActivityDefinition", + "ActivityInstance", + "ActivityHistory", + "WorkItem" + ] + }, + "collectionFormat": "multi", + "type": "array" + }, + { + "name": "filter.sortExpression", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/IdentifiableObject" + }, + "xml": { + "name": "IdentifiableObject", + "wrapped": true + }, + "type": "array" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/inbundles": { + "get": { + "tags": [ + "OrganizationalItems" + ], + "summary": "Gets a list of bundles a specific item is in.", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "operationId": "InBundles", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "listItemProperties", + "in": "query", + "description": "The properties to load for items in a list.", + "required": false, + "type": "string", + "default": 0, + "enum": [ + "All", + "Id", + "IdAndTitle" + ] + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "containingBundlesFilterDto.$type", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "containingBundlesFilterDto.baseColumns", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + { + "name": "containingBundlesFilterDto.extensionProperties", + "in": "query", + "required": false, + "type": "object" + }, + { + "name": "containingBundlesFilterDto.includeAllowedActionsColumns", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "containingBundlesFilterDto.includeBundleTypeColumns", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "containingBundlesFilterDto.includeDescriptionColumn", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "containingBundlesFilterDto.onlySpecifiedBluePrintVariant", + "in": "query", + "required": false, + "type": "boolean" + }, + { + "name": "containingBundlesFilterDto.sortExpression", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "containingBundlesFilterDto.suppressLocalCopies", + "in": "query", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/IdentifiableObject" + }, + "xml": { + "name": "IdentifiableObject", + "wrapped": true + }, + "type": "array" + } + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/processdefinitions": { + "get": { + "tags": [ + "Workflow" + ], + "summary": "Gets a list of Process Definitions for a specific item.", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "operationId": "ProcessDefinitions", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "listItemProperties", + "in": "query", + "description": "The properties to load for items in a list.", + "required": false, + "type": "string", + "default": 0, + "enum": [ + "All", + "Id", + "IdAndTitle" + ] + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/IdentifiableObject" + }, + "xml": { + "name": "IdentifiableObject", + "wrapped": true + }, + "type": "array" + } + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/publications": { + "get": { + "tags": [ + "Lists" + ], + "summary": "Gets a list of Publications.", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "operationId": "Publications", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "listItemProperties", + "in": "query", + "description": "The properties to load for items in a list.", + "required": false, + "type": "string", + "default": 0, + "enum": [ + "All", + "Id", + "IdAndTitle" + ] + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/IdentifiableObject" + }, + "xml": { + "name": "IdentifiableObject", + "wrapped": true + }, + "type": "array" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/checkedoutitems": { + "get": { + "tags": [ + "Lists" + ], + "summary": "Gets all items that are checked out.", + "description": "This operation is for Administrators. Normally users are only able to retrieve items that are checked out by themselves.", + "operationId": "GetCheckedOutItems", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "listItemProperties", + "in": "query", + "description": "The properties to load for items in a list.", + "required": false, + "type": "string", + "default": 0, + "enum": [ + "All", + "Id", + "IdAndTitle" + ] + }, + { + "name": "useDynamicVersion", + "in": "query", + "description": "Loads a dynamic version (if available for your user).", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/IdentifiableObject" + }, + "xml": { + "name": "IdentifiableObject", + "wrapped": true + }, + "type": "array" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/checkedoutitems/{userId}": { + "get": { + "tags": [ + "Lists" + ], + "summary": "Gets the items that are checked out by a given user.", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "operationId": "GetCheckedOutItemsForUser", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "userId", + "in": "path", + "description": "The (escaped) TCM id of a User.", + "required": true, + "type": "string" + }, + { + "name": "listItemProperties", + "in": "query", + "description": "The properties to load for items in a list.", + "required": false, + "type": "string", + "default": 0, + "enum": [ + "All", + "Id", + "IdAndTitle" + ] + }, + { + "name": "useDynamicVersion", + "in": "query", + "description": "Loads a dynamic version (if available for your user).", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/IdentifiableObject" + }, + "xml": { + "name": "IdentifiableObject", + "wrapped": true + }, + "type": "array" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/organizationalstructuretree/{itemId}": { + "get": { + "tags": [ + "Lists" + ], + "summary": "Gets an (expanded) tree representation of all the items in the path of a RepositoryLocalObject.", + "description": "", + "operationId": "GetOrganizationalStructureTree", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "includeAllPublications", + "in": "query", + "description": "Include all publications (and not just the context publication).", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "includeChildrenOnEveryLevel", + "in": "query", + "description": "Include children of all items in the path.", + "required": false, + "type": "boolean", + "default": true + }, + { + "name": "groupCategoriesAndKeywords", + "in": "query", + "description": "Group categories and keywords in a single treenode.", + "required": false, + "type": "boolean", + "default": true + }, + { + "name": "groupBusinessProcessTypes", + "in": "query", + "description": "Group all business process types in a single treenode.", + "required": false, + "type": "boolean", + "default": true + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/TreeNode" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/orgitem/{organizationalItemId}/lock": { + "get": { + "tags": [ + "OrganizationalItems" + ], + "summary": "Locks an organizational item.", + "description": "This operation returns an implementation of the abstract type 'OrganizationalItem'. Depending on the requested item, one of the following instances may be returned:\n\n
  • BusinessProcessType
  • Category
  • Folder
  • ResolvedBundle
  • StructureGroup
  • VirtualFolder
", + "operationId": "LockOrganizationalItem", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "organizationalItemId", + "in": "path", + "description": "The (escaped) TCM id of an OrganizationalItem.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/OrganizationalItem" + } + }, + "204": { + "description": "The request was succesful and there is no content in the body of the response." + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/orgitem/{organizationalItemId}/unlock": { + "get": { + "tags": [ + "OrganizationalItems" + ], + "summary": "Unlocks an organizational item.", + "description": "This operation returns an implementation of the abstract type 'OrganizationalItem'. Depending on the requested item, one of the following instances may be returned:\n\n
  • BusinessProcessType
  • Category
  • Folder
  • ResolvedBundle
  • StructureGroup
  • VirtualFolder
", + "operationId": "UnLockOrganizationalItem", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "organizationalItemId", + "in": "path", + "description": "The (escaped) TCM id of an OrganizationalItem.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/OrganizationalItem" + } + }, + "204": { + "description": "The request was succesful and there is no content in the body of the response." + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/publish/{targetIdOrPurpose}": { + "post": { + "tags": [ + "Publishing" + ], + "summary": "Publish items.", + "description": "", + "operationId": "PublishItem", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "targetIdOrPurpose", + "in": "path", + "description": "The id of a publishing target.", + "required": true, + "type": "string" + }, + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PublishInstruction" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but the processing has not been completed.", + "schema": { + "items": { + "$ref": "#/definitions/PublishTransaction" + }, + "xml": { + "name": "PublishTransaction", + "wrapped": true + }, + "type": "array" + } + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/publishing/publish": { + "post": { + "tags": [ + "Publishing" + ], + "summary": "Publish items.", + "description": "", + "operationId": "Publish", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PublishRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but the processing has not been completed.", + "schema": { + "items": { + "$ref": "#/definitions/PublishTransaction" + }, + "xml": { + "name": "PublishTransaction", + "wrapped": true + }, + "type": "array" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/unpublish/{targetIdOrPurpose}": { + "post": { + "tags": [ + "Publishing" + ], + "summary": "Unpublish items.", + "description": "", + "operationId": "UnPublishItem", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "targetIdOrPurpose", + "in": "path", + "description": "The id of a publishing target.", + "required": true, + "type": "string" + }, + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/UnPublishInstruction" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but the processing has not been completed.", + "schema": { + "items": { + "$ref": "#/definitions/PublishTransaction" + }, + "xml": { + "name": "PublishTransaction", + "wrapped": true + }, + "type": "array" + } + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/publishing/unpublish": { + "post": { + "tags": [ + "Publishing" + ], + "summary": "Unpublish items.", + "description": "", + "operationId": "UnPublish", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/UnPublishRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but the processing has not been completed.", + "schema": { + "items": { + "$ref": "#/definitions/PublishTransaction" + }, + "xml": { + "name": "PublishTransaction", + "wrapped": true + }, + "type": "array" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/publishedto": { + "get": { + "tags": [ + "Publishing" + ], + "summary": "Gets a list of publish information for each target the item was published to.", + "description": "", + "operationId": "PublishedTo", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/PublishInfo" + }, + "xml": { + "name": "PublishInfo", + "wrapped": true + }, + "type": "array" + } + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/publishing/ispublished": { + "post": { + "tags": [ + "Publishing" + ], + "summary": "Checks if an item is published.", + "description": "", + "operationId": "IsPublished", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/IsPublishedRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "Successfully published", + "schema": { + "type": "boolean" + } + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/publishing/transactions": { + "post": { + "tags": [ + "Publishing" + ], + "summary": "Gets PublishTransactions.", + "description": "", + "operationId": "GetPublishTransactionData", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "publishTransactionsFilter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PublishTransactionsFilter" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/PublishTransaction" + }, + "xml": { + "name": "PublishTransaction", + "wrapped": true + }, + "type": "array" + } + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/publishing/decommission/{publicationTargetId}": { + "delete": { + "tags": [ + "Publishing" + ], + "summary": "Decommissions a publication target.", + "description": "", + "operationId": "Decommission", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "publicationTargetId", + "in": "path", + "description": "The (escaped) TCM id of a PublicationTarget.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "204": { + "description": "The request was succesful and there is no content in the body of the response." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/publishing/removepublishstates": { + "delete": { + "tags": [ + "Publishing" + ], + "summary": "Removes publish states.", + "description": "", + "operationId": "RemovePublishStates", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/RemovePublishStateRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "204": { + "description": "The request was succesful and there is no content in the body of the response." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/publishing/publishurl": { + "post": { + "tags": [ + "Publishing" + ], + "summary": "Gets the url where an item is published.", + "description": "", + "operationId": "GetPublishUrl", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PublishedUrlRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/publishing/businessprocesstypes/{topologyTypeId}": { + "get": { + "tags": [ + "Publishing" + ], + "summary": "Gets BusinessProcessTypes.", + "description": "", + "operationId": "GetBusinessProcessTypes", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "topologyTypeId", + "in": "path", + "description": "The id of a Topology type.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + } + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/publishing/publishsourcebyurl": { + "post": { + "tags": [ + "Publishing" + ], + "summary": "Resolves a publish source.", + "description": "", + "operationId": "GetPublishSourceByUrl", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "url", + "in": "body", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/PublishSource" + } + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/queues/messages/{messageQueueId}": { + "get": { + "tags": [ + "Queues" + ], + "summary": "Get a list of QueueMessages.", + "description": "", + "operationId": "GetListQueueMessages", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "messageQueueId", + "in": "path", + "description": "The id of a message queue.", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/QueueMessage" + }, + "xml": { + "name": "QueueMessage", + "wrapped": true + }, + "type": "array" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/queues/queuename/{messageQueueId}": { + "get": { + "tags": [ + "Queues" + ], + "summary": "Get the name of a predefined queue.", + "description": "", + "operationId": "GetPredefinedQueueName", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "messageQueueId", + "in": "path", + "description": "The id of a message queue.", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string", + "enum": [ + "UnknownByClient", + "PublishQueue", + "DeployQueue", + "SearchQueue", + "WorkflowAgentQueue", + "BatchQueue" + ] + } + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/queues/list": { + "get": { + "tags": [ + "Queues" + ], + "summary": "Gets a list of queues.", + "description": "", + "operationId": "GetListQueues", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/Queue" + }, + "xml": { + "name": "Queue", + "wrapped": true + }, + "type": "array" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/queues/purge/{messageQueueId}": { + "post": { + "tags": [ + "Queues" + ], + "summary": "Purges a queue.", + "description": "", + "operationId": "PurgeQueue", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "messageQueueId", + "in": "path", + "description": "The id of a message queue.", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "204": { + "description": "The request was succesful and there is no content in the body of the response." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/render": { + "post": { + "tags": [ + "Rendering" + ], + "summary": "Renders an item.", + "description": "", + "operationId": "RenderItem", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/RenderRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/RenderedItem" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/preview": { + "post": { + "tags": [ + "Rendering" + ], + "summary": "Renders a preview of an item.", + "description": "", + "operationId": "PreviewItem", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PreviewRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/RenderedItem" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/workitemsnapshot/{workItemId}": { + "get": { + "tags": [ + "Rendering" + ], + "summary": "Gets a work item snapshot for the given workitem Id.", + "description": "", + "operationId": "GetWorkItemSnapshot", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "workItemId", + "in": "path", + "description": "The (escaped) TCM id of a work item.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/RenderedItem" + } + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{schemaId}/instancedata/{containerItemId}": { + "get": { + "tags": [ + "Schemas" + ], + "summary": "Gets the instance data of a Schema with default field values.", + "description": "", + "operationId": "GetSchemaInstanceData", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "schemaId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "containerItemId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/SchemaInstance" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/schemas/bynamespace/{repositoryId}/{xmlNamespaceUri}/{rootElementName}": { + "get": { + "tags": [ + "Schemas" + ], + "summary": "Gets a list of schema's by namespace Uri.", + "description": "", + "operationId": "GetSchemasByNamespaceUri", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "repositoryId", + "in": "path", + "description": "The (escaped) TCM id of a Repository.", + "required": true, + "type": "string" + }, + { + "name": "xmlNamespaceUri", + "in": "path", + "description": "The uri of a XML namespace", + "required": true, + "type": "string" + }, + { + "name": "rootElementName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/schemas/virtualfoldertype/{xmlNamespaceUri}": { + "get": { + "tags": [ + "Schemas" + ], + "summary": "Gets the type schema of a Virtual Folder for the specified namespace Uri.", + "description": "", + "operationId": "GetVirtualFolderTypeSchema", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "xmlNamespaceUri", + "in": "path", + "description": "The uri of a XML namespace", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/Schema" + } + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/synchronizewithschemaandupdate": { + "put": { + "tags": [ + "Schemas" + ], + "summary": "Synchronizes content and/or metadata of an item with current schema.", + "description": "Using this operation will also persist the changes made through synchronization.", + "operationId": "SynchronizeWithSchemaAndUpdate", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "synchronizeflags", + "in": "query", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/SynchronizationResult" + } + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{itemId}/synchronizewithschema": { + "post": { + "tags": [ + "Schemas" + ], + "summary": "Synchronizes content and/or metadata of an item with current schema.", + "description": "Using this operation will not persist the changes made through synchronization.", + "operationId": "SynchronizeWithSchema", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemId", + "in": "path", + "description": "The (escaped) TCM id of an Item. Can be a Component, Folder, Schema or any other kind of object that is identifiable with a TcmUri.", + "required": true, + "type": "string" + }, + { + "name": "identifiableObject", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IdentifiableObject" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "synchronizeflags", + "in": "query", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/SynchronizationResult" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/search": { + "get": { + "tags": [ + "Search" + ], + "summary": "", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "operationId": "BasicFullTextSearch", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "searchQuery", + "in": "query", + "description": "Text to search on.", + "required": false, + "type": "string" + }, + { + "name": "startRow", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": -1 + }, + { + "name": "max", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": -1 + }, + { + "name": "maxSearchResults", + "in": "query", + "description": "The maximum numer of search results.", + "required": false, + "type": "integer", + "format": "int32", + "default": -1 + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/IdentifiableObject" + }, + "xml": { + "name": "IdentifiableObject", + "wrapped": true + }, + "type": "array" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + }, + "post": { + "tags": [ + "Search" + ], + "summary": "Full search.", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "operationId": "Search", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/SearchQuery" + } + }, + { + "name": "start", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": -1 + }, + { + "name": "max", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": -1 + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/IdentifiableObject" + }, + "xml": { + "name": "IdentifiableObject", + "wrapped": true + }, + "type": "array" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/search/reindex/{repositoryId}": { + "post": { + "tags": [ + "Search" + ], + "summary": "Reindexes a Cms repository.", + "description": "When no repositoryId is provided, all repositories will be reindexed.", + "operationId": "Reindex", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "repositoryId", + "in": "path", + "description": "The (escaped) TCM id of a Repository.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but the processing has not been completed." + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/system/itemidsforappdata/{applicationId}": { + "get": { + "tags": [ + "System" + ], + "summary": "Gets a list of itemIds which have application data of the specified applicationId.", + "description": "", + "operationId": "GetItemIdsWithApplicationData", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "applicationId", + "in": "path", + "description": "The id of an Application.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/system/systemwidelist": { + "post": { + "tags": [ + "System" + ], + "summary": "Gets a system wide list.", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "operationId": "GetSystemWideList", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "filter", + "in": "body", + "description": "The filter to apply to the output.", + "required": true, + "schema": { + "$ref": "#/definitions/SystemWideListFilter" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/IdentifiableObject" + }, + "xml": { + "name": "IdentifiableObject", + "wrapped": true + }, + "type": "array" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/system/systemxsd/{fileName}": { + "get": { + "tags": [ + "System" + ], + "summary": "Gets a system xsd.", + "description": "", + "operationId": "GetSystemXsd", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "fileName", + "in": "path", + "description": "The name of the file.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string" + } + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/system/purgeoldversions": { + "post": { + "tags": [ + "System" + ], + "summary": "Purges old versions of items.", + "description": "", + "operationId": "PurgeOldVersions", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/PurgeOldVersionsInstruction" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "integer", + "format": "int32" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/system/Cmslanguages": { + "get": { + "tags": [ + "System" + ], + "summary": "Gets available languages.", + "description": "", + "operationId": "GetCmsLanguages", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/CmsLanguageInfo" + }, + "xml": { + "name": "CmsLanguageInfo", + "wrapped": true + }, + "type": "array" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/system/directoryserviceusers/{directoryServiceName}": { + "get": { + "tags": [ + "System" + ], + "summary": "Gets a list of DirectoryServiceUsers.", + "description": "", + "operationId": "GetListDirectoryServiceUsers", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "directoryServicesName", + "in": "query", + "description": "The name of a Directory service.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "directoryServiceName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/DirectoryServiceUser" + }, + "xml": { + "name": "DirectoryServiceUser", + "wrapped": true + }, + "type": "array" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + }, + "post": { + "tags": [ + "System" + ], + "summary": "Gets a filtered list of DirectoryServiceUsers.", + "description": "", + "operationId": "GetListDirectoryServiceUsersWithFilter", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "directoryServicesName", + "in": "query", + "description": "The name of a Directory service.", + "required": true, + "type": "string" + }, + { + "name": "filter", + "in": "body", + "description": "The filter to apply to the output.", + "required": true, + "schema": { + "$ref": "#/definitions/CmsDirectoryUsersFilter" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "directoryServiceName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/DirectoryServiceUser" + }, + "xml": { + "name": "DirectoryServiceUser", + "wrapped": true + }, + "type": "array" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/system/notify": { + "post": { + "tags": [ + "Notifications" + ], + "summary": "Sends a notification.", + "description": "", + "operationId": "SendNotification", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/NotificationMessage" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "204": { + "description": "The request was succesful and there is no content in the body of the response." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/system/availablecultures": { + "get": { + "tags": [ + "System" + ], + "summary": "Retrieves a list of available cultures.", + "description": "", + "operationId": "GetAvailableCultures", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "includeIncompleteCultures", + "in": "query", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/CultureInfo" + }, + "xml": { + "name": "CultureInfo", + "wrapped": true + }, + "type": "array" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/userprofile/{userId}": { + "get": { + "tags": [ + "UserProfile" + ], + "summary": "Get the UserProfile of a user.", + "description": "", + "operationId": "GetUserProfile", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "userId", + "in": "path", + "description": "The (escaped) TCM id of a User.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/UserProfile" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + }, + "put": { + "tags": [ + "UserProfile" + ], + "summary": "Updates the UserProfile of a user.", + "description": "The 'User' and 'Runtime' properties in the UserProfile cannot be updated through this operation.", + "operationId": "UpdateUserProfile", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "userId", + "in": "path", + "description": "The (escaped) TCM id of a User.", + "required": true, + "type": "string" + }, + { + "name": "userProfileDto", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UserProfile" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/UserProfile" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/userprofile/{userId}/avatar": { + "get": { + "tags": [ + "UserProfile" + ], + "summary": "Gets the avatar of a user.", + "description": "", + "operationId": "GetUserAvatar", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "userId", + "in": "path", + "description": "The (escaped) TCM id of a User.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "If-None-Match", + "in": "header", + "description": "HTTP Request Header", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string", + "format": "byte" + }, + "headers": { + "ETag": { + "description": "HTTP Response Header", + "type": "string" + } + } + }, + "304": { + "description": "The requested content was not modified." + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + }, + "put": { + "tags": [ + "UserProfile" + ], + "summary": "Updates the avatar of a user.", + "description": "The uploaded image will be resized to 256x256 px.", + "operationId": "UpdateUserAvatar", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "userId", + "in": "path", + "description": "The (escaped) TCM id of a User.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "type": "string", + "format": "byte" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + }, + "delete": { + "tags": [ + "UserProfile" + ], + "summary": "Deletes the custom avatar of a user.", + "description": "Deleting the custom avatar of a user will revert it to a default avatar.", + "operationId": "DeleteUserAvatar", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "userId", + "in": "path", + "description": "The (escaped) TCM id of a User.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful." + }, + "304": { + "description": "The requested content was not modified." + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/whoami": { + "get": { + "tags": [ + "UserProfile" + ], + "summary": "Get the UserProfile of the logged in user.", + "description": "", + "operationId": "GetOwnUserProfile", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/UserProfile" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{versionedItemId}/checkout": { + "post": { + "tags": [ + "Versioning" + ], + "summary": "Checks out a VersionedItem.", + "description": "This operation returns an implementation of the abstract type 'VersionedItem'. Depending on the requested item, one of the following instances may be returned:\n\n
  • BundleType
  • Component
  • ComponentTemplate
  • Page
  • PageTemplate
  • Schema
  • TemplateBuildingBlock
", + "operationId": "CheckoutVersionedItemData", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "versionedItemId", + "in": "path", + "description": "The (escaped) TCM id of a VersionedItem.", + "required": true, + "type": "string" + }, + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckInCheckOutRequest" + } + }, + { + "name": "useBlueprintContextOverridesIfAvailable", + "in": "query", + "description": "Loads the item using blueprint content override settings (if applicable).", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/VersionedItem" + } + }, + "204": { + "description": "The request was succesful and there is no content in the body of the response." + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{versionedItemId}/checkin": { + "post": { + "tags": [ + "Versioning" + ], + "summary": "Checks in a VersionedItem.", + "description": "This operation returns an implementation of the abstract type 'VersionedItem'. Depending on the requested item, one of the following instances may be returned:\n\n
  • BundleType
  • Component
  • ComponentTemplate
  • Page
  • PageTemplate
  • Schema
  • TemplateBuildingBlock
", + "operationId": "CheckinVersionedItemData", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "versionedItemId", + "in": "path", + "description": "The (escaped) TCM id of a VersionedItem.", + "required": true, + "type": "string" + }, + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckInCheckOutRequest" + } + }, + { + "name": "useBlueprintContextOverridesIfAvailable", + "in": "query", + "description": "Loads the item using blueprint content override settings (if applicable).", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/VersionedItem" + } + }, + "204": { + "description": "The request was succesful and there is no content in the body of the response." + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{versionedItemId}/undocheckout": { + "post": { + "tags": [ + "Versioning" + ], + "summary": "Reverts the checkout of a VersionedItem.", + "description": "This operation returns an implementation of the abstract type 'VersionedItem'. Depending on the requested item, one of the following instances may be returned:\n\n
  • BundleType
  • Component
  • ComponentTemplate
  • Page
  • PageTemplate
  • Schema
  • TemplateBuildingBlock
", + "operationId": "UndoCheckoutVersionedItemData", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "versionedItemId", + "in": "path", + "description": "The (escaped) TCM id of a VersionedItem.", + "required": true, + "type": "string" + }, + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckInCheckOutRequest" + } + }, + { + "name": "useBlueprintContextOverridesIfAvailable", + "in": "query", + "description": "Loads the item using blueprint content override settings (if applicable).", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/VersionedItem" + } + }, + "204": { + "description": "The request was succesful and there is no content in the body of the response." + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{versionedItemId}/rollback": { + "post": { + "tags": [ + "Versioning" + ], + "summary": "Rolls back a VersionedItem to a previous version.", + "description": "This operation returns an implementation of the abstract type 'VersionedItem'. Depending on the requested item, one of the following instances may be returned:\n\n
  • BundleType
  • Component
  • ComponentTemplate
  • Page
  • PageTemplate
  • Schema
  • TemplateBuildingBlock
", + "operationId": "RollBackVersionedItemData", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "versionedItemId", + "in": "path", + "description": "The (escaped) TCM id of a VersionedItem.", + "required": true, + "type": "string" + }, + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/RollBackRequest" + } + }, + { + "name": "useBlueprintContextOverridesIfAvailable", + "in": "query", + "description": "Loads the item using blueprint content override settings (if applicable).", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/VersionedItem" + } + }, + "204": { + "description": "The request was succesful and there is no content in the body of the response." + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/item/{versionedItemId}/history": { + "get": { + "tags": [ + "Versioning" + ], + "summary": "Gets the history of a VersionedItem.", + "description": "This operation returns an implementation of the abstract type 'IdentifiableObject'. Depending on the requested item, one of the following instances may be returned:\n\n
  • AccessToken
  • ActivityHistory
  • ActivityInstance
  • ApprovalStatus
  • Batch
  • BlueprintNode
  • BundleType
  • BusinessProcessType
  • Category
  • Component
  • ComponentTemplate
  • Folder
  • Group
  • Keyword
  • MultimediaType
  • Page
  • PageTemplate
  • ProcessDefinitionAssociation
  • ProcessHistory
  • ProcessInstance
  • Publication
  • PublishTransaction
  • Repository
  • ResolvedBundle
  • Schema
  • StructureGroup
  • TargetGroup
  • TargetType
  • TemplateBuildingBlock
  • CmsActivityDefinition
  • CmsProcessDefinition
  • User
  • VirtualFolder
  • WorkflowType
  • WorkItem
", + "operationId": "History", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "versionedItemId", + "in": "path", + "description": "The (escaped) TCM id of a VersionedItem.", + "required": true, + "type": "string" + }, + { + "name": "listItemProperties", + "in": "query", + "description": "The properties to load for items in a list.", + "required": false, + "type": "string", + "default": 0, + "enum": [ + "All", + "Id", + "IdAndTitle" + ] + }, + { + "name": "useDynamicVersion", + "in": "query", + "description": "Loads a dynamic version (if available for your user).", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/IdentifiableObject" + }, + "xml": { + "name": "IdentifiableObject", + "wrapped": true + }, + "type": "array" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/workflow/addtoworkflow/{activityInstanceId}": { + "post": { + "tags": [ + "Workflow" + ], + "summary": "Adds items to a workflow.", + "description": "If item is a bundle, the bundle and all items in it will be added to workflow. In case of nested bundles, all\r\nnested items will be added to workflow as well (recursively).", + "operationId": "AddToWorkflow", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "activityInstanceId", + "in": "path", + "description": "The (escaped) TCM id of an ActivityInstance.", + "required": true, + "type": "string" + }, + { + "name": "itemIds", + "in": "body", + "description": "A list of (escaped) TCM item id's.", + "required": true, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/WorkItem" + }, + "xml": { + "name": "WorkItem", + "wrapped": true + }, + "type": "array" + } + }, + "204": { + "description": "The request was succesful and there is no content in the body of the response." + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/workflow/startworkflow/{repositoryId}": { + "post": { + "tags": [ + "Workflow" + ], + "summary": "Starts a Workflow.", + "description": "", + "operationId": "StartWorkflow", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "repositoryId", + "in": "path", + "description": "The (escaped) TCM id of a Repository.", + "required": true, + "type": "string" + }, + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/StartWorkflowInstruction" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/ProcessInstance" + } + }, + "204": { + "description": "The request was succesful and there is no content in the body of the response." + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/workflow/removefromworkflow": { + "post": { + "tags": [ + "Workflow" + ], + "summary": "Removes given items from workflow.", + "description": "If the item is a bundle, the bundle and all items in it will be removed from workflow. In case of nested bundles,\r\nall nested items will be removed from workflow as well (recursively),\r\nunless item is contained in another bundle that will remain in workflow.", + "operationId": "RemoveFromWorkflow", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "itemIds", + "in": "body", + "description": "A list of (escaped) TCM item id's.", + "required": true, + "schema": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/WorkItem" + }, + "xml": { + "name": "WorkItem", + "wrapped": true + }, + "type": "array" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/workflow/forcefinishprocess/{processInstanceId}/{approvalStatusId}": { + "post": { + "tags": [ + "Workflow" + ], + "summary": "Forces finish of a Workflow process.", + "description": "", + "operationId": "ForceFinishProcess", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "processInstanceId", + "in": "path", + "description": "The (escaped) TCM id of a ProcessInstance.", + "required": true, + "type": "string" + }, + { + "name": "approvalStatusId", + "in": "path", + "description": "The (escaped) TCM id of an ApprovalStatus.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/ProcessHistory" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/workflow/workflowscriptypes": { + "get": { + "tags": [ + "Workflow" + ], + "summary": "Gets a list of registered Workflow Script Types.", + "description": "", + "operationId": "GetListWorkflowScriptTypes", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "items": { + "$ref": "#/definitions/WorkflowScriptType" + }, + "xml": { + "name": "WorkflowScriptType", + "wrapped": true + }, + "type": "array" + } + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/workflow/processdefinitions": { + "post": { + "tags": [ + "Workflow" + ], + "summary": "Gets process definitions for items.", + "description": "", + "operationId": "GetProcessDefinitionsForItems", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "requestModel", + "in": "body", + "description": "The input model for this operation.", + "required": true, + "schema": { + "$ref": "#/definitions/ProcessDefinitionsRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "additionalProperties": { + "$ref": "#/definitions/Link" + }, + "type": "object" + } + }, + "400": { + "description": "The request data is invalid." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/workflow/purgeworkflowhistory": { + "post": { + "tags": [ + "Workflow" + ], + "summary": "Purges Workflow history.", + "description": "", + "operationId": "PurgeWorkflowHistory", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "purgeWorkflowHistoryInstructionDto", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PurgeWorkflowHistoryInstruction" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + } + ], + "responses": { + "202": { + "description": "The request has been accepted for processing, but the processing has not been completed." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/workflow/startactivity/{activityInstanceId}": { + "post": { + "tags": [ + "Workflow" + ], + "summary": "Starts a Workflow activity.", + "description": "", + "operationId": "StartActivity", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "activityInstanceId", + "in": "path", + "description": "The (escaped) TCM id of an ActivityInstance.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/ActivityInstance" + } + }, + "204": { + "description": "The request was succesful and there is no content in the body of the response." + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/workflow/reassignactivity/{activityInstanceId}/{userId}": { + "post": { + "tags": [ + "Workflow" + ], + "summary": "Reassigns a Workflow activity to another User.", + "description": "", + "operationId": "ReAssignActivity", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "activityInstanceId", + "in": "path", + "description": "The (escaped) TCM id of an ActivityInstance.", + "required": true, + "type": "string" + }, + { + "name": "userId", + "in": "path", + "description": "The (escaped) TCM id of a User.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/ActivityInstance" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/workflow/restartactivity/{activityInstanceId}": { + "post": { + "tags": [ + "Workflow" + ], + "summary": "Restarts a Workflow activity.", + "description": "", + "operationId": "RestartActivity", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "activityInstanceId", + "in": "path", + "description": "The (escaped) TCM id of an ActivityInstance.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/ActivityInstance" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/workflow/resumeactivity/{activityInstanceId}": { + "post": { + "tags": [ + "Workflow" + ], + "summary": "Resumes a Workflow activity.", + "description": "", + "operationId": "ResumeActivity", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "activityInstanceId", + "in": "path", + "description": "The (escaped) TCM id of an ActivityInstance.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/ActivityInstance" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/workflow/suspendactivity/{activityInstanceId}": { + "post": { + "tags": [ + "Workflow" + ], + "summary": "Suspends a Workflow activity.", + "description": "", + "operationId": "SuspendActivity", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "activityInstanceId", + "in": "path", + "description": "The (escaped) TCM id of an ActivityInstance.", + "required": true, + "type": "string" + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/ActivityInstance" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/workflow/suspendandresumeactivity/{activityInstanceId}": { + "post": { + "tags": [ + "Workflow" + ], + "summary": "Suspends and resumes a Workflow activity at the given date.", + "description": "", + "operationId": "SuspendAndResumeActivity", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "activityInstanceId", + "in": "path", + "description": "The (escaped) TCM id of an ActivityInstance.", + "required": true, + "type": "string" + }, + { + "name": "activityRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SuspendAndResumeActivityRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/ActivityInstance" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + }, + "/api/v{api-version}/cm/workflow/finishactivity/{activityInstanceId}": { + "post": { + "tags": [ + "Workflow" + ], + "summary": "Finishes a Workflow activity.", + "description": "", + "operationId": "FinishActivity", + "consumes": [ + "*/*", + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "activityInstanceId", + "in": "path", + "description": "The (escaped) TCM id of an ActivityInstance.", + "required": true, + "type": "string" + }, + { + "name": "activityFinishRequestModel", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ActivityFinishRequest" + } + }, + { + "name": "api-version", + "in": "path", + "description": "The version of the Api you wish to use.", + "required": true, + "type": "string", + "default": "9.5" + }, + { + "name": "loadflags", + "in": "query", + "description": "None=0,WebDavUrls=1,KeywordXlinks=2,Expanded=4,IncludeAllowedActions=8,IncludeDynamicVersionInfo=16,ExpandLinks=32", + "required": false, + "type": "int" + }, + { + "name": "versionresolvingconditions", + "in": "query", + "description": "Never=0,CheckedOutByUser=1,ReservedAndRevisedByUser=2,AssignedToUser=4,ReadableByUser=15", + "required": false, + "type": "int" + } + ], + "responses": { + "200": { + "description": "The request was succesful.", + "schema": { + "$ref": "#/definitions/ActivityInstance" + } + }, + "400": { + "description": "The request data is invalid." + }, + "404": { + "description": "The requested resource doesn't exist." + }, + "500": { + "description": "There was an unexpected error while handling the request." + } + } + } + } + }, + "definitions": { + "ApplicationData": { + "properties": { + "$type": { + "example": "ApplicationData", + "type": "string" + }, + "ApplicationId": { + "type": "string" + }, + "Data": { + "type": "string", + "format": "byte" + }, + "IsInherited": { + "type": "boolean" + }, + "ManagedLinks": { + "$ref": "#/definitions/Link" + }, + "OwningRepositoryId": { + "type": "string" + }, + "TypeId": { + "type": "string" + } + }, + "xml": { + "name": "ApplicationData" + }, + "type": "object" + }, + "Link": { + "properties": { + "IdRef": { + "type": "string" + }, + "Title": { + "type": "string" + }, + "$type": { + "example": "Link", + "type": "string" + }, + "Description": { + "type": "string" + }, + "WebDavUrl": { + "type": "string" + } + }, + "xml": { + "name": "Link" + }, + "type": "object" + }, + "MultiSubjectMultiAppDataRequest": { + "properties": { + "ApplicationIds": { + "items": { + "type": "string" + }, + "type": "array" + }, + "SubjectIds": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "xml": { + "name": "MultiSubjectMultiAppDataRequest" + }, + "type": "object" + }, + "BatchCheckinRequest": { + "properties": { + "SetOrRemoveRemovePermanentLock": { + "type": "boolean" + }, + "SubjectOrActivityInstanceLinks": { + "items": { + "$ref": "#/definitions/WeakLink" + }, + "xml": { + "name": "WeakLink", + "wrapped": true + }, + "type": "array" + }, + "UserComment": { + "type": "string" + } + }, + "xml": { + "name": "BatchCheckinRequest" + }, + "type": "object" + }, + "WeakLink": { + "properties": { + "IdRef": { + "type": "string" + }, + "Title": { + "type": "string" + }, + "$type": { + "example": "WeakLink", + "type": "string" + } + }, + "xml": { + "name": "WeakLink" + }, + "type": "object" + }, + "BatchOperationWithLockingRequest": { + "properties": { + "SetOrRemoveRemovePermanentLock": { + "type": "boolean" + }, + "SubjectOrActivityInstanceLinks": { + "items": { + "$ref": "#/definitions/WeakLink" + }, + "xml": { + "name": "WeakLink", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "BatchOperationWithLockingRequest" + }, + "type": "object" + }, + "BatchClassifyOrUnClassifyRequest": { + "properties": { + "KeywordIds": { + "items": { + "type": "string" + }, + "type": "array" + }, + "SubjectOrActivityInstanceLinks": { + "items": { + "$ref": "#/definitions/WeakLink" + }, + "xml": { + "name": "WeakLink", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "BatchClassifyOrUnClassifyRequest" + }, + "type": "object" + }, + "BatchCopyRequest": { + "properties": { + "DestinationId": { + "type": "string" + }, + "MakeUnique": { + "type": "boolean" + }, + "SubjectOrActivityInstanceLinks": { + "items": { + "$ref": "#/definitions/WeakLink" + }, + "xml": { + "name": "WeakLink", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "BatchCopyRequest" + }, + "type": "object" + }, + "BatchCopyOrMoveRequest": { + "properties": { + "DestinationId": { + "type": "string" + }, + "SubjectOrActivityInstanceLinks": { + "items": { + "$ref": "#/definitions/WeakLink" + }, + "xml": { + "name": "WeakLink", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "BatchCopyOrMoveRequest" + }, + "type": "object" + }, + "BatchOperationRequest": { + "properties": { + "SubjectOrActivityInstanceLinks": { + "items": { + "$ref": "#/definitions/WeakLink" + }, + "xml": { + "name": "WeakLink", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "BatchOperationRequest" + }, + "type": "object" + }, + "BatchDeleteTaxonomyNodeRequest": { + "properties": { + "SubjectOrActivityInstanceLinks": { + "items": { + "$ref": "#/definitions/WeakLink" + }, + "xml": { + "name": "WeakLink", + "wrapped": true + }, + "type": "array" + }, + "TaxonomyNodeMode": { + "type": "string", + "enum": [ + "DeleteBranch", + "DeleteBranchIncludeChildPublications", + "RemoveParentFromChildren", + "AssignChildrenToGrandparents" + ] + } + }, + "xml": { + "name": "BatchDeleteTaxonomyNodeRequest" + }, + "type": "object" + }, + "BatchPromoteDemoteRequest": { + "properties": { + "DestinationRepositoryId": { + "type": "string" + }, + "Instruction": { + "$ref": "#/definitions/OperationInstruction" + }, + "SubjectOrActivityInstanceLinks": { + "items": { + "$ref": "#/definitions/WeakLink" + }, + "xml": { + "name": "WeakLink", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "BatchPromoteDemoteRequest" + }, + "type": "object" + }, + "OperationInstruction": { + "properties": { + "$type": { + "example": "OperationInstruction", + "type": "string" + }, + "Mode": { + "type": "string", + "enum": [ + "FailOnError", + "FailOnWarning" + ] + } + }, + "xml": { + "name": "OperationInstruction" + }, + "type": "object" + }, + "BatchFinishActivityRequest": { + "properties": { + "ActivityFinishInfo": { + "$ref": "#/definitions/ActivityFinishInfo" + }, + "SubjectOrActivityInstanceLinks": { + "items": { + "$ref": "#/definitions/WeakLink" + }, + "xml": { + "name": "WeakLink", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "BatchFinishActivityRequest" + }, + "type": "object" + }, + "ActivityFinishInfo": { + "properties": { + "Message": { + "type": "string" + }, + "NextActivityDueDate": { + "type": "string", + "format": "date-time" + }, + "NextActivityTitle": { + "type": "string" + }, + "NextAssignee": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "ActivityFinishInfo" + }, + "type": "object" + }, + "BatchForceFinishRequest": { + "properties": { + "ApprovalStatusId": { + "type": "string" + }, + "SubjectOrActivityInstanceLinks": { + "items": { + "$ref": "#/definitions/WeakLink" + }, + "xml": { + "name": "WeakLink", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "BatchForceFinishRequest" + }, + "type": "object" + }, + "BatchPublishRequest": { + "properties": { + "Priority": { + "type": "string", + "enum": [ + "UnknownByClient", + "Low", + "Normal", + "High" + ] + }, + "PublishInstruction": { + "$ref": "#/definitions/PublishInstruction" + }, + "SubjectOrActivityInstanceLinks": { + "items": { + "$ref": "#/definitions/WeakLink" + }, + "xml": { + "name": "WeakLink", + "wrapped": true + }, + "type": "array" + }, + "TargetIdsOrPurposes": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "xml": { + "name": "BatchPublishRequest" + }, + "type": "object" + }, + "PublishInstruction": { + "properties": { + "$type": { + "example": "PublishInstruction", + "type": "string" + }, + "DeployAt": { + "type": "string", + "format": "date-time" + }, + "ExtensionXml": { + "type": "string" + }, + "MaximumNumberOfRenderFailures": { + "type": "integer", + "format": "int32" + }, + "RenderInstruction": { + "$ref": "#/definitions/RenderInstruction" + }, + "ResolveInstruction": { + "$ref": "#/definitions/ResolveInstruction" + }, + "RollbackOnFailure": { + "type": "boolean" + }, + "StartAt": { + "type": "string", + "format": "date-time" + } + }, + "xml": { + "name": "PublishInstruction" + }, + "type": "object" + }, + "RenderInstruction": { + "properties": { + "$type": { + "example": "RenderInstruction", + "type": "string" + }, + "BinaryStoragePath": { + "type": "string" + }, + "ExtensionXml": { + "type": "string" + }, + "RenderMode": { + "type": "string", + "enum": [ + "UnknownByClient", + "Publish", + "PreviewStatic", + "PreviewDynamic" + ] + } + }, + "xml": { + "name": "RenderInstruction" + }, + "type": "object" + }, + "ResolveInstruction": { + "properties": { + "$type": { + "example": "ResolveInstruction", + "type": "string" + }, + "ExtensionXml": { + "type": "string" + }, + "IncludeChildPublications": { + "type": "boolean" + }, + "IncludeComponentLinks": { + "type": "boolean" + }, + "IncludeDynamicVersion": { + "type": "boolean" + }, + "IncludeWorkflow": { + "type": "boolean" + }, + "Purpose": { + "type": "string", + "enum": [ + "UnknownByClient", + "Publish", + "UnPublish", + "RePublish" + ] + }, + "StructureResolveOption": { + "type": "string", + "enum": [ + "UnknownByClient", + "OnlyItems", + "OnlyStructure", + "ItemsAndStructure" + ] + } + }, + "xml": { + "name": "ResolveInstruction" + }, + "type": "object" + }, + "BatchReAssignActivityRequest": { + "properties": { + "AssigneeId": { + "type": "string" + }, + "SubjectOrActivityInstanceLinks": { + "items": { + "$ref": "#/definitions/WeakLink" + }, + "xml": { + "name": "WeakLink", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "BatchReAssignActivityRequest" + }, + "type": "object" + }, + "BatchReClassifyRequest": { + "properties": { + "KeywordIdsToAdd": { + "items": { + "type": "string" + }, + "type": "array" + }, + "KeywordIdsToRemove": { + "items": { + "type": "string" + }, + "type": "array" + }, + "SubjectOrActivityInstanceLinks": { + "items": { + "$ref": "#/definitions/WeakLink" + }, + "xml": { + "name": "WeakLink", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "BatchReClassifyRequest" + }, + "type": "object" + }, + "BatchSuspendActivityRequest": { + "properties": { + "Reason": { + "type": "string" + }, + "SubjectOrActivityInstanceLinks": { + "items": { + "$ref": "#/definitions/WeakLink" + }, + "xml": { + "name": "WeakLink", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "BatchSuspendActivityRequest" + }, + "type": "object" + }, + "BatchSwitchUserEnabledStateRequest": { + "properties": { + "IsEnabled": { + "type": "boolean" + }, + "SubjectOrActivityInstanceLinks": { + "items": { + "$ref": "#/definitions/WeakLink" + }, + "xml": { + "name": "WeakLink", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "BatchSwitchUserEnabledStateRequest" + }, + "type": "object" + }, + "BatchSynchronizeSchemaRequest": { + "properties": { + "SubjectOrActivityInstanceLinks": { + "items": { + "$ref": "#/definitions/WeakLink" + }, + "xml": { + "name": "WeakLink", + "wrapped": true + }, + "type": "array" + }, + "SynchronizeOptions": { + "$ref": "#/definitions/CmsSynchronizeOptions" + } + }, + "xml": { + "name": "BatchSynchronizeSchemaRequest" + }, + "type": "object" + }, + "CmsSynchronizeOptions": { + "properties": { + "LoadFlags": { + "type": "string", + "enum": [ + "None", + "WebDavUrls", + "KeywordXlinks", + "Expanded", + "IncludeAllowedActions", + "IncludeDynamicVersionInfo", + "ExpandLinks" + ] + }, + "SynchronizeFlags": { + "type": "string", + "enum": [ + "Basic", + "FixNamespace", + "RemoveUnknownFields", + "RemoveAdditionalValues", + "ApplyDefaultValuesForMissingMandatoryFields", + "ApplyDefaultValuesForMissingNonMandatoryFields", + "ApplyFilterXsltToXhtmlFields", + "ConvertFieldType", + "All", + "UnknownByClient" + ] + }, + "UseDynamicVersion": { + "type": "string", + "enum": [ + "Never", + "CheckedOutByUser", + "ReservedAndRevisedByUser", + "AssignedToUser", + "ReadableByUser" + ] + } + }, + "xml": { + "name": "CmsSynchronizeOptions" + }, + "type": "object" + }, + "BatchUnPublishRequest": { + "properties": { + "Priority": { + "type": "string", + "enum": [ + "UnknownByClient", + "Low", + "Normal", + "High" + ] + }, + "SubjectOrActivityInstanceLinks": { + "items": { + "$ref": "#/definitions/WeakLink" + }, + "xml": { + "name": "WeakLink", + "wrapped": true + }, + "type": "array" + }, + "TargetIdsOrPurposes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "UnPublishInstruction": { + "$ref": "#/definitions/UnPublishInstruction" + } + }, + "xml": { + "name": "BatchUnPublishRequest" + }, + "type": "object" + }, + "UnPublishInstruction": { + "properties": { + "$type": { + "example": "UnPublishInstruction", + "type": "string" + }, + "ExtensionXml": { + "type": "string" + }, + "ResolveInstruction": { + "$ref": "#/definitions/ResolveInstruction" + }, + "RollbackOnFailure": { + "type": "boolean" + }, + "StartAt": { + "type": "string", + "format": "date-time" + } + }, + "xml": { + "name": "UnPublishInstruction" + }, + "type": "object" + }, + "BlueprintItemDescriptor": { + "properties": { + "Title": { + "type": "string" + }, + "$type": { + "example": "BlueprintItemDescriptor", + "type": "string" + }, + "ChildrenIds": { + "items": { + "type": "string" + }, + "type": "array" + }, + "ContextRepositoryId": { + "type": "string" + }, + "ContextRepositoryTitle": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "IsLocalized": { + "type": "boolean" + }, + "IsRoot": { + "type": "boolean" + }, + "IsShared": { + "type": "boolean" + }, + "OwningRepositoryId": { + "type": "string" + }, + "OwningRepositoryTitle": { + "type": "string" + }, + "ParentItemId": { + "type": "string" + }, + "ParentRepositoryId": { + "type": "string" + }, + "ParentRepositoryTitle": { + "type": "string" + }, + "PrimaryBluePrintParentItemId": { + "type": "string" + }, + "PrimaryBluePrintParentItemTitle": { + "type": "string" + }, + "discriminator": { + "type": "string" + } + }, + "discriminator": "BlueprintItemDescriptorType", + "xml": { + "name": "BlueprintItemDescriptor" + }, + "type": "object" + }, + "BlueprintContextOverrides": { + "properties": { + "$type": { + "example": "BlueprintContextOverrides", + "type": "string" + }, + "AlternatePublicationForComponents": { + "type": "string" + }, + "AlternatePublicationForPages": { + "type": "string" + }, + "PublicationId": { + "type": "string" + } + }, + "xml": { + "name": "BlueprintContextOverrides" + }, + "type": "object" + }, + "BlueprintNodeDescriptor": { + "properties": { + "Title": { + "type": "string" + }, + "$type": { + "example": "BlueprintNodeDescriptor", + "type": "string" + }, + "ChildrenIds": { + "items": { + "type": "string" + }, + "type": "array" + }, + "CreationDate": { + "type": "string", + "format": "date-time" + }, + "Id": { + "type": "string" + }, + "Key": { + "type": "string" + }, + "ParentIds": { + "items": { + "type": "string" + }, + "type": "array" + }, + "RevisionDate": { + "type": "string", + "format": "date-time" + } + }, + "xml": { + "name": "BlueprintNodeDescriptor" + }, + "type": "object" + }, + "PromoteDemoteRequest": { + "properties": { + "DestinationRepositoryId": { + "type": "string" + }, + "Instruction": { + "$ref": "#/definitions/OperationInstruction" + }, + "discriminator": { + "type": "string" + } + }, + "discriminator": "PromoteDemoteRequestType", + "xml": { + "name": "PromoteDemoteRequest" + }, + "type": "object" + }, + "OperationResult": { + "properties": { + "$type": { + "example": "OperationResult", + "type": "string" + }, + "Result": { + "$ref": "#/definitions/IdentifiableObject" + }, + "ValidationWarnings": { + "items": { + "$ref": "#/definitions/ValidationWarning" + }, + "xml": { + "name": "ValidationWarning", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "OperationResult" + }, + "type": "object" + }, + "IdentifiableObject": { + "properties": { + "Id": { + "type": "string" + }, + "Title": { + "type": "string" + }, + "$type": { + "example": "IdentifiableObject", + "type": "string" + }, + "ApplicableActions": { + "items": { + "$ref": "#/definitions/HateoasLink" + }, + "xml": { + "name": "HateoasLink", + "wrapped": true + }, + "type": "array" + }, + "ExtensionData": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IsEditable": { + "type": "boolean" + }, + "ListLinks": { + "items": { + "$ref": "#/definitions/HateoasLink" + }, + "xml": { + "name": "HateoasLink", + "wrapped": true + }, + "type": "array" + }, + "SecurityDescriptor": { + "$ref": "#/definitions/SecurityDescriptor" + }, + "VersionInfo": { + "$ref": "#/definitions/BasicVersionInfo" + }, + "discriminator": { + "type": "string" + } + }, + "discriminator": "IdentifiableObjectType", + "xml": { + "name": "IdentifiableObject" + }, + "type": "object" + }, + "ValidationWarning": { + "properties": { + "Location": { + "type": "string" + }, + "Message": { + "type": "string" + }, + "Source": { + "type": "string" + } + }, + "xml": { + "name": "ValidationWarning" + }, + "type": "object" + }, + "HateoasLink": { + "properties": { + "$type": { + "example": "HateoasLink", + "type": "string" + }, + "Href": { + "type": "string" + }, + "Rel": { + "type": "string" + }, + "Type": { + "type": "string" + } + }, + "xml": { + "name": "HateoasLink" + }, + "type": "object" + }, + "SecurityDescriptor": { + "properties": { + "$type": { + "example": "SecurityDescriptor", + "type": "string" + }, + "Permissions": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Read", + "Write", + "Delete", + "Localize", + "All" + ] + }, + "Rights": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "PublicationAccess", + "PublicationManagement", + "FolderManagement", + "StructureGroupManagement", + "SchemaManagement", + "ComponentManagement", + "ComponentTemplateManagement", + "PageManagement", + "PageTemplateManagement", + "ProfileManagement", + "PublishManagement", + "PermissionManagement", + "WorkflowManagement", + "CategoryManagement", + "TemplateBuildingBlockManagement", + "VirtualFolderManagement", + "BundleManagement", + "BusinessProcessTypeManagement", + "PublicationAdministration", + "All" + ] + } + }, + "xml": { + "name": "SecurityDescriptor" + }, + "type": "object" + }, + "BasicVersionInfo": { + "properties": { + "$type": { + "example": "BasicVersionInfo", + "type": "string" + }, + "CreationDate": { + "type": "string", + "format": "date-time" + }, + "RevisionDate": { + "type": "string", + "format": "date-time" + } + }, + "xml": { + "name": "BasicVersionInfo" + }, + "type": "object" + }, + "BlueprintInfo": { + "properties": { + "$type": { + "example": "BlueprintInfo", + "type": "string" + }, + "IsLocalized": { + "type": "boolean" + }, + "IsShared": { + "type": "boolean" + }, + "OwningRepository": { + "$ref": "#/definitions/Link" + }, + "PrimaryBluePrintParentItem": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "BlueprintInfo" + }, + "type": "object" + }, + "LocationInfo": { + "properties": { + "$type": { + "example": "LocationInfo", + "type": "string" + }, + "ContextRepository": { + "$ref": "#/definitions/Link" + }, + "OrganizationalItem": { + "$ref": "#/definitions/Link" + }, + "Path": { + "type": "string" + }, + "WebDavUrl": { + "type": "string" + } + }, + "xml": { + "name": "LocationInfo" + }, + "type": "object" + }, + "LockInfo": { + "properties": { + "$type": { + "example": "LockInfo", + "type": "string" + }, + "LockDate": { + "type": "string", + "format": "date-time" + }, + "LockType": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "CheckedOut", + "Permanent", + "NewItem", + "InWorkflow", + "Reserved" + ] + }, + "LockUser": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "LockInfo" + }, + "type": "object" + }, + "LimitedVersionInfo": { + "properties": { + "$type": { + "example": "LimitedVersionInfo", + "type": "string" + }, + "CreationDate": { + "type": "string", + "format": "date-time" + }, + "Creator": { + "$ref": "#/definitions/Link" + }, + "RevisionDate": { + "type": "string", + "format": "date-time" + } + }, + "xml": { + "name": "LimitedVersionInfo" + }, + "type": "object" + }, + "RepositoryLocalObject": { + "allOf": [ + { + "$ref": "#/definitions/IdentifiableObject" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "BluePrintInfo": { + "$ref": "#/definitions/BlueprintInfo" + }, + "IsPublishedInContext": { + "type": "boolean" + }, + "LocationInfo": { + "$ref": "#/definitions/LocationInfo" + }, + "LockInfo": { + "$ref": "#/definitions/LockInfo" + }, + "Metadata": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "MetadataSchema": { + "$ref": "#/definitions/Link" + }, + "VersionInfo": { + "$ref": "#/definitions/LimitedVersionInfo" + } + }, + "type": "object" + } + ], + "xml": { + "name": "RepositoryLocalObject" + }, + "type": "object" + }, + "PublishedItemInfo": { + "properties": { + "ComponentPresentationType": { + "type": "string", + "enum": [ + "None", + "Embedded", + "DynamicOnPage", + "DynamicQueryBased" + ] + }, + "ItemId": { + "type": "string" + }, + "ItemLastModifiedTimeStamp": { + "type": "string", + "format": "date-time" + }, + "TemplateId": { + "type": "string" + }, + "TemplateLastModifiedTimeStamp": { + "type": "string", + "format": "date-time" + } + }, + "xml": { + "name": "PublishedItemInfo" + }, + "type": "object" + }, + "ApiStatus": { + "properties": { + "ApiVersion": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "Details": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "Links": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "ServerTime": { + "type": "string", + "format": "date-time" + } + }, + "xml": { + "name": "ApiStatus" + }, + "type": "object" + }, + "ValidationError": { + "properties": { + "ErrorCode": { + "type": "string" + }, + "ExceptionName": { + "type": "string" + }, + "Location": { + "type": "string" + }, + "Message": { + "type": "string" + }, + "Source": { + "type": "string" + } + }, + "xml": { + "name": "ValidationError" + }, + "type": "object" + }, + "TemplateType": { + "properties": { + "Title": { + "type": "string" + }, + "$type": { + "example": "TemplateType", + "type": "string" + }, + "HasBinaryContent": { + "type": "boolean" + }, + "Id": { + "type": "integer", + "format": "int32" + }, + "MimeType": { + "type": "string" + }, + "Name": { + "type": "string" + }, + "WebDavFileExtensionMappings": { + "items": { + "$ref": "#/definitions/WebDavFileExtensionMapping" + }, + "xml": { + "name": "WebDavFileExtensionMapping", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "TemplateType" + }, + "type": "object" + }, + "WebDavFileExtensionMapping": { + "properties": { + "$type": { + "example": "WebDavFileExtensionMapping", + "type": "string" + }, + "FileExtension": { + "type": "string" + }, + "ItemType": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Publication", + "Folder", + "StructureGroup", + "Schema", + "Component", + "ComponentTemplate", + "Page", + "PageTemplate", + "TargetGroup", + "Category", + "Keyword", + "TemplateBuildingBlock", + "BusinessProcessType", + "VirtualFolder", + "PublicationTarget", + "TargetType", + "TargetDestination", + "MultimediaType", + "User", + "Group", + "DirectoryService", + "DirectoryGroupMapping", + "Batch", + "MultipleOperations", + "PublishTransaction", + "WorkflowType", + "ApprovalStatus", + "ProcessDefinition", + "ProcessInstance", + "ProcessHistory", + "ActivityDefinition", + "ActivityInstance", + "ActivityHistory", + "WorkItem" + ] + } + }, + "xml": { + "name": "WebDavFileExtensionMapping" + }, + "type": "object" + }, + "PublicationType": { + "properties": { + "Title": { + "type": "string" + }, + "$type": { + "example": "PublicationType", + "type": "string" + }, + "Id": { + "type": "integer", + "format": "int32" + }, + "Name": { + "type": "string" + } + }, + "xml": { + "name": "PublicationType" + }, + "type": "object" + }, + "SystemPrivilege": { + "properties": { + "Title": { + "type": "string" + }, + "$type": { + "example": "SystemPrivilege", + "type": "string" + }, + "Description": { + "type": "string" + }, + "Key": { + "type": "string" + } + }, + "xml": { + "name": "SystemPrivilege" + }, + "type": "object" + }, + "SystemWideListFilter": { + "properties": { + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "SystemWideListFilter" + }, + "type": "object" + }, + "SubjectRelatedListFilter": { + "properties": { + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "SubjectRelatedListFilter" + }, + "type": "object" + }, + "UsesItemsFilter": { + "properties": { + "$type": { + "example": "UsesItemsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IncludeBlueprintParentItem": { + "type": "boolean" + }, + "IncludeExternalLinks": { + "type": "boolean" + }, + "InRepository": { + "$ref": "#/definitions/Link" + }, + "ItemTypes": { + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Publication", + "Folder", + "StructureGroup", + "Schema", + "Component", + "ComponentTemplate", + "Page", + "PageTemplate", + "TargetGroup", + "Category", + "Keyword", + "TemplateBuildingBlock", + "BusinessProcessType", + "VirtualFolder", + "PublicationTarget", + "TargetType", + "TargetDestination", + "MultimediaType", + "User", + "Group", + "DirectoryService", + "DirectoryGroupMapping", + "Batch", + "MultipleOperations", + "PublishTransaction", + "WorkflowType", + "ApprovalStatus", + "ProcessDefinition", + "ProcessInstance", + "ProcessHistory", + "ActivityDefinition", + "ActivityInstance", + "ActivityHistory", + "WorkItem" + ] + }, + "xml": { + "name": "ItemType", + "wrapped": true + }, + "type": "array" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "UsesItemsFilter" + }, + "type": "object" + }, + "UsedByItemsFilter": { + "properties": { + "$type": { + "example": "UsedByItemsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExcludeTaxonomyRelations": { + "type": "boolean" + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IncludedVersions": { + "type": "string", + "enum": [ + "AllVersions", + "OnlyLatestVersions", + "OnlyLatestAndCheckedOutVersions" + ] + }, + "IncludeLocalCopies": { + "type": "boolean" + }, + "IncludeVersionsColumn": { + "type": "boolean" + }, + "InRepository": { + "$ref": "#/definitions/Link" + }, + "ItemTypes": { + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Publication", + "Folder", + "StructureGroup", + "Schema", + "Component", + "ComponentTemplate", + "Page", + "PageTemplate", + "TargetGroup", + "Category", + "Keyword", + "TemplateBuildingBlock", + "BusinessProcessType", + "VirtualFolder", + "PublicationTarget", + "TargetType", + "TargetDestination", + "MultimediaType", + "User", + "Group", + "DirectoryService", + "DirectoryGroupMapping", + "Batch", + "MultipleOperations", + "PublishTransaction", + "WorkflowType", + "ApprovalStatus", + "ProcessDefinition", + "ProcessInstance", + "ProcessHistory", + "ActivityDefinition", + "ActivityInstance", + "ActivityHistory", + "WorkItem" + ] + }, + "xml": { + "name": "ItemType", + "wrapped": true + }, + "type": "array" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "UsedByItemsFilter" + }, + "type": "object" + }, + "ContainingBundlesFilter": { + "properties": { + "$type": { + "example": "ContainingBundlesFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IncludeBundleTypeColumns": { + "type": "boolean" + }, + "IncludeDescriptionColumn": { + "type": "boolean" + }, + "OnlySpecifiedBluePrintVariant": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + }, + "SuppressLocalCopies": { + "type": "boolean" + } + }, + "xml": { + "name": "ContainingBundlesFilter" + }, + "type": "object" + }, + "TreeNode": { + "properties": { + "IdRef": { + "type": "string" + }, + "DisplayName": { + "type": "string" + }, + "Children": { + "items": { + "$ref": "#/definitions/TreeNode" + }, + "xml": { + "name": "TreeNode", + "wrapped": true + }, + "type": "array" + }, + "Data": { + "$ref": "#/definitions/IdentifiableObject" + }, + "DataType": { + "type": "string" + }, + "Parent": { + "$ref": "#/definitions/TreeNode" + } + }, + "xml": { + "name": "TreeNode" + }, + "type": "object" + }, + "AccessControlList": { + "properties": { + "$type": { + "example": "AccessControlList", + "type": "string" + }, + "AccessControlEntries": { + "items": { + "$ref": "#/definitions/AccessControlEntry" + }, + "xml": { + "name": "AccessControlEntry", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "AccessControlList" + }, + "type": "object" + }, + "AccessControlEntry": { + "properties": { + "$type": { + "example": "AccessControlEntry", + "type": "string" + }, + "AllowedPermissions": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Read", + "Write", + "Delete", + "Localize", + "All" + ] + }, + "AllowedRights": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "PublicationAccess", + "PublicationManagement", + "FolderManagement", + "StructureGroupManagement", + "SchemaManagement", + "ComponentManagement", + "ComponentTemplateManagement", + "PageManagement", + "PageTemplateManagement", + "ProfileManagement", + "PublishManagement", + "PermissionManagement", + "WorkflowManagement", + "CategoryManagement", + "TemplateBuildingBlockManagement", + "VirtualFolderManagement", + "BundleManagement", + "BusinessProcessTypeManagement", + "PublicationAdministration", + "All" + ] + }, + "DeniedPermissions": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Read", + "Write", + "Delete", + "Localize", + "All" + ] + }, + "DeniedRights": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "PublicationAccess", + "PublicationManagement", + "FolderManagement", + "StructureGroupManagement", + "SchemaManagement", + "ComponentManagement", + "ComponentTemplateManagement", + "PageManagement", + "PageTemplateManagement", + "ProfileManagement", + "PublishManagement", + "PermissionManagement", + "WorkflowManagement", + "CategoryManagement", + "TemplateBuildingBlockManagement", + "VirtualFolderManagement", + "BundleManagement", + "BusinessProcessTypeManagement", + "PublicationAdministration", + "All" + ] + }, + "Trustee": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "AccessControlEntry" + }, + "type": "object" + }, + "OrganizationalItem": { + "allOf": [ + { + "$ref": "#/definitions/RepositoryLocalObject" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "AccessControlList": { + "$ref": "#/definitions/AccessControlList" + }, + "ContentSecurityDescriptor": { + "$ref": "#/definitions/SecurityDescriptor" + }, + "IsPermissionsInheritanceRoot": { + "type": "boolean" + }, + "IsRootOrganizationalItem": { + "type": "boolean" + } + }, + "type": "object" + } + ], + "xml": { + "name": "OrganizationalItem" + }, + "type": "object" + }, + "PublishInstructionBase": { + "properties": { + "ExtensionXml": { + "type": "string" + }, + "ResolveInstruction": { + "$ref": "#/definitions/ResolveInstruction" + }, + "RollbackOnFailure": { + "type": "boolean" + }, + "StartAt": { + "type": "string", + "format": "date-time" + } + }, + "xml": { + "name": "PublishInstructionBase" + }, + "type": "object" + }, + "PublishContext": { + "properties": { + "$type": { + "example": "PublishContext", + "type": "string" + }, + "ProcessedItems": { + "items": { + "$ref": "#/definitions/ProcessedItem" + }, + "xml": { + "name": "ProcessedItem", + "wrapped": true + }, + "type": "array" + }, + "Publication": { + "$ref": "#/definitions/Link" + }, + "PublicationTarget": { + "$ref": "#/definitions/Link" + }, + "ResolvedItems": { + "items": { + "$ref": "#/definitions/ResolvedItem" + }, + "xml": { + "name": "ResolvedItem", + "wrapped": true + }, + "type": "array" + }, + "TargetType": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "PublishContext" + }, + "type": "object" + }, + "ProcessedItem": { + "properties": { + "$type": { + "example": "ProcessedItem", + "type": "string" + }, + "HasRenderFailure": { + "type": "boolean" + }, + "IsRendered": { + "type": "boolean" + }, + "ReasonOfRenderFailure": { + "type": "string" + }, + "RenderTime": { + "type": "string" + }, + "ResolvedItem": { + "$ref": "#/definitions/ResolvedItem" + } + }, + "xml": { + "name": "ProcessedItem" + }, + "type": "object" + }, + "ResolvedItem": { + "properties": { + "$type": { + "example": "ResolvedItem", + "type": "string" + }, + "Item": { + "$ref": "#/definitions/Link" + }, + "ItemPath": { + "type": "string" + }, + "PublicationTarget": { + "$ref": "#/definitions/Link" + }, + "Template": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "ResolvedItem" + }, + "type": "object" + }, + "PublishTransaction": { + "allOf": [ + { + "$ref": "#/definitions/SystemWideObject" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "Creator": { + "$ref": "#/definitions/Link" + }, + "DeployerAction": { + "type": "string", + "enum": [ + "UnknownByClient", + "Commit", + "Wait", + "Abort" + ] + }, + "HasRenderFailures": { + "type": "boolean" + }, + "Information": { + "type": "string" + }, + "Instruction": { + "$ref": "#/definitions/PublishInstructionBase" + }, + "IsCompleted": { + "type": "boolean" + }, + "Items": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "Priority": { + "type": "string", + "enum": [ + "UnknownByClient", + "Low", + "Normal", + "High" + ] + }, + "PublishContexts": { + "items": { + "$ref": "#/definitions/PublishContext" + }, + "xml": { + "name": "PublishContext", + "wrapped": true + }, + "type": "array" + }, + "PublisherHost": { + "type": "string" + }, + "RenderingTime": { + "type": "string" + }, + "ResolvingTime": { + "type": "string" + }, + "State": { + "type": "string", + "enum": [ + "UnknownByClient", + "ScheduledForPublish", + "WaitingForPublish", + "InProgress", + "ScheduledForDeployment", + "WaitingForDeployment", + "Failed", + "Success", + "Succes", + "Warning", + "Resolving", + "Rendering", + "Throttled", + "ReadyForTransport", + "Transporting", + "Deploying", + "PreparingDeployment", + "PreCommittingDeployment", + "CommittingDeployment", + "WaitingForUndo", + "Undoing", + "Undone", + "UndoFailed", + "WaitingForCdEnvironment" + ] + }, + "StateChangeDateTime": { + "type": "string", + "format": "date-time" + }, + "TargetType": { + "$ref": "#/definitions/Link" + }, + "TotalExecutionTime": { + "type": "string" + } + }, + "type": "object" + } + ], + "xml": { + "name": "PublishTransaction" + }, + "type": "object" + }, + "PublishRequest": { + "properties": { + "Ids": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Priority": { + "type": "string", + "enum": [ + "UnknownByClient", + "Low", + "Normal", + "High" + ] + }, + "PublishInstruction": { + "$ref": "#/definitions/PublishInstruction" + }, + "TargetIdsOrPurposes": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "xml": { + "name": "PublishRequest" + }, + "type": "object" + }, + "UnPublishRequest": { + "properties": { + "Ids": { + "items": { + "type": "string" + }, + "type": "array" + }, + "Priority": { + "type": "string", + "enum": [ + "UnknownByClient", + "Low", + "Normal", + "High" + ] + }, + "TargetIdsOrPurposes": { + "items": { + "type": "string" + }, + "type": "array" + }, + "UnPublishInstruction": { + "$ref": "#/definitions/UnPublishInstruction" + } + }, + "xml": { + "name": "UnPublishRequest" + }, + "type": "object" + }, + "PublishInfo": { + "properties": { + "$type": { + "example": "PublishInfo", + "type": "string" + }, + "PublicationTarget": { + "$ref": "#/definitions/Link" + }, + "PublishedAt": { + "type": "string", + "format": "date-time" + }, + "RenderedWith": { + "$ref": "#/definitions/Link" + }, + "Repository": { + "$ref": "#/definitions/Link" + }, + "TargetPurpose": { + "type": "string" + }, + "TargetType": { + "$ref": "#/definitions/Link" + }, + "User": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "PublishInfo" + }, + "type": "object" + }, + "IsPublishedRequest": { + "properties": { + "IsPublishedInContext": { + "type": "boolean" + }, + "ItemId": { + "type": "string" + }, + "PublishingTargetIdOrPurpose": { + "type": "string" + } + }, + "xml": { + "name": "IsPublishedRequest" + }, + "type": "object" + }, + "PublishTransactionsFilter": { + "properties": { + "$type": { + "example": "PublishTransactionsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "EndDate": { + "type": "string", + "format": "date-time" + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "ForRepository": { + "$ref": "#/definitions/Link" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IsCompleted": { + "type": "boolean" + }, + "Priority": { + "type": "string", + "enum": [ + "UnknownByClient", + "Low", + "Normal", + "High" + ] + }, + "PublicationTarget": { + "$ref": "#/definitions/Link" + }, + "PublishedBy": { + "$ref": "#/definitions/Link" + }, + "PublisherHost": { + "type": "string" + }, + "PublishTransactionState": { + "type": "string", + "enum": [ + "UnknownByClient", + "ScheduledForPublish", + "WaitingForPublish", + "InProgress", + "ScheduledForDeployment", + "WaitingForDeployment", + "Failed", + "Success", + "Succes", + "Warning", + "Resolving", + "Rendering", + "Throttled", + "ReadyForTransport", + "Transporting", + "Deploying", + "PreparingDeployment", + "PreCommittingDeployment", + "CommittingDeployment", + "WaitingForUndo", + "Undoing", + "Undone", + "UndoFailed", + "WaitingForCdEnvironment" + ] + }, + "SortExpression": { + "type": "string" + }, + "StartDate": { + "type": "string", + "format": "date-time" + }, + "TargetType": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "PublishTransactionsFilter" + }, + "type": "object" + }, + "RemovePublishStateRequest": { + "properties": { + "PublicationId": { + "type": "string" + }, + "PublishingTargetIdOrPurpose": { + "type": "string" + } + }, + "xml": { + "name": "RemovePublishStateRequest" + }, + "type": "object" + }, + "PublishedUrlRequest": { + "properties": { + "ItemId": { + "type": "string" + }, + "PublishingTargetIdOrPurpose": { + "type": "string" + } + }, + "xml": { + "name": "PublishedUrlRequest" + }, + "type": "object" + }, + "PublishSource": { + "properties": { + "ContextPublication": { + "$ref": "#/definitions/Link" + }, + "TargetType": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "PublishSource" + }, + "type": "object" + }, + "QueueMessage": { + "properties": { + "Action": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Insert", + "Update", + "Delete", + "Reset", + "ExpirationActivity" + ] + }, + "CreationDate": { + "type": "string", + "format": "date-time" + }, + "CreationHostName": { + "type": "string" + }, + "Id": { + "type": "integer", + "format": "int32" + }, + "Item": { + "$ref": "#/definitions/Link" + }, + "Priority": { + "type": "string", + "enum": [ + "UnknownByClient", + "Low", + "Normal", + "High" + ] + }, + "ProcessingConsumerId": { + "type": "integer", + "format": "int32" + }, + "PublicationTarget": { + "$ref": "#/definitions/Link" + }, + "QueueId": { + "type": "integer", + "format": "int32" + }, + "ScheduleDateTime": { + "type": "string", + "format": "date-time" + } + }, + "xml": { + "name": "QueueMessage" + }, + "type": "object" + }, + "Queue": { + "properties": { + "Title": { + "type": "string" + }, + "Id": { + "type": "integer", + "format": "int32" + }, + "NumberOfMessages": { + "type": "integer", + "format": "int32" + } + }, + "xml": { + "name": "Queue" + }, + "type": "object" + }, + "RenderRequest": { + "properties": { + "ItemId": { + "type": "string" + }, + "PublicationTargetIdOrPurpose": { + "type": "string" + }, + "PublishInstruction": { + "$ref": "#/definitions/PublishInstruction" + }, + "TemplateId": { + "type": "string" + } + }, + "xml": { + "name": "RenderRequest" + }, + "type": "object" + }, + "RenderedItem": { + "properties": { + "$type": { + "example": "RenderedItem", + "type": "string" + }, + "Binaries": { + "items": { + "$ref": "#/definitions/Binary" + }, + "xml": { + "name": "Binary", + "wrapped": true + }, + "type": "array" + }, + "ChildRenderedItems": { + "items": { + "$ref": "#/definitions/RenderedItem" + }, + "xml": { + "name": "RenderedItem", + "wrapped": true + }, + "type": "array" + }, + "CodePage": { + "type": "integer", + "format": "int32" + }, + "Content": { + "type": "string", + "format": "byte" + }, + "Data": { + "type": "string" + }, + "ExecutionTime": { + "type": "string" + }, + "Instructions": { + "type": "string" + }, + "IsRenderedCompletely": { + "type": "boolean" + }, + "LinkedData": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "Metadata": { + "type": "string" + }, + "RenderInstruction": { + "$ref": "#/definitions/RenderInstruction" + }, + "ResolvedItem": { + "$ref": "#/definitions/ResolvedItem" + } + }, + "xml": { + "name": "RenderedItem" + }, + "type": "object" + }, + "Binary": { + "properties": { + "$type": { + "example": "Binary", + "type": "string" + }, + "ComponentId": { + "type": "string" + }, + "Filename": { + "type": "string" + }, + "FilePath": { + "type": "string" + }, + "LocationId": { + "type": "string" + }, + "MimeType": { + "type": "string" + }, + "Path": { + "type": "string" + }, + "RelatedComponentId": { + "type": "string" + }, + "Url": { + "type": "string" + }, + "VariantId": { + "type": "string" + } + }, + "xml": { + "name": "Binary" + }, + "type": "object" + }, + "PreviewRequest": { + "properties": { + "ItemData": { + "$ref": "#/definitions/RepositoryLocalObject" + }, + "PublishInstruction": { + "$ref": "#/definitions/PublishInstruction" + }, + "TemplateData": { + "$ref": "#/definitions/Template" + } + }, + "xml": { + "name": "PreviewRequest" + }, + "type": "object" + }, + "BinaryContent": { + "properties": { + "$type": { + "example": "BinaryContent", + "type": "string" + }, + "BinaryId": { + "type": "integer", + "format": "int32" + }, + "ExternalBinaryUri": { + "type": "string" + }, + "Filename": { + "type": "string" + }, + "FileSize": { + "type": "integer", + "format": "int32" + }, + "IsExternal": { + "type": "boolean" + }, + "MimeType": { + "type": "string" + }, + "MultimediaType": { + "$ref": "#/definitions/Link" + }, + "Size": { + "type": "integer", + "format": "int32" + }, + "UploadFromFile": { + "type": "string" + } + }, + "xml": { + "name": "BinaryContent" + }, + "type": "object" + }, + "DynamicVersionInfo": { + "properties": { + "$type": { + "example": "DynamicVersionInfo", + "type": "string" + }, + "Revision": { + "type": "integer", + "format": "int32" + }, + "RevisionDate": { + "type": "string", + "format": "date-time" + }, + "Revisor": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "DynamicVersionInfo" + }, + "type": "object" + }, + "FullVersionInfo": { + "properties": { + "$type": { + "example": "FullVersionInfo", + "type": "string" + }, + "CheckOutDate": { + "type": "string", + "format": "date-time" + }, + "CheckOutUser": { + "$ref": "#/definitions/Link" + }, + "CreationDate": { + "type": "string", + "format": "date-time" + }, + "Creator": { + "$ref": "#/definitions/Link" + }, + "IsNew": { + "type": "boolean" + }, + "LastVersion": { + "type": "integer", + "format": "int32" + }, + "LockType": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "CheckedOut", + "Permanent", + "NewItem", + "InWorkflow", + "Reserved" + ] + }, + "Revision": { + "type": "integer", + "format": "int32" + }, + "RevisionDate": { + "type": "string", + "format": "date-time" + }, + "Revisor": { + "$ref": "#/definitions/Link" + }, + "SystemComment": { + "type": "string" + }, + "UserComment": { + "type": "string" + }, + "Version": { + "type": "integer", + "format": "int32" + } + }, + "xml": { + "name": "FullVersionInfo" + }, + "type": "object" + }, + "Template": { + "allOf": [ + { + "$ref": "#/definitions/VersionedItem" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "BinaryContent": { + "$ref": "#/definitions/BinaryContent" + }, + "Content": { + "type": "string" + }, + "ParameterSchema": { + "$ref": "#/definitions/Link" + }, + "TemplateType": { + "type": "string" + } + }, + "type": "object" + } + ], + "xml": { + "name": "Template" + }, + "type": "object" + }, + "SchemaInstance": { + "properties": { + "$type": { + "example": "SchemaInstance", + "type": "string" + }, + "ContainerItem": { + "$ref": "#/definitions/Link" + }, + "Content": { + "additionalProperties": { + "$ref": "#/definitions/FieldDefinition" + }, + "type": "object" + }, + "Metadata": { + "additionalProperties": { + "$ref": "#/definitions/FieldDefinition" + }, + "type": "object" + }, + "Region": { + "$ref": "#/definitions/EmbeddedRegion" + }, + "RegionXml": { + "type": "string" + }, + "Schema": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "SchemaInstance" + }, + "type": "object" + }, + "FieldDefinition": { + "properties": { + "$type": { + "example": "FieldDefinition", + "type": "string" + }, + "Description": { + "type": "string" + }, + "EmbeddedFieldDefinition": { + "additionalProperties": { + "$ref": "#/definitions/FieldDefinition" + }, + "type": "object" + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "FieldDefinitionType": { + "type": "string", + "enum": [ + "Number", + "Date", + "Text", + "Xhtml", + "Embedded", + "ComponentLink", + "ExternalLink", + "KeywordLink" + ] + }, + "Name": { + "type": "string" + }, + "discriminator": { + "type": "string" + } + }, + "discriminator": "FieldDefinitionType", + "xml": { + "name": "FieldDefinition" + }, + "type": "object" + }, + "ComponentPresentation": { + "properties": { + "$type": { + "example": "ComponentPresentation", + "type": "string" + }, + "Component": { + "$ref": "#/definitions/Link" + }, + "ComponentTemplate": { + "$ref": "#/definitions/Link" + }, + "Conditions": { + "items": { + "$ref": "#/definitions/TargetGroupCondition" + }, + "xml": { + "name": "TargetGroupCondition", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "ComponentPresentation" + }, + "type": "object" + }, + "Region": { + "properties": { + "$type": { + "example": "Region", + "type": "string" + }, + "RegionName": { + "type": "string" + } + }, + "xml": { + "name": "Region" + }, + "type": "object" + }, + "TargetGroupCondition": { + "properties": { + "$type": { + "example": "TargetGroupCondition", + "type": "string" + }, + "Negate": { + "type": "boolean" + }, + "TargetGroup": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "TargetGroupCondition" + }, + "type": "object" + }, + "EmbeddedRegion": { + "allOf": [ + { + "$ref": "#/definitions/Region" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "ComponentPresentations": { + "items": { + "$ref": "#/definitions/ComponentPresentation" + }, + "xml": { + "name": "ComponentPresentation", + "wrapped": true + }, + "type": "array" + }, + "Metadata": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "Regions": { + "items": { + "$ref": "#/definitions/Region" + }, + "xml": { + "name": "Region", + "wrapped": true + }, + "type": "array" + }, + "RegionSchema": { + "$ref": "#/definitions/Link" + } + }, + "type": "object" + } + ], + "xml": { + "name": "EmbeddedRegion" + }, + "type": "object" + }, + "RegionDefinition": { + "properties": { + "$type": { + "example": "RegionDefinition", + "type": "string" + }, + "ComponentPresentationConstraints": { + "items": { + "$ref": "#/definitions/ComponentPresentationConstraint" + }, + "xml": { + "name": "ComponentPresentationConstraint", + "wrapped": true + }, + "type": "array" + }, + "DefaultComponentPresentations": { + "items": { + "$ref": "#/definitions/ComponentPresentation" + }, + "xml": { + "name": "ComponentPresentation", + "wrapped": true + }, + "type": "array" + }, + "NestedRegions": { + "items": { + "$ref": "#/definitions/NestedRegion" + }, + "xml": { + "name": "NestedRegion", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "RegionDefinition" + }, + "type": "object" + }, + "ComponentPresentationConstraint": { + "properties": { + "$type": { + "example": "ComponentPresentationConstraint", + "type": "string" + } + }, + "xml": { + "name": "ComponentPresentationConstraint" + }, + "type": "object" + }, + "NestedRegion": { + "properties": { + "$type": { + "example": "NestedRegion", + "type": "string" + }, + "IsMandatory": { + "type": "boolean" + }, + "RegionName": { + "type": "string" + }, + "RegionSchema": { + "$ref": "#/definitions/ExpandableLink" + } + }, + "xml": { + "name": "NestedRegion" + }, + "type": "object" + }, + "ExpandableLink": { + "properties": { + "IdRef": { + "type": "string" + }, + "Title": { + "type": "string" + }, + "$type": { + "example": "ExpandableLink", + "type": "string" + }, + "Description": { + "type": "string" + }, + "ExpandedData": { + "$ref": "#/definitions/IdentifiableObject" + }, + "WebDavUrl": { + "type": "string" + } + }, + "xml": { + "name": "ExpandableLink" + }, + "type": "object" + }, + "Schema": { + "allOf": [ + { + "$ref": "#/definitions/VersionedItem" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "AllowedMultimediaTypes": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "BundleProcess": { + "$ref": "#/definitions/Link" + }, + "ComponentProcess": { + "$ref": "#/definitions/Link" + }, + "DeleteBundleOnProcessFinished": { + "type": "boolean" + }, + "Description": { + "type": "string" + }, + "Fields": { + "additionalProperties": { + "$ref": "#/definitions/FieldDefinition" + }, + "type": "object" + }, + "IsCmsWebSchema": { + "type": "boolean" + }, + "MetadataFields": { + "additionalProperties": { + "$ref": "#/definitions/FieldDefinition" + }, + "type": "object" + }, + "NamespaceUri": { + "type": "string" + }, + "Purpose": { + "type": "string", + "enum": [ + "UnknownByClient", + "Component", + "Multimedia", + "Embedded", + "Metadata", + "Protocol", + "VirtualFolderType", + "TemplateParameters", + "Bundle", + "Region", + "Widget" + ] + }, + "RegionDefinition": { + "$ref": "#/definitions/RegionDefinition" + }, + "RootElementName": { + "type": "string" + }, + "Xsd": { + "type": "string" + } + }, + "type": "object" + } + ], + "xml": { + "name": "Schema" + }, + "type": "object" + }, + "SynchronizationResult": { + "properties": { + "$type": { + "example": "SynchronizationResult", + "type": "string" + }, + "SynchronizationActions": { + "items": { + "$ref": "#/definitions/SynchronizationAction" + }, + "xml": { + "name": "SynchronizationAction", + "wrapped": true + }, + "type": "array" + }, + "SynchronizedItem": { + "$ref": "#/definitions/IdentifiableObject" + } + }, + "xml": { + "name": "SynchronizationResult" + }, + "type": "object" + }, + "SynchronizationAction": { + "properties": { + "$type": { + "example": "SynchronizationAction", + "type": "string" + }, + "FieldDescription": { + "type": "string" + }, + "FieldIndex": { + "type": "integer", + "format": "int32" + }, + "FieldName": { + "type": "string" + }, + "SynchronizationActionApplied": { + "type": "string", + "enum": [ + "Basic", + "FixNamespace", + "RemoveUnknownFields", + "RemoveAdditionalValues", + "ApplyDefaultValuesForMissingMandatoryFields", + "ApplyDefaultValuesForMissingNonMandatoryFields", + "ApplyFilterXsltToXhtmlFields", + "ConvertFieldType", + "All", + "UnknownByClient" + ] + } + }, + "xml": { + "name": "SynchronizationAction" + }, + "type": "object" + }, + "SearchQuery": { + "properties": { + "Title": { + "type": "string" + }, + "$type": { + "example": "SearchQuery", + "type": "string" + }, + "ActivityDefinition": { + "$ref": "#/definitions/Link" + }, + "Author": { + "$ref": "#/definitions/Link" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "BasedOnSchemas": { + "items": { + "$ref": "#/definitions/BasedOnSchema" + }, + "xml": { + "name": "BasedOnSchema", + "wrapped": true + }, + "type": "array" + }, + "BlueprintStatus": { + "type": "string", + "enum": [ + "Unspecified", + "Local", + "Localized", + "Shared" + ] + }, + "Description": { + "type": "string" + }, + "FromRepository": { + "$ref": "#/definitions/Link" + }, + "FullTextQuery": { + "type": "string" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IncludeDescriptionColumn": { + "type": "boolean" + }, + "IncludeLocationInfoColumns": { + "type": "boolean" + }, + "IsDescriptionCaseSensitive": { + "type": "boolean" + }, + "IsPublished": { + "type": "boolean" + }, + "IsTitleCaseSensitive": { + "type": "boolean" + }, + "ItemTypes": { + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Publication", + "Folder", + "StructureGroup", + "Schema", + "Component", + "ComponentTemplate", + "Page", + "PageTemplate", + "TargetGroup", + "Category", + "Keyword", + "TemplateBuildingBlock", + "BusinessProcessType", + "VirtualFolder", + "PublicationTarget", + "TargetType", + "TargetDestination", + "MultimediaType", + "User", + "Group", + "DirectoryService", + "DirectoryGroupMapping", + "Batch", + "MultipleOperations", + "PublishTransaction", + "WorkflowType", + "ApprovalStatus", + "ProcessDefinition", + "ProcessInstance", + "ProcessHistory", + "ActivityDefinition", + "ActivityInstance", + "ActivityHistory", + "WorkItem" + ] + }, + "xml": { + "name": "ItemType", + "wrapped": true + }, + "type": "array" + }, + "LockType": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "CheckedOut", + "Permanent", + "NewItem", + "InWorkflow", + "Reserved" + ] + }, + "LockUser": { + "$ref": "#/definitions/Link" + }, + "ModifiedAfter": { + "type": "string", + "format": "date-time" + }, + "ModifiedBefore": { + "type": "string", + "format": "date-time" + }, + "ProcessDefinition": { + "$ref": "#/definitions/Link" + }, + "ResultLimit": { + "type": "integer", + "format": "int32" + }, + "SearchIn": { + "$ref": "#/definitions/Link" + }, + "SearchInSubtree": { + "type": "boolean" + }, + "UsedKeywords": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "SearchQuery" + }, + "type": "object" + }, + "BasedOnSchema": { + "properties": { + "$type": { + "example": "BasedOnSchema", + "type": "string" + }, + "Field": { + "type": "string" + }, + "FieldValue": { + "type": "string" + }, + "Schema": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "BasedOnSchema" + }, + "type": "object" + }, + "PurgeOldVersionsInstruction": { + "properties": { + "$type": { + "example": "PurgeOldVersionsInstruction", + "type": "string" + }, + "Containers": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "KeepVersionsModifiedAfter": { + "type": "string", + "format": "date-time" + }, + "KeepVersionsWithinDaysBeforeLastCheckIn": { + "type": "integer", + "format": "int32" + }, + "MaxResolvedVersionedItemsCount": { + "type": "integer", + "format": "int32" + }, + "Recursive": { + "type": "boolean" + }, + "VersionsToKeep": { + "type": "integer", + "format": "int32" + } + }, + "xml": { + "name": "PurgeOldVersionsInstruction" + }, + "type": "object" + }, + "CmsLanguageInfo": { + "properties": { + "$type": { + "example": "CmsLanguageInfo", + "type": "string" + }, + "LanguageId": { + "type": "integer", + "format": "int32" + }, + "Name": { + "type": "string" + }, + "NativeName": { + "type": "string" + } + }, + "xml": { + "name": "CmsLanguageInfo" + }, + "type": "object" + }, + "DirectoryServiceUser": { + "properties": { + "$type": { + "example": "DirectoryServiceUser", + "type": "string" + }, + "AdditionalAttributes": { + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + }, + "type": "object" + }, + "AuthenticationType": { + "type": "string" + }, + "DN": { + "type": "string" + }, + "IsAuthenticated": { + "type": "boolean" + } + }, + "xml": { + "name": "DirectoryServiceUser" + }, + "type": "object" + }, + "CmsDirectoryUsersFilter": { + "properties": { + "SubtreeDN": { + "type": "string" + }, + "UserNameSearchMode": { + "type": "string", + "enum": [ + "UserNameOnly", + "FullNameOnly" + ] + }, + "UserNameStartsWith": { + "type": "string" + } + }, + "xml": { + "name": "CmsDirectoryUsersFilter" + }, + "type": "object" + }, + "NotificationMessage": { + "properties": { + "$type": { + "example": "NotificationMessage", + "type": "string" + }, + "Action": { + "type": "string" + }, + "Details": { + "type": "string" + }, + "SubjectIds": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "xml": { + "name": "NotificationMessage" + }, + "type": "object" + }, + "CultureInfo": { + "properties": { + "DisplayName": { + "type": "string" + }, + "EnglishName": { + "type": "string" + }, + "IetfLanguageTag": { + "type": "string" + }, + "IsNeutralCulture": { + "type": "boolean" + }, + "LCID": { + "type": "integer", + "format": "int32" + }, + "Name": { + "type": "string" + }, + "NativeName": { + "type": "string" + }, + "ThreeLetterISOLanguageName": { + "type": "string" + }, + "ThreeLetterWindowsLanguageName": { + "type": "string" + }, + "TwoLetterISOLanguageName": { + "type": "string" + } + }, + "xml": { + "name": "CultureInfo" + }, + "type": "object" + }, + "UserProfile": { + "properties": { + "DisplayName": { + "type": "string" + }, + "$type": { + "example": "UserProfile", + "type": "string" + }, + "Avatar": { + "$ref": "#/definitions/UserAvatarDescriptor" + }, + "Preferences": { + "$ref": "#/definitions/UserPreferences" + }, + "Runtime": { + "$ref": "#/definitions/UserRuntimeInfo" + }, + "User": { + "$ref": "#/definitions/User" + } + }, + "xml": { + "name": "UserProfile" + }, + "type": "object" + }, + "UserAvatarDescriptor": { + "properties": { + "$type": { + "example": "UserAvatarDescriptor", + "type": "string" + }, + "IsDefault": { + "type": "boolean" + }, + "LastModified": { + "type": "string", + "format": "date-time" + }, + "MimeType": { + "type": "string" + }, + "Uri": { + "type": "string" + } + }, + "xml": { + "name": "UserAvatarDescriptor" + }, + "type": "object" + }, + "UserPreferences": { + "properties": { + "$type": { + "example": "UserPreferences", + "type": "string" + }, + "AvatarUri": { + "type": "string" + }, + "Favorites": { + "items": { + "$ref": "#/definitions/FavoriteLink" + }, + "xml": { + "name": "FavoriteLink", + "wrapped": true + }, + "type": "array" + }, + "MaxSearchResults": { + "type": "integer", + "format": "int32" + }, + "StartLocation": { + "type": "string" + } + }, + "xml": { + "name": "UserPreferences" + }, + "type": "object" + }, + "UserRuntimeInfo": { + "properties": { + "$type": { + "example": "UserRuntimeInfo", + "type": "string" + }, + "HasPublishRights": { + "type": "boolean" + }, + "IsAdministrator": { + "type": "boolean" + }, + "IsPermissionManager": { + "type": "boolean" + }, + "IsPublicationAdministrator": { + "type": "boolean" + }, + "IsPublicationManager": { + "type": "boolean" + }, + "IsWorkflowManager": { + "type": "boolean" + }, + "Locale": { + "$ref": "#/definitions/UserLocaleInfo" + } + }, + "xml": { + "name": "UserRuntimeInfo" + }, + "type": "object" + }, + "User": { + "allOf": [ + { + "$ref": "#/definitions/Trustee" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "IsEnabled": { + "type": "boolean" + }, + "IsEnabledEditable": { + "type": "boolean" + }, + "IsPrivilegesEditable": { + "type": "boolean" + }, + "LanguageId": { + "type": "integer", + "format": "int32" + }, + "LocaleId": { + "type": "integer", + "format": "int32" + }, + "Privileges": { + "type": "integer", + "format": "int32" + } + }, + "type": "object" + } + ], + "xml": { + "name": "User" + }, + "type": "object" + }, + "FavoriteLink": { + "properties": { + "IdRef": { + "type": "string" + }, + "Title": { + "type": "string" + }, + "$type": { + "example": "FavoriteLink", + "type": "string" + }, + "Created": { + "type": "string" + }, + "HasChildren": { + "type": "boolean" + }, + "Icon": { + "type": "string" + }, + "Id": { + "type": "string" + }, + "Path": { + "type": "string" + } + }, + "xml": { + "name": "FavoriteLink" + }, + "type": "object" + }, + "UserLocaleInfo": { + "properties": { + "$type": { + "example": "UserLocaleInfo", + "type": "string" + }, + "AmDesignator": { + "type": "string" + }, + "DayNames": { + "type": "object" + }, + "FirstDayOfWeek": { + "type": "string" + }, + "FullDateTimeFormat": { + "type": "string" + }, + "LanguageCode": { + "type": "string" + }, + "LanguageId": { + "type": "string" + }, + "LocaleId": { + "type": "string" + }, + "LongDateFormat": { + "type": "string" + }, + "LongTimeFormat": { + "type": "string" + }, + "MonthNames": { + "type": "object" + }, + "PmDesignator": { + "type": "string" + }, + "ShortDateFormat": { + "type": "string" + }, + "ShortDateTimeFormat": { + "type": "string" + }, + "ShortDayNames": { + "type": "object" + }, + "ShortestDayNames": { + "type": "object" + }, + "ShortMonthNames": { + "type": "object" + }, + "ShortTimeFormat": { + "type": "string" + } + }, + "xml": { + "name": "UserLocaleInfo" + }, + "type": "object" + }, + "GroupMembership": { + "properties": { + "$type": { + "example": "GroupMembership", + "type": "string" + }, + "Group": { + "$ref": "#/definitions/Link" + }, + "Scope": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "GroupMembership" + }, + "type": "object" + }, + "CheckInCheckOutRequest": { + "properties": { + "SetOrRemovePermanentLock": { + "type": "boolean" + }, + "UserComment": { + "type": "string" + } + }, + "xml": { + "name": "CheckInCheckOutRequest" + }, + "type": "object" + }, + "VersionedItem": { + "allOf": [ + { + "$ref": "#/definitions/RepositoryLocalObject" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "DynamicVersionInfo": { + "$ref": "#/definitions/DynamicVersionInfo" + }, + "VersionInfo": { + "$ref": "#/definitions/FullVersionInfo" + } + }, + "type": "object" + } + ], + "xml": { + "name": "VersionedItem" + }, + "type": "object" + }, + "RollBackRequest": { + "properties": { + "DeleteNewerVersions": { + "type": "boolean" + }, + "UserComment": { + "type": "string" + } + }, + "xml": { + "name": "RollBackRequest" + }, + "type": "object" + }, + "WorkItem": { + "allOf": [ + { + "$ref": "#/definitions/WorkflowObject" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "Activity": { + "$ref": "#/definitions/Link" + }, + "Comment": { + "type": "string" + }, + "Owner": { + "$ref": "#/definitions/Link" + }, + "Process": { + "$ref": "#/definitions/Link" + }, + "Subject": { + "$ref": "#/definitions/Link" + }, + "SubjectOwningRepository": { + "$ref": "#/definitions/Link" + } + }, + "type": "object" + } + ], + "xml": { + "name": "WorkItem" + }, + "type": "object" + }, + "StartWorkflowInstruction": { + "properties": { + "ActivityTitle": { + "type": "string" + }, + "Assignee": { + "$ref": "#/definitions/Link" + }, + "DueDate": { + "type": "string", + "format": "date-time" + }, + "ProcessDefinition": { + "$ref": "#/definitions/Link" + }, + "ProcessInstanceTitle": { + "type": "string" + }, + "Subjects": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "WorkflowType": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "StartWorkflowInstruction" + }, + "type": "object" + }, + "Activity": { + "allOf": [ + { + "$ref": "#/definitions/WorkflowObject" + }, + { + "properties": { + "Assignee": { + "$ref": "#/definitions/Link" + }, + "AssignmentDate": { + "type": "string", + "format": "date-time" + }, + "DueDate": { + "type": "string", + "format": "date-time" + }, + "FinishDate": { + "type": "string", + "format": "date-time" + }, + "FinishMessage": { + "type": "string" + }, + "Owner": { + "$ref": "#/definitions/Link" + }, + "Performers": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "Position": { + "type": "integer", + "format": "int32" + }, + "Process": { + "$ref": "#/definitions/Link" + }, + "StartDate": { + "type": "string", + "format": "date-time" + }, + "SuspendDate": { + "type": "string", + "format": "date-time" + }, + "WorkItems": { + "items": { + "$ref": "#/definitions/WorkItem" + }, + "xml": { + "name": "WorkItem", + "wrapped": true + }, + "type": "array" + } + }, + "type": "object" + } + ], + "xml": { + "name": "Activity" + }, + "type": "object" + }, + "ProcessInstance": { + "allOf": [ + { + "$ref": "#/definitions/Process" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "ProcessDefinition": { + "$ref": "#/definitions/Link" + }, + "Variables": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + } + ], + "xml": { + "name": "ProcessInstance" + }, + "type": "object" + }, + "ProcessHistory": { + "allOf": [ + { + "$ref": "#/definitions/Process" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "FinishDate": { + "type": "string", + "format": "date-time" + }, + "FinishReason": { + "type": "string", + "enum": [ + "UnknownByClient", + "CompletedNormally", + "ForceFinished", + "Terminated" + ] + }, + "ProcessDefinitionTitle": { + "type": "string" + } + }, + "type": "object" + } + ], + "xml": { + "name": "ProcessHistory" + }, + "type": "object" + }, + "WorkflowScriptType": { + "properties": { + "Title": { + "type": "string" + }, + "Name": { + "type": "string" + } + }, + "xml": { + "name": "WorkflowScriptType" + }, + "type": "object" + }, + "ProcessDefinitionsRequest": { + "properties": { + "ItemIds": { + "items": { + "type": "string" + }, + "type": "array" + }, + "ProcessDefinitionType": { + "type": "string", + "enum": [ + "UnknownByClient", + "Editing", + "Bundle" + ] + } + }, + "xml": { + "name": "ProcessDefinitionsRequest" + }, + "type": "object" + }, + "PurgeWorkflowHistoryInstruction": { + "properties": { + "DeleteHistoryBefore": { + "type": "string", + "format": "date-time" + }, + "Publication": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "PurgeWorkflowHistoryInstruction" + }, + "type": "object" + }, + "ActivityInstance": { + "allOf": [ + { + "$ref": "#/definitions/Activity" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "ActivityConstraints": { + "type": "string", + "enum": [ + "None", + "DenyBundleMetadataEditing", + "DenySubjectEditing", + "DenyAddRemoveWorkItem", + "UnknownByClient" + ] + }, + "ActivityDefinition": { + "$ref": "#/definitions/Link" + }, + "ActivityState": { + "type": "string", + "enum": [ + "Assigned", + "Started", + "Failed", + "Finished", + "Suspended", + "WaitingForWorkflowAgent", + "UnknownByClient" + ] + }, + "IsExpirationExecution": { + "type": "boolean" + }, + "ResumeBookmark": { + "type": "string" + }, + "SuspendOrFailReason": { + "type": "string" + } + }, + "type": "object" + } + ], + "xml": { + "name": "ActivityInstance" + }, + "type": "object" + }, + "SuspendAndResumeActivityRequest": { + "properties": { + "Reason": { + "type": "string" + }, + "ResumeAt": { + "type": "string", + "format": "date-time" + }, + "ResumeBookmark": { + "type": "string" + } + }, + "xml": { + "name": "SuspendAndResumeActivityRequest" + }, + "type": "object" + }, + "ActivityFinishRequest": { + "properties": { + "Message": { + "type": "string" + }, + "NextActivityDueDate": { + "type": "string", + "format": "date-time" + }, + "NextActivityTitle": { + "type": "string" + }, + "NextAssignee": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "ActivityFinishRequest" + }, + "type": "object" + }, + "Filter": { + "properties": { + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "SortExpression": { + "type": "string" + }, + "discriminator": { + "type": "string" + } + }, + "discriminator": "FilterType", + "xml": { + "name": "Filter" + }, + "type": "object" + }, + "StronglyTypedFilter": { + "properties": { + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "StronglyTypedFilter" + }, + "type": "object" + }, + "WhereUsedFilter": { + "properties": { + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "InRepository": { + "$ref": "#/definitions/Link" + }, + "ItemTypes": { + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Publication", + "Folder", + "StructureGroup", + "Schema", + "Component", + "ComponentTemplate", + "Page", + "PageTemplate", + "TargetGroup", + "Category", + "Keyword", + "TemplateBuildingBlock", + "BusinessProcessType", + "VirtualFolder", + "PublicationTarget", + "TargetType", + "TargetDestination", + "MultimediaType", + "User", + "Group", + "DirectoryService", + "DirectoryGroupMapping", + "Batch", + "MultipleOperations", + "PublishTransaction", + "WorkflowType", + "ApprovalStatus", + "ProcessDefinition", + "ProcessInstance", + "ProcessHistory", + "ActivityDefinition", + "ActivityInstance", + "ActivityHistory", + "WorkItem" + ] + }, + "xml": { + "name": "ItemType", + "wrapped": true + }, + "type": "array" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "WhereUsedFilter" + }, + "type": "object" + }, + "ActivityInstancesFilter": { + "properties": { + "$type": { + "example": "ActivityInstancesFilter", + "type": "string" + }, + "ActivityState": { + "type": "string", + "enum": [ + "Assigned", + "Started", + "Failed", + "Finished", + "Suspended", + "WaitingForWorkflowAgent", + "UnknownByClient" + ] + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ContextRepository": { + "$ref": "#/definitions/Link" + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "ForAllUsers": { + "type": "boolean" + }, + "IncludeAdditionalDateColumns": { + "type": "boolean" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IncludeWorkItems": { + "type": "boolean" + }, + "ProcessDefinition": { + "$ref": "#/definitions/Link" + }, + "SortExpression": { + "type": "string" + }, + "WorkflowType": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "ActivityInstancesFilter" + }, + "type": "object" + }, + "ApprovalStatusesFilter": { + "properties": { + "$type": { + "example": "ApprovalStatusesFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "ApprovalStatusesFilter" + }, + "type": "object" + }, + "ProcessDefinitionAssociationsFilter": { + "properties": { + "$type": { + "example": "ProcessDefinitionAssociationsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ContextRepository": { + "$ref": "#/definitions/Link" + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "ProcessDefinition": { + "$ref": "#/definitions/Link" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "ProcessDefinitionAssociationsFilter" + }, + "type": "object" + }, + "ProcessDefinitionsFilter": { + "properties": { + "$type": { + "example": "ProcessDefinitionsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ContextRepository": { + "$ref": "#/definitions/Link" + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "ProcessDefinitionsFilter" + }, + "type": "object" + }, + "ProcessesFilter": { + "properties": { + "$type": { + "example": "ProcessesFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "ForPerformer": { + "$ref": "#/definitions/Link" + }, + "ForProcessDefinition": { + "$ref": "#/definitions/Link" + }, + "ForRepository": { + "$ref": "#/definitions/Link" + }, + "ForSubject": { + "$ref": "#/definitions/Link" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IncludeSubjectsColumn": { + "type": "boolean" + }, + "IncludeWorkflowTypeColumns": { + "type": "boolean" + }, + "LegacyMode": { + "type": "boolean" + }, + "ProcessType": { + "type": "string", + "enum": [ + "Any", + "Active", + "Historical", + "UnknownByClient" + ] + }, + "SortExpression": { + "type": "string" + }, + "WorkflowType": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "ProcessesFilter" + }, + "type": "object" + }, + "UserWorkItemsFilter": { + "properties": { + "$type": { + "example": "UserWorkItemsFilter", + "type": "string" + }, + "ActivityState": { + "type": "string", + "enum": [ + "Assigned", + "Started", + "Failed", + "Finished", + "Suspended", + "WaitingForWorkflowAgent", + "UnknownByClient" + ] + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ContextRepository": { + "$ref": "#/definitions/Link" + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + }, + "Subject": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "UserWorkItemsFilter" + }, + "type": "object" + }, + "WorkflowManagerFilter": { + "properties": { + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "WorkflowManagerFilter" + }, + "type": "object" + }, + "WorkflowTypesFilter": { + "properties": { + "$type": { + "example": "WorkflowTypesFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "WorkflowTypesFilter" + }, + "type": "object" + }, + "ClaimMappingsFilter": { + "properties": { + "$type": { + "example": "ClaimMappingsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "ForGroup": { + "$ref": "#/definitions/Link" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "ClaimMappingsFilter" + }, + "type": "object" + }, + "GroupMembersFilter": { + "properties": { + "$type": { + "example": "GroupMembersFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ContextRepository": { + "$ref": "#/definitions/Link" + }, + "ExcludeDisabledTrustees": { + "type": "boolean" + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "Recursive": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "GroupMembersFilter" + }, + "type": "object" + }, + "GroupsFilter": { + "properties": { + "$type": { + "example": "GroupsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "ForRepository": { + "$ref": "#/definitions/Link" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IsPredefined": { + "type": "boolean" + }, + "ItemType": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Publication", + "Folder", + "StructureGroup", + "Schema", + "Component", + "ComponentTemplate", + "Page", + "PageTemplate", + "TargetGroup", + "Category", + "Keyword", + "TemplateBuildingBlock", + "BusinessProcessType", + "VirtualFolder", + "PublicationTarget", + "TargetType", + "TargetDestination", + "MultimediaType", + "User", + "Group", + "DirectoryService", + "DirectoryGroupMapping", + "Batch", + "MultipleOperations", + "PublishTransaction", + "WorkflowType", + "ApprovalStatus", + "ProcessDefinition", + "ProcessInstance", + "ProcessHistory", + "ActivityDefinition", + "ActivityInstance", + "ActivityHistory", + "WorkItem" + ] + }, + "Name": { + "type": "string" + }, + "NameSearchMode": { + "type": "string", + "enum": [ + "Contains", + "StartsWith", + "EndsWith", + "ExactMatch" + ] + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "GroupsFilter" + }, + "type": "object" + }, + "TrusteesFilter": { + "properties": { + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IsPredefined": { + "type": "boolean" + }, + "ItemType": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Publication", + "Folder", + "StructureGroup", + "Schema", + "Component", + "ComponentTemplate", + "Page", + "PageTemplate", + "TargetGroup", + "Category", + "Keyword", + "TemplateBuildingBlock", + "BusinessProcessType", + "VirtualFolder", + "PublicationTarget", + "TargetType", + "TargetDestination", + "MultimediaType", + "User", + "Group", + "DirectoryService", + "DirectoryGroupMapping", + "Batch", + "MultipleOperations", + "PublishTransaction", + "WorkflowType", + "ApprovalStatus", + "ProcessDefinition", + "ProcessInstance", + "ProcessHistory", + "ActivityDefinition", + "ActivityInstance", + "ActivityHistory", + "WorkItem" + ] + }, + "Name": { + "type": "string" + }, + "NameSearchMode": { + "type": "string", + "enum": [ + "Contains", + "StartsWith", + "EndsWith", + "ExactMatch" + ] + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "TrusteesFilter" + }, + "type": "object" + }, + "UsersFilter": { + "properties": { + "$type": { + "example": "UsersFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IsPredefined": { + "type": "boolean" + }, + "ItemType": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Publication", + "Folder", + "StructureGroup", + "Schema", + "Component", + "ComponentTemplate", + "Page", + "PageTemplate", + "TargetGroup", + "Category", + "Keyword", + "TemplateBuildingBlock", + "BusinessProcessType", + "VirtualFolder", + "PublicationTarget", + "TargetType", + "TargetDestination", + "MultimediaType", + "User", + "Group", + "DirectoryService", + "DirectoryGroupMapping", + "Batch", + "MultipleOperations", + "PublishTransaction", + "WorkflowType", + "ApprovalStatus", + "ProcessDefinition", + "ProcessInstance", + "ProcessHistory", + "ActivityDefinition", + "ActivityInstance", + "ActivityHistory", + "WorkItem" + ] + }, + "Name": { + "type": "string" + }, + "NameSearchMode": { + "type": "string", + "enum": [ + "Contains", + "StartsWith", + "EndsWith", + "ExactMatch" + ] + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "UsersFilter" + }, + "type": "object" + }, + "PublishedItemsFilter": { + "properties": { + "$type": { + "example": "PublishedItemsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "ForPublication": { + "$ref": "#/definitions/Link" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IncludePathColumn": { + "type": "boolean" + }, + "IncludeTemplates": { + "type": "boolean" + }, + "PublicationTarget": { + "$ref": "#/definitions/Link" + }, + "Purpose": { + "type": "string" + }, + "ResultLimit": { + "type": "integer", + "format": "int32" + }, + "SortExpression": { + "type": "string" + }, + "TargetType": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "PublishedItemsFilter" + }, + "type": "object" + }, + "PublishingListFilter": { + "properties": { + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "PublishingListFilter" + }, + "type": "object" + }, + "BlueprintChainFilter": { + "properties": { + "$type": { + "example": "BlueprintChainFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "Direction": { + "type": "string", + "enum": [ + "Up", + "Down" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IncludeWebDavUrlColumn": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "BlueprintChainFilter" + }, + "type": "object" + }, + "BlueprintFilter": { + "properties": { + "$type": { + "example": "BlueprintFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "ForItem": { + "$ref": "#/definitions/Link" + }, + "ForRepository": { + "$ref": "#/definitions/Link" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IncludeWebDavUrlColumn": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "BlueprintFilter" + }, + "type": "object" + }, + "BlueprintNodesFilter": { + "properties": { + "$type": { + "example": "BlueprintNodesFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "ForItem": { + "$ref": "#/definitions/Link" + }, + "ForRepository": { + "$ref": "#/definitions/Link" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IncludeWebDavUrlColumn": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "BlueprintNodesFilter" + }, + "type": "object" + }, + "BlueprintParentsFilter": { + "properties": { + "$type": { + "example": "BlueprintParentsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "CurrentParents": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "ForRepository": { + "$ref": "#/definitions/Link" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "BlueprintParentsFilter" + }, + "type": "object" + }, + "BundleSchemasFilter": { + "properties": { + "$type": { + "example": "BundleSchemasFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "OnlyApplicableBundles": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "BundleSchemasFilter" + }, + "type": "object" + }, + "CategoriesFilter": { + "properties": { + "$type": { + "example": "CategoriesFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IsRoot": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "CategoriesFilter" + }, + "type": "object" + }, + "CategoryRelatedFilter": { + "properties": { + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "CategoryRelatedFilter" + }, + "type": "object" + }, + "ChildCategoriesFilter": { + "properties": { + "$type": { + "example": "ChildCategoriesFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IsRoot": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "ChildCategoriesFilter" + }, + "type": "object" + }, + "ChildKeywordsFilter": { + "properties": { + "$type": { + "example": "ChildKeywordsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "InCategory": { + "$ref": "#/definitions/Link" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IsAbstract": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "ChildKeywordsFilter" + }, + "type": "object" + }, + "ClassifiedItemsFilter": { + "properties": { + "$type": { + "example": "ClassifiedItemsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "BasedOnSchemas": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "ItemTypes": { + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Publication", + "Folder", + "StructureGroup", + "Schema", + "Component", + "ComponentTemplate", + "Page", + "PageTemplate", + "TargetGroup", + "Category", + "Keyword", + "TemplateBuildingBlock", + "BusinessProcessType", + "VirtualFolder", + "PublicationTarget", + "TargetType", + "TargetDestination", + "MultimediaType", + "User", + "Group", + "DirectoryService", + "DirectoryGroupMapping", + "Batch", + "MultipleOperations", + "PublishTransaction", + "WorkflowType", + "ApprovalStatus", + "ProcessDefinition", + "ProcessInstance", + "ProcessHistory", + "ActivityDefinition", + "ActivityInstance", + "ActivityHistory", + "WorkItem" + ] + }, + "xml": { + "name": "ItemType", + "wrapped": true + }, + "type": "array" + }, + "ResolveDescendantKeywords": { + "type": "boolean" + }, + "ResultLimit": { + "type": "integer", + "format": "int32" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "ClassifiedItemsFilter" + }, + "type": "object" + }, + "DeletedReferencesFilter": { + "properties": { + "$type": { + "example": "DeletedReferencesFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "DeletedReferencesFilter" + }, + "type": "object" + }, + "DescendantKeywordsFilter": { + "properties": { + "$type": { + "example": "DescendantKeywordsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "InContextRepositoryOnly": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "DescendantKeywordsFilter" + }, + "type": "object" + }, + "ItemsFilter": { + "properties": { + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ComponentTypes": { + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "Normal", + "Multimedia", + "Widget" + ] + }, + "xml": { + "name": "ComponentType", + "wrapped": true + }, + "type": "array" + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IncludeDescriptionColumn": { + "type": "boolean" + }, + "IncludeRelativeWebDavUrlColumn": { + "type": "boolean" + }, + "ItemTypes": { + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Publication", + "Folder", + "StructureGroup", + "Schema", + "Component", + "ComponentTemplate", + "Page", + "PageTemplate", + "TargetGroup", + "Category", + "Keyword", + "TemplateBuildingBlock", + "BusinessProcessType", + "VirtualFolder", + "PublicationTarget", + "TargetType", + "TargetDestination", + "MultimediaType", + "User", + "Group", + "DirectoryService", + "DirectoryGroupMapping", + "Batch", + "MultipleOperations", + "PublishTransaction", + "WorkflowType", + "ApprovalStatus", + "ProcessDefinition", + "ProcessInstance", + "ProcessHistory", + "ActivityDefinition", + "ActivityInstance", + "ActivityHistory", + "WorkItem" + ] + }, + "xml": { + "name": "ItemType", + "wrapped": true + }, + "type": "array" + }, + "LockFilter": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "CheckedOut", + "Permanent", + "NewItem", + "InWorkflow", + "Reserved" + ] + }, + "LockResult": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "CheckedOut", + "Permanent", + "NewItem", + "InWorkflow", + "Reserved" + ] + }, + "Recursive": { + "type": "boolean" + }, + "SchemaPurposes": { + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "Component", + "Multimedia", + "Embedded", + "Metadata", + "Protocol", + "VirtualFolderType", + "TemplateParameters", + "Bundle", + "Region", + "Widget" + ] + }, + "xml": { + "name": "SchemaPurpose", + "wrapped": true + }, + "type": "array" + }, + "ShowDynamicVersionIfReadableByUser": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "ItemsFilter" + }, + "type": "object" + }, + "KeywordRelatedFilter": { + "properties": { + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "KeywordRelatedFilter" + }, + "type": "object" + }, + "KeywordsFilter": { + "properties": { + "$type": { + "example": "KeywordsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IsAbstract": { + "type": "boolean" + }, + "IsRoot": { + "type": "boolean" + }, + "ResultLimit": { + "type": "integer", + "format": "int32" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "KeywordsFilter" + }, + "type": "object" + }, + "MultimediaTypesFilter": { + "properties": { + "$type": { + "example": "MultimediaTypesFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "MultimediaTypesFilter" + }, + "type": "object" + }, + "OrganizationalItemAncestorsFilter": { + "properties": { + "$type": { + "example": "OrganizationalItemAncestorsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IncludePublishLocationColumns": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "OrganizationalItemAncestorsFilter" + }, + "type": "object" + }, + "OrganizationalItemItemsFilter": { + "properties": { + "$type": { + "example": "OrganizationalItemItemsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "BasedOnSchemas": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "ComponentTypes": { + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "Normal", + "Multimedia", + "Widget" + ] + }, + "xml": { + "name": "ComponentType", + "wrapped": true + }, + "type": "array" + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "FailIfNoAccessToItems": { + "type": "boolean" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IncludeDescriptionColumn": { + "type": "boolean" + }, + "IncludePathColumn": { + "type": "boolean" + }, + "IncludeRelativeWebDavUrlColumn": { + "type": "boolean" + }, + "ItemTypes": { + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Publication", + "Folder", + "StructureGroup", + "Schema", + "Component", + "ComponentTemplate", + "Page", + "PageTemplate", + "TargetGroup", + "Category", + "Keyword", + "TemplateBuildingBlock", + "BusinessProcessType", + "VirtualFolder", + "PublicationTarget", + "TargetType", + "TargetDestination", + "MultimediaType", + "User", + "Group", + "DirectoryService", + "DirectoryGroupMapping", + "Batch", + "MultipleOperations", + "PublishTransaction", + "WorkflowType", + "ApprovalStatus", + "ProcessDefinition", + "ProcessInstance", + "ProcessHistory", + "ActivityDefinition", + "ActivityInstance", + "ActivityHistory", + "WorkItem" + ] + }, + "xml": { + "name": "ItemType", + "wrapped": true + }, + "type": "array" + }, + "LockFilter": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "CheckedOut", + "Permanent", + "NewItem", + "InWorkflow", + "Reserved" + ] + }, + "LockResult": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "CheckedOut", + "Permanent", + "NewItem", + "InWorkflow", + "Reserved" + ] + }, + "NotBasedOnSchema": { + "$ref": "#/definitions/Link" + }, + "Recursive": { + "type": "boolean" + }, + "SchemaPurposes": { + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "Component", + "Multimedia", + "Embedded", + "Metadata", + "Protocol", + "VirtualFolderType", + "TemplateParameters", + "Bundle", + "Region", + "Widget" + ] + }, + "xml": { + "name": "SchemaPurpose", + "wrapped": true + }, + "type": "array" + }, + "ShowDynamicVersionIfReadableByUser": { + "type": "boolean" + }, + "ShowNewItems": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + }, + "TemplateTypeIds": { + "items": { + "type": "integer", + "format": "int32" + }, + "type": "array" + } + }, + "xml": { + "name": "OrganizationalItemItemsFilter" + }, + "type": "object" + }, + "OrganizationalItemsFilter": { + "properties": { + "$type": { + "example": "OrganizationalItemsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExcludeTrustees": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IncludePathColumn": { + "type": "boolean" + }, + "IncludeRelativeWebDavUrlColumn": { + "type": "boolean" + }, + "IncludeTrustees": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "ItemTypes": { + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Publication", + "Folder", + "StructureGroup", + "Schema", + "Component", + "ComponentTemplate", + "Page", + "PageTemplate", + "TargetGroup", + "Category", + "Keyword", + "TemplateBuildingBlock", + "BusinessProcessType", + "VirtualFolder", + "PublicationTarget", + "TargetType", + "TargetDestination", + "MultimediaType", + "User", + "Group", + "DirectoryService", + "DirectoryGroupMapping", + "Batch", + "MultipleOperations", + "PublishTransaction", + "WorkflowType", + "ApprovalStatus", + "ProcessDefinition", + "ProcessInstance", + "ProcessHistory", + "ActivityDefinition", + "ActivityInstance", + "ActivityHistory", + "WorkItem" + ] + }, + "xml": { + "name": "ItemType", + "wrapped": true + }, + "type": "array" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "OrganizationalItemsFilter" + }, + "type": "object" + }, + "OrphanKeywordsFilter": { + "properties": { + "$type": { + "example": "OrphanKeywordsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "RootCategory": { + "$ref": "#/definitions/Link" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "OrphanKeywordsFilter" + }, + "type": "object" + }, + "PathToCategoryFilter": { + "properties": { + "$type": { + "example": "PathToCategoryFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "PathToCategoryFilter" + }, + "type": "object" + }, + "RepositoriesFilter": { + "properties": { + "$type": { + "example": "RepositoriesFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IncludeAllPublicationsForGroupManagement": { + "type": "boolean" + }, + "IncludeRootOrganizationalItemsColumns": { + "type": "boolean" + }, + "IncludeWebDavUrlColumn": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "RepositoriesFilter" + }, + "type": "object" + }, + "RepositoryItemsFilter": { + "properties": { + "$type": { + "example": "RepositoryItemsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ComponentTypes": { + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "Normal", + "Multimedia", + "Widget" + ] + }, + "xml": { + "name": "ComponentType", + "wrapped": true + }, + "type": "array" + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IncludeDescriptionColumn": { + "type": "boolean" + }, + "IncludeRelativeWebDavUrlColumn": { + "type": "boolean" + }, + "ItemTypes": { + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Publication", + "Folder", + "StructureGroup", + "Schema", + "Component", + "ComponentTemplate", + "Page", + "PageTemplate", + "TargetGroup", + "Category", + "Keyword", + "TemplateBuildingBlock", + "BusinessProcessType", + "VirtualFolder", + "PublicationTarget", + "TargetType", + "TargetDestination", + "MultimediaType", + "User", + "Group", + "DirectoryService", + "DirectoryGroupMapping", + "Batch", + "MultipleOperations", + "PublishTransaction", + "WorkflowType", + "ApprovalStatus", + "ProcessDefinition", + "ProcessInstance", + "ProcessHistory", + "ActivityDefinition", + "ActivityInstance", + "ActivityHistory", + "WorkItem" + ] + }, + "xml": { + "name": "ItemType", + "wrapped": true + }, + "type": "array" + }, + "LockFilter": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "CheckedOut", + "Permanent", + "NewItem", + "InWorkflow", + "Reserved" + ] + }, + "LockResult": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "CheckedOut", + "Permanent", + "NewItem", + "InWorkflow", + "Reserved" + ] + }, + "Recursive": { + "type": "boolean" + }, + "SchemaPurposes": { + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "Component", + "Multimedia", + "Embedded", + "Metadata", + "Protocol", + "VirtualFolderType", + "TemplateParameters", + "Bundle", + "Region", + "Widget" + ] + }, + "xml": { + "name": "SchemaPurpose", + "wrapped": true + }, + "type": "array" + }, + "ShowDynamicVersionIfReadableByUser": { + "type": "boolean" + }, + "ShowNewItems": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "RepositoryItemsFilter" + }, + "type": "object" + }, + "RepositoryLocalObjectsFilter": { + "properties": { + "$type": { + "example": "RepositoryLocalObjectsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "BasedOnSchemas": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "ComponentTypes": { + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "Normal", + "Multimedia", + "Widget" + ] + }, + "xml": { + "name": "ComponentType", + "wrapped": true + }, + "type": "array" + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IncludeDescriptionColumn": { + "type": "boolean" + }, + "IncludeDynamicVersionInfoColumns": { + "type": "boolean" + }, + "IncludeLocationInfoColumns": { + "type": "boolean" + }, + "IncludeLockUserColumn": { + "type": "boolean" + }, + "IncludeRelativeWebDavUrlColumn": { + "type": "boolean" + }, + "ItemIds": { + "items": { + "type": "string" + }, + "type": "array" + }, + "ItemTypes": { + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Publication", + "Folder", + "StructureGroup", + "Schema", + "Component", + "ComponentTemplate", + "Page", + "PageTemplate", + "TargetGroup", + "Category", + "Keyword", + "TemplateBuildingBlock", + "BusinessProcessType", + "VirtualFolder", + "PublicationTarget", + "TargetType", + "TargetDestination", + "MultimediaType", + "User", + "Group", + "DirectoryService", + "DirectoryGroupMapping", + "Batch", + "MultipleOperations", + "PublishTransaction", + "WorkflowType", + "ApprovalStatus", + "ProcessDefinition", + "ProcessInstance", + "ProcessHistory", + "ActivityDefinition", + "ActivityInstance", + "ActivityHistory", + "WorkItem" + ] + }, + "xml": { + "name": "ItemType", + "wrapped": true + }, + "type": "array" + }, + "LockFilter": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "CheckedOut", + "Permanent", + "NewItem", + "InWorkflow", + "Reserved" + ] + }, + "LockResult": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "CheckedOut", + "Permanent", + "NewItem", + "InWorkflow", + "Reserved" + ] + }, + "LockUser": { + "$ref": "#/definitions/Link" + }, + "SchemaPurposes": { + "items": { + "type": "string", + "enum": [ + "UnknownByClient", + "Component", + "Multimedia", + "Embedded", + "Metadata", + "Protocol", + "VirtualFolderType", + "TemplateParameters", + "Bundle", + "Region", + "Widget" + ] + }, + "xml": { + "name": "SchemaPurpose", + "wrapped": true + }, + "type": "array" + }, + "SortExpression": { + "type": "string" + }, + "TemplateTypeIds": { + "items": { + "type": "integer", + "format": "int32" + }, + "type": "array" + }, + "UseDynamicVersion": { + "type": "boolean" + } + }, + "xml": { + "name": "RepositoryLocalObjectsFilter" + }, + "type": "object" + }, + "TaxonomiesFilter": { + "properties": { + "$type": { + "example": "TaxonomiesFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "ForItems": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + }, + "UseForNavigation": { + "type": "boolean" + } + }, + "xml": { + "name": "TaxonomiesFilter" + }, + "type": "object" + }, + "TaxonomiesOwlFilter": { + "properties": { + "$type": { + "example": "TaxonomiesOwlFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "ForItems": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "RootCategories": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "SortExpression": { + "type": "string" + }, + "UseForNavigation": { + "type": "boolean" + } + }, + "xml": { + "name": "TaxonomiesOwlFilter" + }, + "type": "object" + }, + "VersionsFilter": { + "properties": { + "$type": { + "example": "VersionsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IncludeRevisorDescriptionColumn": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "VersionsFilter" + }, + "type": "object" + }, + "ComponentTemplatesFilter": { + "properties": { + "$type": { + "example": "ComponentTemplatesFilter", + "type": "string" + }, + "AllowedOnPage": { + "type": "boolean" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "RelatedTo": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "ComponentTemplatesFilter" + }, + "type": "object" + }, + "PublicationsFilter": { + "properties": { + "$type": { + "example": "PublicationsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IncludeAllPublicationsForGroupManagement": { + "type": "boolean" + }, + "IncludeRootOrganizationalItemsColumns": { + "type": "boolean" + }, + "IncludeWebDavUrlColumn": { + "type": "boolean" + }, + "PublicationTypeName": { + "type": "string" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "PublicationsFilter" + }, + "type": "object" + }, + "PublicationTargetsFilter": { + "properties": { + "$type": { + "example": "PublicationTargetsFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "IncludeEmulated": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "PublicationTargetsFilter" + }, + "type": "object" + }, + "TargetTypesFilter": { + "properties": { + "$type": { + "example": "TargetTypesFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "ForRepository": { + "$ref": "#/definitions/Link" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "TargetTypesFilter" + }, + "type": "object" + }, + "BatchesFilter": { + "properties": { + "$type": { + "example": "BatchesFilter", + "type": "string" + }, + "BaseColumns": { + "type": "string", + "enum": [ + "Id", + "IdAndTitle", + "Default", + "Extended" + ] + }, + "ExtensionProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "IncludeAllowedActionsColumns": { + "type": "boolean" + }, + "SortExpression": { + "type": "string" + } + }, + "xml": { + "name": "BatchesFilter" + }, + "type": "object" + }, + "RegisteredType": { + "allOf": [ + { + "$ref": "#/definitions/SystemWideObject" + }, + { + "properties": { + "Name": { + "type": "string" + } + }, + "type": "object" + } + ], + "xml": { + "name": "RegisteredType" + }, + "type": "object" + }, + "SystemWideObject": { + "allOf": [ + { + "$ref": "#/definitions/IdentifiableObject" + }, + { + "properties": {}, + "type": "object" + } + ], + "xml": { + "name": "SystemWideObject" + }, + "type": "object" + }, + "ActivityDefinition": { + "allOf": [ + { + "$ref": "#/definitions/WorkflowObject" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "ActivityConstraints": { + "type": "string", + "enum": [ + "None", + "DenyBundleMetadataEditing", + "DenySubjectEditing", + "DenyAddRemoveWorkItem", + "UnknownByClient" + ] + }, + "Assignee": { + "$ref": "#/definitions/Link" + }, + "Description": { + "type": "string" + }, + "ProcessDefinition": { + "$ref": "#/definitions/Link" + } + }, + "type": "object" + } + ], + "xml": { + "name": "ActivityDefinition" + }, + "type": "object" + }, + "ActivityHistory": { + "allOf": [ + { + "$ref": "#/definitions/Activity" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "ActivityDefinitionTitle": { + "type": "string" + }, + "ActivityType": { + "type": "string", + "enum": [ + "Normal", + "Decision", + "UnknownByClient" + ] + }, + "ApprovalStatus": { + "$ref": "#/definitions/Link" + }, + "Description": { + "type": "string" + } + }, + "type": "object" + } + ], + "xml": { + "name": "ActivityHistory" + }, + "type": "object" + }, + "ApprovalStatus": { + "allOf": [ + { + "$ref": "#/definitions/SystemWideObject" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "IsDeleted": { + "type": "boolean" + }, + "Position": { + "type": "integer", + "format": "int32" + } + }, + "type": "object" + } + ], + "xml": { + "name": "ApprovalStatus" + }, + "type": "object" + }, + "Process": { + "allOf": [ + { + "$ref": "#/definitions/WorkflowObject" + }, + { + "properties": { + "Activities": { + "items": { + "$ref": "#/definitions/Activity" + }, + "xml": { + "name": "Activity", + "wrapped": true + }, + "type": "array" + }, + "Creator": { + "$ref": "#/definitions/Link" + }, + "HasSnapshots": { + "type": "boolean" + }, + "Subjects": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "WorkflowType": { + "$ref": "#/definitions/Link" + } + }, + "type": "object" + } + ], + "xml": { + "name": "Process" + }, + "type": "object" + }, + "ProcessDefinition": { + "allOf": [ + { + "$ref": "#/definitions/RepositoryLocalObject" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "ActivityDefinitions": { + "items": { + "$ref": "#/definitions/ActivityDefinition" + }, + "xml": { + "name": "ActivityDefinition", + "wrapped": true + }, + "type": "array" + }, + "StoreSnapshot": { + "type": "boolean" + } + }, + "type": "object" + } + ], + "xml": { + "name": "ProcessDefinition" + }, + "type": "object" + }, + "ProcessDefinitionAssociation": { + "allOf": [ + { + "$ref": "#/definitions/IdentifiableObject" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "ProcessDefinition": { + "$ref": "#/definitions/Link" + } + }, + "type": "object" + } + ], + "xml": { + "name": "ProcessDefinitionAssociation" + }, + "type": "object" + }, + "CmsActivityDefinition": { + "allOf": [ + { + "$ref": "#/definitions/ActivityDefinition" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "ActivityType": { + "type": "string", + "enum": [ + "Normal", + "Decision", + "UnknownByClient" + ] + }, + "AllowOverrideDueDate": { + "type": "boolean" + }, + "ExpirationScript": { + "type": "string" + }, + "ExpirationScriptType": { + "type": "string" + }, + "FinishApprovalStatus": { + "$ref": "#/definitions/Link" + }, + "NextActivityDefinitions": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "PerformingTimeout": { + "type": "integer", + "format": "int32" + }, + "Script": { + "type": "string" + }, + "ScriptType": { + "type": "string" + } + }, + "type": "object" + } + ], + "xml": { + "name": "CmsActivityDefinition" + }, + "type": "object" + }, + "CmsProcessDefinition": { + "allOf": [ + { + "$ref": "#/definitions/ProcessDefinition" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "Diagram": { + "type": "string", + "format": "byte" + } + }, + "type": "object" + } + ], + "xml": { + "name": "CmsProcessDefinition" + }, + "type": "object" + }, + "WorkflowObject": { + "allOf": [ + { + "$ref": "#/definitions/IdentifiableObject" + }, + { + "properties": { + "ContextRepository": { + "$ref": "#/definitions/Link" + } + }, + "type": "object" + } + ], + "xml": { + "name": "WorkflowObject" + }, + "type": "object" + }, + "WorkflowType": { + "allOf": [ + { + "$ref": "#/definitions/RegisteredType" + }, + { + "properties": { + "$type": { + "type": "string" + } + }, + "type": "object" + } + ], + "xml": { + "name": "WorkflowType" + }, + "type": "object" + }, + "AccessToken": { + "allOf": [ + { + "$ref": "#/definitions/User" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "ExpiresAt": { + "type": "string", + "format": "date-time" + }, + "InheritedSystemPrivileges": { + "additionalProperties": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "type": "object" + }, + "Signature": { + "type": "string" + } + }, + "type": "object" + } + ], + "xml": { + "name": "AccessToken" + }, + "type": "object" + }, + "ClaimMapping": { + "properties": { + "$type": { + "example": "ClaimMapping", + "type": "string" + }, + "Description": { + "type": "string" + }, + "Group": { + "$ref": "#/definitions/Link" + } + }, + "xml": { + "name": "ClaimMapping" + }, + "type": "object" + }, + "LinkWithIsEditable": { + "properties": { + "IdRef": { + "type": "string" + }, + "Title": { + "type": "string" + }, + "$type": { + "example": "LinkWithIsEditable", + "type": "string" + }, + "Description": { + "type": "string" + }, + "IsEditable": { + "type": "boolean" + }, + "WebDavUrl": { + "type": "string" + } + }, + "xml": { + "name": "LinkWithIsEditable" + }, + "type": "object" + }, + "Group": { + "allOf": [ + { + "$ref": "#/definitions/Trustee" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "ClaimMappings": { + "items": { + "$ref": "#/definitions/ClaimMapping" + }, + "xml": { + "name": "ClaimMapping", + "wrapped": true + }, + "type": "array" + }, + "DefaultGroupId": { + "type": "integer", + "format": "int32" + }, + "InheritedSystemPrivileges": { + "additionalProperties": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "type": "object" + }, + "Scope": { + "items": { + "$ref": "#/definitions/LinkWithIsEditable" + }, + "xml": { + "name": "LinkWithIsEditable", + "wrapped": true + }, + "type": "array" + }, + "SystemPrivileges": { + "items": { + "$ref": "#/definitions/SystemPrivilege" + }, + "xml": { + "name": "SystemPrivilege", + "wrapped": true + }, + "type": "array" + } + }, + "type": "object" + } + ], + "xml": { + "name": "Group" + }, + "type": "object" + }, + "Trustee": { + "allOf": [ + { + "$ref": "#/definitions/SystemWideObject" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "GroupMemberships": { + "items": { + "$ref": "#/definitions/GroupMembership" + }, + "xml": { + "name": "GroupMembership", + "wrapped": true + }, + "type": "array" + }, + "IsPredefined": { + "type": "boolean" + } + }, + "type": "object" + } + ], + "xml": { + "name": "Trustee" + }, + "type": "object" + }, + "BlueprintNode": { + "allOf": [ + { + "$ref": "#/definitions/Publication" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "Item": { + "$ref": "#/definitions/RepositoryLocalObject" + } + }, + "type": "object" + } + ], + "xml": { + "name": "BlueprintNode" + }, + "type": "object" + }, + "BundleType": { + "allOf": [ + { + "$ref": "#/definitions/Schema" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "MappedItems": { + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "ResolvedBundles": { + "items": { + "$ref": "#/definitions/ResolvedBundle" + }, + "readOnly": true, + "xml": { + "name": "ResolvedBundle", + "wrapped": true + }, + "type": "array" + } + }, + "type": "object" + } + ], + "xml": { + "name": "BundleType" + }, + "type": "object" + }, + "ResolvedBundle": { + "allOf": [ + { + "$ref": "#/definitions/VirtualFolder" + }, + { + "properties": { + "$type": { + "type": "string" + } + }, + "type": "object" + } + ], + "xml": { + "name": "ResolvedBundle" + }, + "type": "object" + }, + "WorkflowInfo": { + "properties": { + "$type": { + "example": "WorkflowInfo", + "type": "string" + }, + "ActivityConstraints": { + "type": "string", + "enum": [ + "None", + "DenyBundleMetadataEditing", + "DenySubjectEditing", + "DenyAddRemoveWorkItem", + "UnknownByClient" + ] + }, + "ActivityDefinitionDescription": { + "type": "string" + }, + "ActivityInstance": { + "$ref": "#/definitions/Link" + }, + "ActivityState": { + "type": "string", + "enum": [ + "Assigned", + "Started", + "Failed", + "Finished", + "Suspended", + "WaitingForWorkflowAgent", + "UnknownByClient" + ] + }, + "Assignee": { + "$ref": "#/definitions/Link" + }, + "AssignmentDate": { + "type": "string", + "format": "date-time" + }, + "CreationDate": { + "type": "string", + "format": "date-time" + }, + "DueDate": { + "type": "string", + "format": "date-time" + }, + "FinishDate": { + "type": "string", + "format": "date-time" + }, + "Performer": { + "$ref": "#/definitions/Link" + }, + "PreviousMessage": { + "type": "string" + }, + "ProcessInstance": { + "$ref": "#/definitions/Link" + }, + "StartDate": { + "type": "string", + "format": "date-time" + } + }, + "xml": { + "name": "WorkflowInfo" + }, + "type": "object" + }, + "Category": { + "allOf": [ + { + "$ref": "#/definitions/OrganizationalItem" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "AllowedParentCategories": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "Description": { + "type": "string" + }, + "IsTaxonomyRoot": { + "type": "boolean" + }, + "KeywordMetadataSchema": { + "$ref": "#/definitions/Link" + }, + "UseForIdentification": { + "type": "boolean" + }, + "UseForNavigation": { + "type": "boolean" + }, + "XmlName": { + "type": "string" + } + }, + "type": "object" + } + ], + "xml": { + "name": "Category" + }, + "type": "object" + }, + "Component": { + "allOf": [ + { + "$ref": "#/definitions/VersionedItem" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "ApprovalStatus": { + "$ref": "#/definitions/Link" + }, + "BinaryContent": { + "$ref": "#/definitions/BinaryContent" + }, + "ComponentType": { + "type": "string", + "enum": [ + "UnknownByClient", + "Normal", + "Multimedia", + "Widget" + ] + }, + "Content": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "IsBasedOnMandatorySchema": { + "type": "boolean" + }, + "IsBasedOnCmsWebSchema": { + "type": "boolean" + }, + "Schema": { + "$ref": "#/definitions/Link" + }, + "WorkflowInfo": { + "$ref": "#/definitions/WorkflowInfo" + } + }, + "type": "object" + } + ], + "xml": { + "name": "Component" + }, + "type": "object" + }, + "Folder": { + "allOf": [ + { + "$ref": "#/definitions/OrganizationalItem" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "IsLinkedSchemaMandatory": { + "type": "boolean" + }, + "LinkedSchema": { + "$ref": "#/definitions/Link" + } + }, + "type": "object" + } + ], + "xml": { + "name": "Folder" + }, + "type": "object" + }, + "Keyword": { + "allOf": [ + { + "$ref": "#/definitions/RepositoryLocalObject" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "IsAbstract": { + "type": "boolean" + }, + "IsRoot": { + "type": "boolean" + }, + "Key": { + "type": "string" + }, + "ParentKeywords": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "RelatedKeywords": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + } + }, + "type": "object" + } + ], + "xml": { + "name": "Keyword" + }, + "type": "object" + }, + "MultimediaType": { + "allOf": [ + { + "$ref": "#/definitions/SystemWideObject" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "FileExtensions": { + "items": { + "type": "string" + }, + "type": "array" + }, + "MimeType": { + "type": "string" + } + }, + "type": "object" + } + ], + "xml": { + "name": "MultimediaType" + }, + "type": "object" + }, + "Repository": { + "allOf": [ + { + "$ref": "#/definitions/SystemWideObject" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "AccessControlList": { + "$ref": "#/definitions/AccessControlList" + }, + "BusinessProcessType": { + "$ref": "#/definitions/Link" + }, + "CategoriesXsd": { + "type": "string" + }, + "ContentSecurityDescriptor": { + "$ref": "#/definitions/SecurityDescriptor" + }, + "DefaultMultimediaSchema": { + "$ref": "#/definitions/Link" + }, + "HasChildren": { + "type": "boolean" + }, + "Key": { + "type": "string" + }, + "LocationInfo": { + "$ref": "#/definitions/LocationInfo" + }, + "Metadata": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "MetadataSchema": { + "$ref": "#/definitions/Link" + }, + "MinimalLocalizeApprovalStatus": { + "$ref": "#/definitions/Link" + }, + "Parents": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "RootFolder": { + "$ref": "#/definitions/Link" + }, + "TaskProcess": { + "$ref": "#/definitions/Link" + }, + "VersionInfo": { + "$ref": "#/definitions/LimitedVersionInfo" + } + }, + "type": "object" + } + ], + "xml": { + "name": "Repository" + }, + "type": "object" + }, + "VirtualFolder": { + "allOf": [ + { + "$ref": "#/definitions/OrganizationalItem" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "ApprovalStatus": { + "$ref": "#/definitions/Link" + }, + "Configuration": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "TypeSchema": { + "$ref": "#/definitions/Link" + }, + "WorkflowInfo": { + "$ref": "#/definitions/WorkflowInfo" + } + }, + "type": "object" + } + ], + "xml": { + "name": "VirtualFolder" + }, + "type": "object" + }, + "BusinessProcessType": { + "allOf": [ + { + "$ref": "#/definitions/OrganizationalItem" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "BundleSchemas": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "CdTopologyTypeId": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "TargetTypes": { + "items": { + "$ref": "#/definitions/TargetType" + }, + "xml": { + "name": "TargetType", + "wrapped": true + }, + "type": "array" + } + }, + "type": "object" + } + ], + "xml": { + "name": "BusinessProcessType" + }, + "type": "object" + }, + "TargetType": { + "allOf": [ + { + "$ref": "#/definitions/PublishingTarget" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "AccessControlList": { + "$ref": "#/definitions/AccessControlList" + }, + "BusinessProcessType": { + "$ref": "#/definitions/Link" + }, + "ContentSecurityDescriptor": { + "$ref": "#/definitions/SecurityDescriptor" + }, + "MinimalApprovalStatus": { + "$ref": "#/definitions/Link" + }, + "Priority": { + "type": "string", + "enum": [ + "UnknownByClient", + "Low", + "Normal", + "High" + ] + }, + "Purpose": { + "type": "string" + } + }, + "type": "object" + } + ], + "xml": { + "name": "TargetType" + }, + "type": "object" + }, + "ComponentTemplate": { + "allOf": [ + { + "$ref": "#/definitions/Template" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "AllowOnPage": { + "type": "boolean" + }, + "ApprovalStatus": { + "$ref": "#/definitions/Link" + }, + "DynamicTemplate": { + "type": "string" + }, + "IsRepositoryPublishable": { + "type": "boolean" + }, + "OutputFormat": { + "type": "string" + }, + "Priority": { + "type": "integer", + "format": "int32" + }, + "RelatedSchemas": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "TrackingCategories": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "WorkflowInfo": { + "$ref": "#/definitions/WorkflowInfo" + } + }, + "type": "object" + } + ], + "xml": { + "name": "ComponentTemplate" + }, + "type": "object" + }, + "PublishLocationInfo": { + "properties": { + "$type": { + "example": "PublishLocationInfo", + "type": "string" + }, + "ContextRepository": { + "$ref": "#/definitions/Link" + }, + "OrganizationalItem": { + "$ref": "#/definitions/Link" + }, + "Path": { + "type": "string" + }, + "PublishLocationPath": { + "type": "string" + }, + "PublishLocationUrl": { + "type": "string" + }, + "PublishPath": { + "type": "string" + }, + "WebDavUrl": { + "type": "string" + } + }, + "xml": { + "name": "PublishLocationInfo" + }, + "type": "object" + }, + "Page": { + "allOf": [ + { + "$ref": "#/definitions/VersionedItem" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "ApprovalStatus": { + "$ref": "#/definitions/Link" + }, + "ComponentPresentations": { + "items": { + "$ref": "#/definitions/ComponentPresentation" + }, + "xml": { + "name": "ComponentPresentation", + "wrapped": true + }, + "type": "array" + }, + "FileName": { + "type": "string" + }, + "IsPageTemplateInherited": { + "type": "boolean" + }, + "LocationInfo": { + "$ref": "#/definitions/PublishLocationInfo" + }, + "MetadataSchema": { + "$ref": "#/definitions/Link" + }, + "PageTemplate": { + "$ref": "#/definitions/Link" + }, + "Regions": { + "items": { + "$ref": "#/definitions/Region" + }, + "xml": { + "name": "Region", + "wrapped": true + }, + "type": "array" + }, + "RegionSchema": { + "$ref": "#/definitions/Link" + }, + "WorkflowInfo": { + "$ref": "#/definitions/WorkflowInfo" + } + }, + "type": "object" + } + ], + "xml": { + "name": "Page" + }, + "type": "object" + }, + "PageTemplate": { + "allOf": [ + { + "$ref": "#/definitions/Template" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "ApprovalStatus": { + "$ref": "#/definitions/Link" + }, + "FileExtension": { + "type": "string" + }, + "PageSchema": { + "$ref": "#/definitions/Link" + }, + "WorkflowInfo": { + "$ref": "#/definitions/WorkflowInfo" + } + }, + "type": "object" + } + ], + "xml": { + "name": "PageTemplate" + }, + "type": "object" + }, + "Publication": { + "allOf": [ + { + "$ref": "#/definitions/Repository" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "ComponentSnapshotTemplate": { + "$ref": "#/definitions/Link" + }, + "ComponentTemplateProcess": { + "$ref": "#/definitions/Link" + }, + "DefaultComponentTemplate": { + "$ref": "#/definitions/Link" + }, + "DefaultPageTemplate": { + "$ref": "#/definitions/Link" + }, + "DefaultTemplateBuildingBlock": { + "$ref": "#/definitions/Link" + }, + "MultimediaPath": { + "type": "string" + }, + "MultimediaUrl": { + "type": "string" + }, + "PageSnapshotTemplate": { + "$ref": "#/definitions/Link" + }, + "PageTemplateProcess": { + "$ref": "#/definitions/Link" + }, + "PublicationPath": { + "type": "string" + }, + "PublicationType": { + "type": "string" + }, + "PublicationUrl": { + "type": "string" + }, + "RootStructureGroup": { + "$ref": "#/definitions/Link" + }, + "ShareProcessAssociations": { + "type": "boolean" + }, + "TemplateBundleProcess": { + "$ref": "#/definitions/Link" + } + }, + "type": "object" + } + ], + "xml": { + "name": "Publication" + }, + "type": "object" + }, + "PublishingTarget": { + "allOf": [ + { + "$ref": "#/definitions/SystemWideObject" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "Description": { + "type": "string" + } + }, + "type": "object" + } + ], + "xml": { + "name": "PublishingTarget" + }, + "type": "object" + }, + "StructureGroup": { + "allOf": [ + { + "$ref": "#/definitions/OrganizationalItem" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "DefaultPageTemplate": { + "$ref": "#/definitions/Link" + }, + "Directory": { + "type": "string" + }, + "IsActive": { + "type": "boolean" + }, + "IsActiveResolvedValue": { + "type": "boolean" + }, + "IsDefaultPageTemplateInherited": { + "type": "boolean" + }, + "LocationInfo": { + "$ref": "#/definitions/PublishLocationInfo" + }, + "PageBundleProcess": { + "$ref": "#/definitions/Link" + }, + "PageProcess": { + "$ref": "#/definitions/Link" + } + }, + "type": "object" + } + ], + "xml": { + "name": "StructureGroup" + }, + "type": "object" + }, + "TemplateBuildingBlock": { + "allOf": [ + { + "$ref": "#/definitions/Template" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "ApprovalStatus": { + "$ref": "#/definitions/Link" + }, + "TemplatePurpose": { + "type": "string", + "enum": [ + "UnknownByClient", + "Rendering", + "Data" + ] + }, + "WorkflowInfo": { + "$ref": "#/definitions/WorkflowInfo" + } + }, + "type": "object" + } + ], + "xml": { + "name": "TemplateBuildingBlock" + }, + "type": "object" + }, + "BatchOperation": { + "properties": { + "$type": { + "example": "BatchOperation", + "type": "string" + }, + "Operation": { + "type": "string" + }, + "Parameters": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "Statuses": { + "items": { + "$ref": "#/definitions/BatchOperationStatus" + }, + "readOnly": true, + "xml": { + "name": "BatchOperationStatus", + "wrapped": true + }, + "type": "array" + }, + "SubjectLinks": { + "items": { + "$ref": "#/definitions/WeakLink" + }, + "xml": { + "name": "WeakLink", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "BatchOperation" + }, + "type": "object" + }, + "BatchOperationStatus": { + "properties": { + "$type": { + "example": "BatchOperationStatus", + "type": "string" + }, + "ErrorCode": { + "type": "string" + }, + "Id": { + "type": "integer", + "format": "int32" + }, + "Information": { + "type": "string" + }, + "State": { + "type": "string", + "enum": [ + "UnknownByClient", + "NotStarted", + "Success", + "Warning", + "Error" + ] + }, + "SubjectId": { + "type": "string" + }, + "ValidationErrors": { + "items": { + "$ref": "#/definitions/ValidationError" + }, + "xml": { + "name": "ValidationError", + "wrapped": true + }, + "type": "array" + }, + "ValidationWarnings": { + "items": { + "$ref": "#/definitions/ValidationWarning" + }, + "xml": { + "name": "ValidationWarning", + "wrapped": true + }, + "type": "array" + } + }, + "xml": { + "name": "BatchOperationStatus" + }, + "type": "object" + }, + "Batch": { + "allOf": [ + { + "$ref": "#/definitions/SystemWideObject" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "NumberOfDoneOperations": { + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "Operations": { + "items": { + "$ref": "#/definitions/BatchOperation" + }, + "xml": { + "name": "BatchOperation", + "wrapped": true + }, + "type": "array" + }, + "Performer": { + "$ref": "#/definitions/Link" + }, + "PerformerAccessToken": { + "$ref": "#/definitions/AccessToken" + }, + "StartAt": { + "type": "string", + "format": "date-time" + }, + "TotalNumberOfOperations": { + "readOnly": true, + "type": "integer", + "format": "int32" + } + }, + "type": "object" + } + ], + "xml": { + "name": "Batch" + }, + "type": "object" + }, + "TargetGroup": { + "allOf": [ + { + "$ref": "#/definitions/RepositoryLocalObject" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "Conditions": { + "items": { + "$ref": "#/definitions/Condition" + }, + "xml": { + "name": "Condition", + "wrapped": true + }, + "type": "array" + }, + "Description": { + "type": "string" + } + }, + "type": "object" + } + ], + "xml": { + "name": "TargetGroup" + }, + "type": "object" + }, + "Condition": { + "properties": { + "$type": { + "example": "Condition", + "type": "string" + }, + "Negate": { + "type": "boolean" + } + }, + "xml": { + "name": "Condition" + }, + "type": "object" + }, + "ItemField": { + "properties": { + "Definition": { + "$ref": "#/definitions/ItemFieldDefinition" + }, + "Name": { + "type": "string" + }, + "discriminator": { + "type": "string" + } + }, + "discriminator": "ItemFieldType", + "xml": { + "name": "ItemField" + }, + "type": "object" + }, + "ItemFieldDefinition": { + "properties": { + "CustomUrl": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "ExtensionXml": { + "type": "string" + }, + "MaxOccurs": { + "type": "integer", + "format": "int32" + }, + "MinOccurs": { + "type": "integer", + "format": "int32" + }, + "Name": { + "type": "string" + }, + "discriminator": { + "type": "string" + } + }, + "discriminator": "ItemFieldDefinitionType", + "xml": { + "name": "ItemFieldDefinition" + }, + "type": "object" + }, + "ComponentLinkField": { + "allOf": [ + { + "$ref": "#/definitions/ItemField" + }, + { + "properties": { + "Value": { + "$ref": "#/definitions/Component" + }, + "Values": { + "items": { + "$ref": "#/definitions/Component" + }, + "readOnly": true, + "xml": { + "name": "Component", + "wrapped": true + }, + "type": "array" + } + }, + "type": "object" + } + ], + "xml": { + "name": "ComponentLinkField" + }, + "type": "object" + }, + "DateField": { + "allOf": [ + { + "$ref": "#/definitions/ItemField" + }, + { + "properties": { + "Value": { + "type": "string", + "format": "date-time" + }, + "Values": { + "items": { + "type": "string", + "format": "date-time" + }, + "type": "array" + } + }, + "type": "object" + } + ], + "xml": { + "name": "DateField" + }, + "type": "object" + }, + "EmbeddedSchemaField": { + "allOf": [ + { + "$ref": "#/definitions/ItemField" + }, + { + "properties": { + "Value": { + "items": { + "$ref": "#/definitions/ItemField" + }, + "xml": { + "name": "ItemField", + "wrapped": true + }, + "type": "array" + }, + "Values": { + "items": { + "items": { + "$ref": "#/definitions/ItemField" + }, + "xml": { + "name": "ItemField", + "wrapped": true + }, + "type": "array" + }, + "xml": { + "name": "ItemFields", + "wrapped": true + }, + "type": "array" + } + }, + "type": "object" + } + ], + "xml": { + "name": "EmbeddedSchemaField" + }, + "type": "object" + }, + "ExternalLinkField": { + "allOf": [ + { + "$ref": "#/definitions/TextField" + }, + { + "properties": {}, + "type": "object" + } + ], + "xml": { + "name": "ExternalLinkField" + }, + "type": "object" + }, + "KeywordField": { + "allOf": [ + { + "$ref": "#/definitions/ItemField" + }, + { + "properties": { + "Value": { + "$ref": "#/definitions/Keyword" + }, + "Values": { + "items": { + "$ref": "#/definitions/Keyword" + }, + "xml": { + "name": "Keyword", + "wrapped": true + }, + "type": "array" + } + }, + "type": "object" + } + ], + "xml": { + "name": "KeywordField" + }, + "type": "object" + }, + "MultiLineTextField": { + "allOf": [ + { + "$ref": "#/definitions/TextField" + }, + { + "properties": {}, + "type": "object" + } + ], + "xml": { + "name": "MultiLineTextField" + }, + "type": "object" + }, + "MultimediaLinkField": { + "allOf": [ + { + "$ref": "#/definitions/ComponentLinkField" + }, + { + "properties": {}, + "type": "object" + } + ], + "xml": { + "name": "MultimediaLinkField" + }, + "type": "object" + }, + "NumberField": { + "allOf": [ + { + "$ref": "#/definitions/ItemField" + }, + { + "properties": { + "Value": { + "type": "number", + "format": "double" + }, + "Values": { + "items": { + "type": "number", + "format": "double" + }, + "type": "array" + } + }, + "type": "object" + } + ], + "xml": { + "name": "NumberField" + }, + "type": "object" + }, + "SingleLineTextField": { + "allOf": [ + { + "$ref": "#/definitions/TextField" + }, + { + "properties": {}, + "type": "object" + } + ], + "xml": { + "name": "SingleLineTextField" + }, + "type": "object" + }, + "TextField": { + "allOf": [ + { + "$ref": "#/definitions/ItemField" + }, + { + "properties": { + "Value": { + "type": "string" + }, + "Values": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + ], + "xml": { + "name": "TextField" + }, + "type": "object" + }, + "XhtmlField": { + "allOf": [ + { + "$ref": "#/definitions/TextField" + }, + { + "properties": {}, + "type": "object" + } + ], + "xml": { + "name": "XhtmlField" + }, + "type": "object" + }, + "ComponentLinkFieldDefinition": { + "allOf": [ + { + "$ref": "#/definitions/ItemFieldDefinition" + }, + { + "properties": { + "AllowedTargetSchemas": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "AllowMultimediaLinks": { + "type": "boolean" + }, + "DefaultValue": { + "$ref": "#/definitions/Link" + } + }, + "type": "object" + } + ], + "xml": { + "name": "ComponentLinkFieldDefinition" + }, + "type": "object" + }, + "DateListDefinition": { + "allOf": [ + { + "$ref": "#/definitions/ListDefinition" + }, + { + "properties": { + "Entries": { + "items": { + "type": "string", + "format": "date-time" + }, + "type": "array" + } + }, + "type": "object" + } + ], + "xml": { + "name": "DateListDefinition" + }, + "type": "object" + }, + "DateFieldDefinition": { + "allOf": [ + { + "$ref": "#/definitions/ItemFieldDefinition" + }, + { + "properties": { + "DefaultValue": { + "type": "string", + "format": "date-time" + }, + "IsMaxValueExclusive": { + "type": "boolean" + }, + "IsMinValueExclusive": { + "type": "boolean" + }, + "List": { + "$ref": "#/definitions/DateListDefinition" + }, + "MaxValue": { + "type": "string", + "format": "date-time" + }, + "MinValue": { + "type": "string", + "format": "date-time" + }, + "Pattern": { + "type": "string" + } + }, + "type": "object" + } + ], + "xml": { + "name": "DateFieldDefinition" + }, + "type": "object" + }, + "EmbeddedSchemaFieldDefinition": { + "allOf": [ + { + "$ref": "#/definitions/ItemFieldDefinition" + }, + { + "properties": { + "EmbeddedFields": { + "items": { + "$ref": "#/definitions/ItemFieldDefinition" + }, + "xml": { + "name": "ItemFieldDefinition", + "wrapped": true + }, + "type": "array" + }, + "EmbeddedSchema": { + "$ref": "#/definitions/Link" + } + }, + "type": "object" + } + ], + "xml": { + "name": "EmbeddedSchemaFieldDefinition" + }, + "type": "object" + }, + "ExternalLinkFieldDefinition": { + "allOf": [ + { + "$ref": "#/definitions/ItemFieldDefinition" + }, + { + "properties": { + "DefaultValue": { + "type": "string" + } + }, + "type": "object" + } + ], + "xml": { + "name": "ExternalLinkFieldDefinition" + }, + "type": "object" + }, + "ListDefinition": { + "properties": { + "Height": { + "type": "integer", + "format": "int32" + }, + "Type": { + "type": "string", + "enum": [ + "UnknownByClient", + "None", + "Select", + "Edit", + "Radio", + "Checkbox", + "Tree" + ] + }, + "discriminator": { + "type": "string" + } + }, + "discriminator": "ListDefinitionType", + "xml": { + "name": "ListDefinition" + }, + "type": "object" + }, + "KeywordFieldDefinition": { + "allOf": [ + { + "$ref": "#/definitions/ItemFieldDefinition" + }, + { + "properties": { + "Category": { + "$ref": "#/definitions/Link" + }, + "DefaultValue": { + "$ref": "#/definitions/Link" + }, + "List": { + "$ref": "#/definitions/ListDefinition" + } + }, + "type": "object" + } + ], + "xml": { + "name": "KeywordFieldDefinition" + }, + "type": "object" + }, + "MultiLineTextFieldDefinition": { + "allOf": [ + { + "$ref": "#/definitions/ItemFieldDefinition" + }, + { + "properties": { + "DefaultValue": { + "type": "string" + }, + "Height": { + "type": "integer", + "format": "int32" + } + }, + "type": "object" + } + ], + "xml": { + "name": "MultiLineTextFieldDefinition" + }, + "type": "object" + }, + "MultimediaLinkFieldDefinition": { + "allOf": [ + { + "$ref": "#/definitions/ItemFieldDefinition" + }, + { + "properties": { + "AllowedTargetSchemas": { + "items": { + "$ref": "#/definitions/Link" + }, + "xml": { + "name": "Link", + "wrapped": true + }, + "type": "array" + }, + "DefaultValue": { + "$ref": "#/definitions/Link" + } + }, + "type": "object" + } + ], + "xml": { + "name": "MultimediaLinkFieldDefinition" + }, + "type": "object" + }, + "NumberListDefinition": { + "allOf": [ + { + "$ref": "#/definitions/ListDefinition" + }, + { + "properties": { + "Entries": { + "items": { + "type": "number", + "format": "double" + }, + "type": "array" + } + }, + "type": "object" + } + ], + "xml": { + "name": "NumberListDefinition" + }, + "type": "object" + }, + "NumberFieldDefinition": { + "allOf": [ + { + "$ref": "#/definitions/ItemFieldDefinition" + }, + { + "properties": { + "DefaultValue": { + "type": "number", + "format": "double" + }, + "FractionDigits": { + "type": "integer", + "format": "int32" + }, + "IsMaxValueExclusive": { + "type": "boolean" + }, + "IsMinValueExclusive": { + "type": "boolean" + }, + "List": { + "$ref": "#/definitions/NumberListDefinition" + }, + "MaxValue": { + "type": "number", + "format": "double" + }, + "MinValue": { + "type": "number", + "format": "double" + }, + "Pattern": { + "type": "string" + }, + "TotalDigits": { + "type": "integer", + "format": "int32" + } + }, + "type": "object" + } + ], + "xml": { + "name": "NumberFieldDefinition" + }, + "type": "object" + }, + "SingleLineTextListDefinition": { + "allOf": [ + { + "$ref": "#/definitions/ListDefinition" + }, + { + "properties": { + "Entries": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + ], + "xml": { + "name": "SingleLineTextListDefinition" + }, + "type": "object" + }, + "SingleLineTextFieldDefinition": { + "allOf": [ + { + "$ref": "#/definitions/ItemFieldDefinition" + }, + { + "properties": { + "DefaultValue": { + "type": "string" + }, + "List": { + "$ref": "#/definitions/SingleLineTextListDefinition" + }, + "MaxLength": { + "type": "integer", + "format": "int32" + }, + "MinLength": { + "type": "integer", + "format": "int32" + }, + "Pattern": { + "type": "string" + } + }, + "type": "object" + } + ], + "xml": { + "name": "SingleLineTextFieldDefinition" + }, + "type": "object" + }, + "FormattingFeatures": { + "properties": { + "$type": { + "example": "FormattingFeatures", + "type": "string" + }, + "AccessibilityLevel": { + "type": "integer", + "format": "int32" + }, + "DisallowedActions": { + "items": { + "type": "string" + }, + "type": "array" + }, + "DisallowedStyles": { + "items": { + "type": "string" + }, + "type": "array" + }, + "DocType": { + "type": "string" + } + }, + "xml": { + "name": "FormattingFeatures" + }, + "type": "object" + }, + "XhtmlFieldDefinition": { + "allOf": [ + { + "$ref": "#/definitions/ItemFieldDefinition" + }, + { + "properties": { + "DefaultValue": { + "type": "string" + }, + "FilterXslt": { + "type": "string" + }, + "FormattingFeatures": { + "$ref": "#/definitions/FormattingFeatures" + }, + "Height": { + "type": "integer", + "format": "int32" + } + }, + "type": "object" + } + ], + "xml": { + "name": "XhtmlFieldDefinition" + }, + "type": "object" + }, + "ExtendedFieldDefinition": { + "allOf": [ + { + "$ref": "#/definitions/FieldDefinition" + }, + { + "properties": { + "$type": { + "type": "string" + }, + "ItemFieldDefinition": { + "$ref": "#/definitions/ItemFieldDefinition" + } + }, + "type": "object" + } + ], + "xml": { + "name": "ExtendedFieldDefinition" + }, + "type": "object" + }, + "VersionedItemRequest": { + "properties": { + "UserComment": { + "type": "string" + }, + "discriminator": { + "type": "string" + } + }, + "discriminator": "VersionedItemRequestType", + "xml": { + "name": "VersionedItemRequest" + }, + "type": "object" + } + }, + "tags": [ + { + "name": "ApplicationData", + "description": "Provides operations to Create, Read, Update and Delete application data." + }, + { + "name": "BatchOperations", + "description": "Provides operations to perform certain actions on batches of items." + }, + { + "name": "Binaries", + "description": "Provides operations for uploading binaries." + }, + { + "name": "Blueprinting", + "description": "Provides operations for Blueprinting." + }, + { + "name": "FastTrackPublishing", + "description": "Provides operations for Fast Track Publishing" + }, + { + "name": "HealthCheck", + "description": "Provides a healthcheck." + }, + { + "name": "Item", + "description": "Provides operations to Create, Read, Update, Delete and Validate items." + }, + { + "name": "Lists", + "description": "Provides operations to get lists of certain items." + }, + { + "name": "OrganizationalItems", + "description": "Provides operations for OrganizationalItems." + }, + { + "name": "Publishing", + "description": "Provides operations for Publishing." + }, + { + "name": "Queues", + "description": "Provides operations for Queues and Messages." + }, + { + "name": "Rendering", + "description": "Provides operations for rendering and preview." + }, + { + "name": "Schemas", + "description": "Provides Schema related operations." + }, + { + "name": "Search", + "description": "Provides operations for searching and indexing." + }, + { + "name": "System", + "description": "Provides system operations." + }, + { + "name": "UserProfile", + "description": "Provides operations for a User's UserProfile." + }, + { + "name": "Versioning", + "description": "Provides operations for versioned items." + }, + { + "name": "Workflow", + "description": "Provides operations to control Workflow." + } + ] +} diff --git a/test/mock/v3/test-access.json b/test/mock/v3/test-access.json new file mode 100644 index 00000000..20ee2ee4 --- /dev/null +++ b/test/mock/v3/test-access.json @@ -0,0 +1,4217 @@ +{ + "openapi": "3.0.1", + "info": { + "title": "Access Management API", + "version": "v1" + }, + "servers": [ + { + "url": "/access-manager" + } + ], + "paths": { + "/api/v{api-version}/ApiResources/getByName/{name}": { + "get": { + "tags": [ + "ApiResources" + ], + "operationId": "GetByName", + "parameters": [ + { + "name": "name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ApiResource" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResource" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiResource" + } + } + } + } + } + } + }, + "/api/v{api-version}/ApiResources": { + "get": { + "tags": [ + "ApiResources" + ], + "operationId": "Get", + "parameters": [ + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiResource" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiResource" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiResource" + } + } + } + } + }, + "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" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Server Error", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v{api-version}/ApiResources/{id}": { + "get": { + "tags": [ + "ApiResources" + ], + "operationId": "Get", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ApiResource" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApiResource" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ApiResource" + } + } + } + } + } + } + }, + "/api/v{api-version}/Applications/getByDisplayName/{name}": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "GetByDisplayName", + "parameters": [ + { + "name": "name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Application" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Application" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Application" + } + } + } + } + } + } + }, + "/api/v{api-version}/Applications/getByClientId/{clientId}": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "GetByClientId", + "parameters": [ + { + "name": "clientId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Application" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Application" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Application" + } + } + } + } + } + } + }, + "/api/v{api-version}/Applications/{id}": { + "put": { + "tags": [ + "Applications" + ], + "operationId": "Update", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "title": "Application", + "required": [ + "displayName", + "redirectUrls" + ], + "type": "object", + "properties": { + "clientId": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "id": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "displayName": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "redirectUrls": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + } + } + }, + "application/json": { + "schema": { + "title": "Application", + "required": [ + "displayName", + "redirectUrls" + ], + "type": "object", + "properties": { + "clientId": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "id": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "displayName": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "redirectUrls": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + } + } + }, + "text/json": { + "schema": { + "title": "Application", + "required": [ + "displayName", + "redirectUrls" + ], + "type": "object", + "properties": { + "clientId": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "id": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "displayName": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "redirectUrls": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + } + } + }, + "application/*+json": { + "schema": { + "title": "Application", + "required": [ + "displayName", + "redirectUrls" + ], + "type": "object", + "properties": { + "clientId": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "id": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "displayName": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "redirectUrls": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Application" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Application" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Application" + } + } + } + } + } + }, + "get": { + "tags": [ + "Applications" + ], + "operationId": "Get", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/Application" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/Application" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/Application" + } + } + } + } + } + } + }, + "/api/v{api-version}/Applications": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "Get", + "parameters": [ + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Application" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Application" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Application" + } + } + } + } + }, + "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" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Server Error", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v{api-version}/Claims": { + "get": { + "tags": [ + "Claims" + ], + "operationId": "Get", + "parameters": [ + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + }, + "400": { + "description": "Bad Request", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Server Error", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v{api-version}/ExternalClaimForwardings/getByIdentityProviderId/{identityProviderId}": { + "get": { + "tags": [ + "ExternalClaimForwardings" + ], + "operationId": "GetByIdentityProviderId", + "parameters": [ + { + "name": "identityProviderId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "500": { + "description": "Server Error", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v{api-version}/ExternalClaimForwardings": { + "post": { + "tags": [ + "ExternalClaimForwardings" + ], + "operationId": "Create", + "parameters": [ + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + } + } + } + } + }, + "get": { + "tags": [ + "ExternalClaimForwardings" + ], + "operationId": "Get", + "parameters": [ + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + } + } + } + }, + "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" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Server Error", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v{api-version}/ExternalClaimForwardings/{id}": { + "put": { + "tags": [ + "ExternalClaimForwardings" + ], + "operationId": "Update", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + } + } + } + } + }, + "delete": { + "tags": [ + "ExternalClaimForwardings" + ], + "operationId": "Delete", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + }, + "get": { + "tags": [ + "ExternalClaimForwardings" + ], + "operationId": "Get", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimForwarding" + } + } + } + } + } + } + }, + "/api/v{api-version}/ExternalClaimMappings/getByIdentityProviderId/{identityProviderId}": { + "get": { + "tags": [ + "ExternalClaimMappings" + ], + "operationId": "GetByIdentityProviderId", + "parameters": [ + { + "name": "identityProviderId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "500": { + "description": "Server Error", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v{api-version}/ExternalClaimMappings": { + "post": { + "tags": [ + "ExternalClaimMappings" + ], + "operationId": "Create", + "parameters": [ + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + } + } + } + } + }, + "get": { + "tags": [ + "ExternalClaimMappings" + ], + "operationId": "Get", + "parameters": [ + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + } + } + } + }, + "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" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Server Error", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v{api-version}/ExternalClaimMappings/{id}": { + "put": { + "tags": [ + "ExternalClaimMappings" + ], + "operationId": "Update", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + } + } + } + } + }, + "delete": { + "tags": [ + "ExternalClaimMappings" + ], + "operationId": "Delete", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + }, + "get": { + "tags": [ + "ExternalClaimMappings" + ], + "operationId": "Get", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ExternalClaimMapping" + } + } + } + } + } + } + }, + "/api/v{api-version}/IdentityProviders/loginOptions": { + "get": { + "tags": [ + "IdentityProviders" + ], + "operationId": "GetLoginOptions", + "parameters": [ + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LoginOption" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LoginOption" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LoginOption" + } + } + } + } + }, + "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" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Server Error", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v{api-version}/IdentityProviders/getParametersForIdentityProviderType/{providerType}": { + "get": { + "tags": [ + "IdentityProviders" + ], + "operationId": "GetParametersForIdentityProviderType", + "parameters": [ + { + "name": "providerType", + "in": "path", + "required": true, + "schema": { + "$ref": "#/components/schemas/IdentityProviderType" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/IdentityProviderParameters" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/IdentityProviderParameters" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/IdentityProviderParameters" + } + } + } + } + } + } + }, + "/api/v{api-version}/IdentityProviders": { + "post": { + "tags": [ + "IdentityProviders" + ], + "operationId": "Create", + "parameters": [ + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "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": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + } + } + } + } + }, + "get": { + "tags": [ + "IdentityProviders" + ], + "operationId": "Get", + "parameters": [ + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IdentityProvider" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IdentityProvider" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/IdentityProvider" + } + } + } + } + }, + "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" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Server Error", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v{api-version}/IdentityProviders/{id}": { + "put": { + "tags": [ + "IdentityProviders" + ], + "operationId": "Update", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "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": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + } + } + } + } + }, + "delete": { + "tags": [ + "IdentityProviders" + ], + "operationId": "Delete", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + }, + "get": { + "tags": [ + "IdentityProviders" + ], + "operationId": "Get", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/IdentityProvider" + } + } + } + } + } + } + }, + "/api/v{api-version}/Suggestions/claimTypes": { + "get": { + "tags": [ + "Suggestions" + ], + "operationId": "GetClaimTypes", + "parameters": [ + { + "name": "searchText", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "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" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Server Error", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v{api-version}/UserMappings/getByUserId/{userId}": { + "get": { + "tags": [ + "UserMappings" + ], + "operationId": "GetByUserId", + "parameters": [ + { + "name": "userId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/UserMapping" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserMapping" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserMapping" + } + } + } + } + } + } + }, + "/api/v{api-version}/UserMappings": { + "post": { + "tags": [ + "UserMappings" + ], + "operationId": "Create", + "parameters": [ + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/UserMapping" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserMapping" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserMapping" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UserMapping" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/UserMapping" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserMapping" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserMapping" + } + } + } + } + } + }, + "get": { + "tags": [ + "UserMappings" + ], + "operationId": "Get", + "parameters": [ + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserMapping" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserMapping" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserMapping" + } + } + } + } + }, + "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" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Server Error", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v{api-version}/UserMappings/{id}": { + "put": { + "tags": [ + "UserMappings" + ], + "operationId": "Update", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json-patch+json": { + "schema": { + "$ref": "#/components/schemas/UserMapping" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserMapping" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserMapping" + } + }, + "application/*+json": { + "schema": { + "$ref": "#/components/schemas/UserMapping" + } + } + } + }, + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/UserMapping" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserMapping" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserMapping" + } + } + } + } + } + }, + "delete": { + "tags": [ + "UserMappings" + ], + "operationId": "Delete", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + }, + "get": { + "tags": [ + "UserMappings" + ], + "operationId": "Get", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/UserMapping" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserMapping" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserMapping" + } + } + } + } + } + } + }, + "/api/v{api-version}/Users/{userId}/generateClientSecret": { + "post": { + "tags": [ + "Users" + ], + "operationId": "GenerateClientSecret", + "parameters": [ + { + "name": "userId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/UserClientSecret" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserClientSecret" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserClientSecret" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "500": { + "description": "Server Error", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v{api-version}/Users/{userId}/clientSecrets/{secretId}": { + "put": { + "tags": [ + "Users" + ], + "operationId": "UpdateClientSecret", + "parameters": [ + { + "name": "secretId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "userId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "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": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/UserClientSecret" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserClientSecret" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/UserClientSecret" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "500": { + "description": "Server Error", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Users" + ], + "operationId": "DeleteClientSecret", + "parameters": [ + { + "name": "userId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "secretId", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Success" + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "500": { + "description": "Server Error", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v{api-version}/Users/getByClientId/{clientId}": { + "get": { + "tags": [ + "Users" + ], + "operationId": "GetByClientId", + "parameters": [ + { + "name": "clientId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ProblemDetails" + } + } + } + }, + "500": { + "description": "Server Error", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v{api-version}/Users": { + "post": { + "tags": [ + "Users" + ], + "operationId": "Create", + "parameters": [ + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "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": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + } + } + }, + "get": { + "tags": [ + "Users" + ], + "operationId": "Get", + "parameters": [ + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + }, + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + }, + "text/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/User" + } + } + } + } + }, + "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" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + }, + "500": { + "description": "Server Error", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/ErrorResponse" + } + } + } + } + } + } + }, + "/api/v{api-version}/Users/{id}": { + "put": { + "tags": [ + "Users" + ], + "operationId": "Update", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "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": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + } + } + }, + "delete": { + "tags": [ + "Users" + ], + "operationId": "Delete", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success" + } + } + }, + "get": { + "tags": [ + "Users" + ], + "operationId": "Get", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "api-version", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "text/plain": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + }, + "text/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "ApiResourceRole": { + "required": [ + "displayName", + "name" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "displayName": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "apiResource": { + "$ref": "#/components/schemas/ApiResource" + } + }, + "additionalProperties": false + }, + "ApiResource": { + "required": [ + "displayName", + "name" + ], + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "name": { + "maxLength": 256, + "pattern": "^[a-zA-Z0-9-_.]*$", + "type": "string", + "nullable": true + }, + "displayName": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "roles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ApiResourceRole" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "IInnerError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "nullable": true + }, + "innerError": { + "$ref": "#/components/schemas/IInnerError" + } + }, + "additionalProperties": false + }, + "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 + }, + "Application": { + "required": [ + "displayName", + "redirectUrls" + ], + "type": "object", + "properties": { + "clientId": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "id": { + "type": "integer", + "format": "int32" + }, + "displayName": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "redirectUrls": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true + } + }, + "additionalProperties": false + }, + "IdentityProviderType": { + "enum": [ + "InternalUserClientStorage", + "OpenIdConnect", + "SAML2P", + "LDAP", + "Windows" + ], + "type": "string" + }, + "IdentityProviderParameters": { + "type": "object", + "additionalProperties": false + }, + "IdentityProvider": { + "required": [ + "displayName", + "fullNameClaim", + "name", + "parameters", + "type", + "usernameClaim" + ], + "type": "object", + "properties": { + "name": { + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_]*$", + "type": "string", + "nullable": true + }, + "displayName": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "isEnabled": { + "type": "boolean" + }, + "description": { + "maxLength": 2048, + "type": "string", + "nullable": true + }, + "type": { + "$ref": "#/components/schemas/IdentityProviderType" + }, + "separator": { + "maxLength": 1, + "type": "string", + "nullable": true + }, + "usernameClaim": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "fullNameClaim": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "iconUrl": { + "type": "string", + "nullable": true + }, + "parameters": { + "$ref": "#/components/schemas/IdentityProviderParameters" + }, + "redirectUrl": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "postLogoutRedirectUrl": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "validateUrl": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "createdBy": { + "type": "integer", + "format": "int32", + "nullable": true, + "readOnly": true + }, + "modifiedBy": { + "type": "integer", + "format": "int32", + "nullable": true, + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "id": { + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "additionalProperties": false + }, + "ExternalClaimForwarding": { + "required": [ + "claimType", + "identityProviderId" + ], + "type": "object", + "properties": { + "identityProviderId": { + "type": "integer", + "format": "int32" + }, + "identityProvider": { + "title": "IdentityProvider", + "required": [ + "displayName", + "fullNameClaim", + "name", + "parameters", + "type", + "usernameClaim" + ], + "type": "object", + "properties": { + "name": { + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_]*$", + "type": "string", + "nullable": true, + "readOnly": true + }, + "displayName": { + "maxLength": 256, + "type": "string", + "nullable": true, + "readOnly": true + }, + "isEnabled": { + "type": "boolean", + "readOnly": true + }, + "description": { + "maxLength": 2048, + "type": "string", + "nullable": true, + "readOnly": true + }, + "type": { + "title": "IdentityProviderType", + "enum": [ + "InternalUserClientStorage", + "OpenIdConnect", + "SAML2P", + "LDAP", + "Windows" + ], + "type": "string", + "readOnly": true + }, + "separator": { + "maxLength": 1, + "type": "string", + "nullable": true, + "readOnly": true + }, + "usernameClaim": { + "maxLength": 256, + "type": "string", + "nullable": true, + "readOnly": true + }, + "fullNameClaim": { + "maxLength": 256, + "type": "string", + "nullable": true, + "readOnly": true + }, + "iconUrl": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "parameters": { + "title": "IdentityProviderParameters", + "type": "object", + "readOnly": true + }, + "redirectUrl": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "postLogoutRedirectUrl": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "validateUrl": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "createdBy": { + "type": "integer", + "format": "int32", + "nullable": true, + "readOnly": true + }, + "modifiedBy": { + "type": "integer", + "format": "int32", + "nullable": true, + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "id": { + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "readOnly": true + }, + "claimType": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "id": { + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "additionalProperties": false + }, + "ProblemDetails": { + "type": "object", + "properties": { + "type": { + "type": "string", + "nullable": true + }, + "title": { + "type": "string", + "nullable": true + }, + "status": { + "type": "integer", + "format": "int32", + "nullable": true + }, + "detail": { + "type": "string", + "nullable": true + }, + "instance": { + "type": "string", + "nullable": true + }, + "extensions": { + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": false + }, + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false + }, + "ApplicationLink": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "displayName": { + "type": "string", + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false + }, + "ApiResourceLink": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "displayName": { + "type": "string", + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false + }, + "ApiResourceRoleLink": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int32" + }, + "displayName": { + "type": "string", + "nullable": true, + "readOnly": true + } + }, + "additionalProperties": false + }, + "ExternalClaimMapping": { + "required": [ + "identityProviderId" + ], + "type": "object", + "properties": { + "identityProviderId": { + "type": "integer", + "format": "int32" + }, + "identityProvider": { + "title": "IdentityProvider", + "required": [ + "displayName", + "fullNameClaim", + "name", + "parameters", + "type", + "usernameClaim" + ], + "type": "object", + "properties": { + "name": { + "maxLength": 64, + "pattern": "^[a-zA-Z0-9_]*$", + "type": "string", + "nullable": true, + "readOnly": true + }, + "displayName": { + "maxLength": 256, + "type": "string", + "nullable": true, + "readOnly": true + }, + "isEnabled": { + "type": "boolean", + "readOnly": true + }, + "description": { + "maxLength": 2048, + "type": "string", + "nullable": true, + "readOnly": true + }, + "type": { + "title": "IdentityProviderType", + "enum": [ + "InternalUserClientStorage", + "OpenIdConnect", + "SAML2P", + "LDAP", + "Windows" + ], + "type": "string", + "readOnly": true + }, + "separator": { + "maxLength": 1, + "type": "string", + "nullable": true, + "readOnly": true + }, + "usernameClaim": { + "maxLength": 256, + "type": "string", + "nullable": true, + "readOnly": true + }, + "fullNameClaim": { + "maxLength": 256, + "type": "string", + "nullable": true, + "readOnly": true + }, + "iconUrl": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "parameters": { + "title": "IdentityProviderParameters", + "type": "object", + "readOnly": true + }, + "redirectUrl": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "postLogoutRedirectUrl": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "validateUrl": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "createdBy": { + "type": "integer", + "format": "int32", + "nullable": true, + "readOnly": true + }, + "modifiedBy": { + "type": "integer", + "format": "int32", + "nullable": true, + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "id": { + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "readOnly": true + }, + "claimType": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "claimValue": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "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 + }, + "createdBy": { + "type": "integer", + "format": "int32", + "nullable": true, + "readOnly": true + }, + "modifiedBy": { + "type": "integer", + "format": "int32", + "nullable": true, + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "id": { + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "additionalProperties": false + }, + "LoginOption": { + "required": [ + "displayName" + ], + "type": "object", + "properties": { + "displayName": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "loginTriggerUrl": { + "type": "string", + "nullable": true + }, + "iconUrl": { + "type": "string", + "nullable": true + } + }, + "additionalProperties": false + }, + "UserClientSecret": { + "required": [ + "clientSecret", + "expiresAt" + ], + "type": "object", + "properties": { + "clientSecret": { + "maxLength": 4000, + "type": "string", + "nullable": true + }, + "clientSecretUnHashed": { + "type": "string", + "nullable": true + }, + "hint": { + "maxLength": 3, + "type": "string", + "nullable": true + }, + "expiresAt": { + "type": "string", + "format": "date-time" + }, + "id": { + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "additionalProperties": false + }, + "User": { + "required": [ + "identityProviderId", + "identityProviderKey", + "name", + "subject" + ], + "type": "object", + "properties": { + "name": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "email": { + "maxLength": 256, + "type": "string", + "format": "email", + "nullable": true + }, + "subject": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "identityProviderId": { + "type": "integer", + "format": "int32" + }, + "identityProviderKey": { + "maxLength": 256, + "type": "string", + "nullable": true + }, + "clientId": { + "type": "string", + "nullable": true + }, + "lastLoginAt": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "clientSecrets": { + "maxLength": 2, + "type": "array", + "items": { + "$ref": "#/components/schemas/UserClientSecret" + }, + "nullable": true + }, + "createdBy": { + "type": "integer", + "format": "int32", + "nullable": true, + "readOnly": true + }, + "modifiedBy": { + "type": "integer", + "format": "int32", + "nullable": true, + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "id": { + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "additionalProperties": false + }, + "UserMapping": { + "required": [ + "userId" + ], + "type": "object", + "properties": { + "userId": { + "type": "integer", + "format": "int32" + }, + "user": { + "title": "User", + "required": [ + "identityProviderId", + "identityProviderKey", + "name", + "subject" + ], + "type": "object", + "properties": { + "name": { + "maxLength": 256, + "type": "string", + "nullable": true, + "readOnly": true + }, + "email": { + "maxLength": 256, + "type": "string", + "format": "email", + "nullable": true, + "readOnly": true + }, + "subject": { + "maxLength": 256, + "type": "string", + "nullable": true, + "readOnly": true + }, + "identityProviderId": { + "type": "integer", + "format": "int32", + "readOnly": true + }, + "identityProviderKey": { + "maxLength": 256, + "type": "string", + "nullable": true, + "readOnly": true + }, + "clientId": { + "type": "string", + "nullable": true, + "readOnly": true + }, + "lastLoginAt": { + "type": "string", + "format": "date-time", + "nullable": true, + "readOnly": true + }, + "clientSecrets": { + "maxLength": 2, + "type": "array", + "items": { + "$ref": "#/components/schemas/UserClientSecret" + }, + "nullable": true, + "readOnly": true + }, + "createdBy": { + "type": "integer", + "format": "int32", + "nullable": true, + "readOnly": true + }, + "modifiedBy": { + "type": "integer", + "format": "int32", + "nullable": true, + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "id": { + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "readOnly": true + }, + "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 + }, + "createdBy": { + "type": "integer", + "format": "int32", + "nullable": true, + "readOnly": true + }, + "modifiedBy": { + "type": "integer", + "format": "int32", + "nullable": true, + "readOnly": true + }, + "createdAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedAt": { + "type": "string", + "format": "date-time", + "readOnly": true + }, + "id": { + "type": "integer", + "format": "int32", + "readOnly": true + } + }, + "additionalProperties": false + } + } + } +} diff --git a/test/mock/v3/test-petstore.yaml b/test/mock/v3/test-petstore.yaml index b9f01109..b1b88ab5 100644 --- a/test/mock/v3/test-petstore.yaml +++ b/test/mock/v3/test-petstore.yaml @@ -1,11 +1,17 @@ -openapi: "3.0.0" +swagger: "2.0" info: version: 1.0.0 title: Swagger Petstore license: name: MIT -servers: - - url: http://petstore.swagger.io/v1 +host: petstore.swagger.io +basePath: /v1 +schemes: + - http +consumes: + - application/json +produces: + - application/json paths: /pets: get: @@ -14,45 +20,37 @@ paths: tags: - pets parameters: - - name: limit - in: query - description: How many items to return at one time (max 100) - required: false - schema: - type: integer - format: int32 + - name: limit + in: query + description: How many items to return at one time (max 100) + required: false + type: integer + format: int32 responses: - '200': + "200": description: A paged array of pets headers: x-next: + type: string description: A link to the next page of responses - schema: - type: string - content: - application/json: - schema: - $ref: "#/components/schemas/Pets" + schema: + $ref: '#/definitions/Pets' default: description: unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + schema: + $ref: '#/definitions/Error' post: summary: Create a pet operationId: createPets tags: - pets responses: - '201': + "201": description: Null response default: description: unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + schema: + $ref: '#/definitions/Error' /pets/{petId}: get: summary: Info for a specific pet @@ -60,52 +58,46 @@ paths: tags: - pets parameters: - - name: petId - in: path - required: true - description: The id of the pet to retrieve - schema: - type: string + - name: petId + in: path + required: true + description: The id of the pet to retrieve + type: string responses: - '200': + "200": description: Expected response to a valid request - content: - application/json: - schema: - $ref: "#/components/schemas/Pet" + schema: + $ref: '#/definitions/Pets' default: description: unexpected error - content: - application/json: - schema: - $ref: "#/components/schemas/Error" -components: - schemas: - Pet: - type: object - required: - - id - - name - properties: - id: - type: integer - format: int64 - name: - type: string - tag: - type: string - Pets: - type: array - items: - $ref: "#/components/schemas/Pet" - Error: - type: object - required: - - code - - message - properties: - code: - type: integer - format: int32 - message: - type: string + schema: + $ref: '#/definitions/Error' +definitions: + Pet: + type: "object" + required: + - id + - name + properties: + id: + type: integer + format: int64 + name: + type: string + tag: + type: string + Pets: + type: array + items: + $ref: '#/definitions/Pet' + Error: + type: "object" + required: + - code + - message + properties: + code: + type: integer + format: int32 + message: + type: string diff --git a/test/mock/v3/test-with-examples.json b/test/mock/v3/test-with-examples.json index efb437c6..4c610722 100644 --- a/test/mock/v3/test-with-examples.json +++ b/test/mock/v3/test-with-examples.json @@ -7,7 +7,7 @@ "paths": { "/": { "get": { - "operationId": "listVersionsv2", + "operationId": "listVersions", "summary": "List API versions", "responses": { "200": { @@ -64,7 +64,7 @@ }, "/v2": { "get": { - "operationId": "getVersionDetailsv2", + "operationId": "getVersionDetails", "summary": "Show API version details", "responses": { "200": {