{ "openapi" : "3.1.0", "components" : { "schemas" : { "AlarmAction" : { "type" : "string", "enum" : [ "Audio", "Display", "Email", "Custom" ] }, "AlarmReferenceProperty" : { "type" : "string", "enum" : [ "Start", "Due", "End" ] }, "ArchivedDeletionAllowance" : { "type" : "string", "enum" : [ "None", "DeleteLogical", "DeletePhysical", "Both" ] }, "AuthenticationIDType" : { "type" : "string", "enum" : [ "PIN", "CardId", "Custom" ] }, "BodyPart" : { "type" : "object", "properties" : { "contentDisposition" : { "$ref" : "#/components/schemas/ContentDisposition" }, "entity" : { }, "headers" : { "$ref" : "#/components/schemas/MultivaluedMapStringString" }, "mediaType" : { "$ref" : "#/components/schemas/MediaType" }, "messageBodyWorkers" : { "$ref" : "#/components/schemas/MessageBodyWorkers" }, "parent" : { "$ref" : "#/components/schemas/MultiPart" }, "providers" : { "$ref" : "#/components/schemas/Providers" }, "parameterizedHeaders" : { "$ref" : "#/components/schemas/MultivaluedMapStringParameterizedHeader" } } }, "BodyPartsList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BodyPart" } }, "BooleanParam" : { "type" : "object", "properties" : { "value" : { "type" : "boolean" } } }, "CalendarStatus" : { "type" : "string", "enum" : [ "NeedsAction", "Tentative", "Confirmed", "Cancelled", "Completed", "InProgress", "Draft", "Final" ] }, "CalendarType" : { "type" : "string", "enum" : [ "Event", "ToDo", "Journal", "FreeBusy", "Timezone", "Alarm" ] }, "CalendarUserType" : { "type" : "string", "enum" : [ "User", "UserInfo", "Position", "Group", "Resource", "Room", "Unknown", "GroupInfo" ] }, "CalendarVisibility" : { "type" : "string", "enum" : [ "Public", "Private", "Confidential" ] }, "ContentDisposition" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "parameters" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "fileName" : { "type" : "string" }, "creationDate" : { "type" : "string", "format" : "date", "examples" : [ "2022-03-10" ] }, "modificationDate" : { "type" : "string", "format" : "date", "examples" : [ "2022-03-10" ] }, "readDate" : { "type" : "string", "format" : "date", "examples" : [ "2022-03-10" ] }, "size" : { "type" : "integer", "format" : "int64" }, "encoded" : { "type" : "boolean" } } }, "DeletionPolicy" : { "type" : "string", "enum" : [ "DeleteLogical", "DeleteStateAware", "DeletePhysical" ] }, "MediaType" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "subtype" : { "type" : "string" }, "parameters" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "hash" : { "type" : "integer", "format" : "int32" }, "wildcardType" : { "type" : "boolean" }, "wildcardSubtype" : { "type" : "boolean" } } }, "MessageBodyWorkers" : { "type" : "object" }, "MultiPart" : { "type" : "object", "properties" : { "entity" : { }, "mediaType" : { "$ref" : "#/components/schemas/MediaType" }, "contentDisposition" : { "$ref" : "#/components/schemas/ContentDisposition" }, "headers" : { "$ref" : "#/components/schemas/MultivaluedMapStringString" }, "messageBodyWorkers" : { "$ref" : "#/components/schemas/MessageBodyWorkers" }, "parent" : { "$ref" : "#/components/schemas/MultiPart" }, "providers" : { "$ref" : "#/components/schemas/Providers" }, "parameterizedHeaders" : { "$ref" : "#/components/schemas/MultivaluedMapStringParameterizedHeader" }, "bodyParts" : { "$ref" : "#/components/schemas/BodyPartsList" } } }, "MultiPartStreamable" : { "type" : "object", "properties" : { "entity" : { }, "parent" : { "$ref" : "#/components/schemas/MultiPart" }, "contentDisposition" : { "$ref" : "#/components/schemas/ContentDisposition" }, "headers" : { "$ref" : "#/components/schemas/MultivaluedMapStringString" }, "mediaType" : { "$ref" : "#/components/schemas/MediaType" }, "messageBodyWorkers" : { "$ref" : "#/components/schemas/MessageBodyWorkers" }, "providers" : { "$ref" : "#/components/schemas/Providers" }, "parameterizedHeaders" : { "$ref" : "#/components/schemas/MultivaluedMapStringParameterizedHeader" }, "iterator" : { "type" : "object" } } }, "MultivaluedMapStringParameterizedHeader" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ParameterizedHeader" } } }, "MultivaluedMapStringString" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } }, "PDFACreationPolicy" : { "type" : "string", "enum" : [ "None", "Add", "Replace", "Exchange" ] }, "PDFAExceptionPolicy" : { "type" : "string", "enum" : [ "Fail", "UseCreationPolicy_None" ] }, "PDFA_XMPState" : { "type" : "string", "enum" : [ "None", "Consider" ] }, "ParameterizedHeader" : { "type" : "object", "properties" : { "value" : { "type" : "string" }, "parameters" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "ParticipationRole" : { "type" : "string", "enum" : [ "Chair", "Required", "Optional", "Information" ] }, "ParticipationStatus" : { "type" : "string", "enum" : [ "NeedsAction", "Accepted", "Declined", "Tentative", "Delegated", "Completed", "InProgress" ] }, "Providers" : { "type" : "object" }, "RecurrenceFrequency" : { "type" : "string", "enum" : [ "Secondly", "Minutely", "Hourly", "Daily", "Weekly", "Monthly", "Yearly" ] }, "RestCategoryTag" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int64" }, "color" : { "$ref" : "#/components/schemas/RestColor" }, "text" : { "type" : "string" }, "active" : { "type" : "boolean" }, "lastModified" : { "type" : "string" } } }, "RestColor" : { "type" : "object", "required" : [ "r", "g", "b" ], "properties" : { "r" : { "type" : "integer", "format" : "int32" }, "g" : { "type" : "integer", "format" : "int32" }, "b" : { "type" : "integer", "format" : "int32" } } }, "TransmitPolicy" : { "type" : "string", "enum" : [ "UP", "DOWN", "NONE" ] }, "WhoAmIDto" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "authenticationType" : { "type" : "string" }, "roles" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } }, "groups" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string" } } } }, "XmlArchivedDeletionAllowance" : { "type" : "string", "enum" : [ "None", "DeleteLogical", "DeletePhysical", "Both" ] }, "XmlAttachmentBehavior" : { "type" : "string", "enum" : [ "Link", "Copy", "Original", "None" ] }, "XmlAuthID" : { "type" : "object", "xml" : { "name" : "authid" }, "properties" : { "type" : { "$ref" : "#/components/schemas/AuthenticationIDType" }, "description" : { "type" : "string" }, "active" : { "type" : "boolean" }, "expirationDate" : { "type" : "object", "xml" : { "name" : "expirationdate" } } } }, "XmlAuthIDEx" : { "type" : "object", "xml" : { "name" : "authidex" }, "properties" : { "type" : { "$ref" : "#/components/schemas/AuthenticationIDType" }, "description" : { "type" : "string" }, "active" : { "type" : "boolean" }, "expirationDate" : { "type" : "object", "xml" : { "name" : "expirationdate" } }, "id" : { "type" : "string" }, "principalId" : { "type" : "string", "xml" : { "name" : "principalid" } }, "creationDate" : { "type" : "object", "xml" : { "name" : "creationdate" } }, "creator" : { "type" : "string" }, "lastModified" : { "type" : "object", "xml" : { "name" : "lastmodified" } } } }, "XmlAuthIDList" : { "type" : "object", "xml" : { "name" : "authidlist" }, "properties" : { "authIds" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlAuthIDEx" }, "xml" : { "name" : "authid" } } } }, "XmlAuthenticationInfo" : { "type" : "object", "xml" : { "name" : "authenticationinfo" }, "properties" : { "sessionPermissions" : { "type" : "object", "xml" : { "name" : "sessionpermissions" }, "$ref" : "#/components/schemas/XmlPermissionsList" }, "sessionPasswordRemainingDays" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "sessionpasswordremainingdays" } }, "sessionPasswordExpirationToWarn" : { "type" : "boolean", "xml" : { "name" : "sessionpasswordexpirationtowarn" } }, "sessionPasswordChangeAllowed" : { "type" : "boolean", "xml" : { "name" : "sessionpasswordchangeallowed" } }, "sessionPrincipalId" : { "type" : "string", "xml" : { "name" : "sessionprincipalid" } }, "sessionPositionIds" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "sessionpositionid" } }, "xml" : { "wrapped" : true, "name" : "sessionpositionids" } }, "sessionGroupIds" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "sessiongroupid" } }, "xml" : { "wrapped" : true, "name" : "sessiongroupids" } }, "sessionDefaultPositionId" : { "type" : "string", "xml" : { "name" : "sessiondefaultpositionid" } }, "sessionObjectclassToLayoutsMapping" : { "type" : "object", "xml" : { "name" : "sessionobjectclasstolayoutsmapping" }, "$ref" : "#/components/schemas/XmlObjectclassToLayoutsMapping" }, "sessionObjectclassToLayoutTypedVariousLayoutsMapping" : { "type" : "object", "xml" : { "name" : "sessionobjectclasstolayouttypedvariouslayoutsmapping" }, "$ref" : "#/components/schemas/XmlObjectclassToLayoutTypedVariousLayoutsMapping" } } }, "XmlAuthenticationType" : { "type" : "string", "enum" : [ "INTERN", "EXTERN" ] }, "XmlBasketBehavior" : { "type" : "string", "enum" : [ "ExistingFolderMustBeUsed", "ExistingFolderMustNotBeUsed" ] }, "XmlBlobEntry" : { "type" : "object", "xml" : { "name" : "blobentry" }, "properties" : { "key" : { "type" : "string", "description" : "the blob key", "examples" : [ "KEY" ], "xml" : { "attribute" : true } }, "data" : { "type" : "string", "format" : "binary", "description" : "the blob value" } } }, "XmlBusinessKeyRegulationPart" : { "type" : "object", "xml" : { "name" : "businesskeyregulationpart" }, "properties" : { "businessKeyPart" : { "type" : "string", "xml" : { "name" : "businesskeypart" } }, "regulationType" : { "type" : "string", "xml" : { "name" : "regulationtype" }, "$ref" : "#/components/schemas/XmlBusinessKeyRegulationType" }, "active" : { "type" : "boolean" } } }, "XmlBusinessKeyRegulationType" : { "type" : "string", "enum" : [ "Prefix", "Infix", "Suffix" ] }, "XmlBusinessProcess" : { "type" : "object", "xml" : { "name" : "businessprocess" }, "properties" : { "name" : { "type" : "string" }, "properties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlProperty", "xml" : { "name" : "property" } }, "xml" : { "wrapped" : true } } } }, "XmlBusinessProcessInstanceKey" : { "type" : "object", "xml" : { "name" : "businessprocessinstancekey" }, "properties" : { "id" : { "type" : "string", "xml" : { "attribute" : true } }, "documentAreaName" : { "type" : "string", "xml" : { "name" : "areaname" } }, "instanceType" : { "type" : "string", "xml" : { "name" : "type" } } } }, "XmlBusinessProcessMetadata" : { "type" : "object", "xml" : { "name" : "businessprocessmetadata" }, "properties" : { "processName" : { "type" : "string", "xml" : { "name" : "businessprocessname" } }, "displayNameId" : { "type" : "string", "xml" : { "name" : "displaynameid" } }, "descriptionId" : { "type" : "string", "xml" : { "name" : "descriptionid" } }, "creationDate" : { "type" : "object", "xml" : { "name" : "creationdate" } }, "lastModified" : { "type" : "object", "xml" : { "name" : "lastmodified" } }, "taskNames" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "tasknames" } }, "xml" : { "wrapped" : true, "name" : "tasknames" } }, "mappedLayouts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlMappedLayoutNames", "xml" : { "name" : "mappedlayouts" } }, "xml" : { "wrapped" : true, "name" : "mappedlayouts" } }, "taskMetadata" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlTaskMetadata", "xml" : { "name" : "taskmetadata" } }, "xml" : { "wrapped" : true, "name" : "taskmetadata" } }, "propertiesUsed" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "propertiesused" } }, "xml" : { "wrapped" : true, "name" : "propertiesused" } }, "active" : { "type" : "boolean" }, "activationDate" : { "type" : "object", "xml" : { "name" : "activationdate" } }, "lastStartDate" : { "type" : "object", "xml" : { "name" : "laststartdate" } }, "version" : { "type" : "integer", "format" : "int32" }, "startBehavior" : { "type" : "object", "xml" : { "name" : "startbehavior" }, "$ref" : "#/components/schemas/XmlProcessStartBehavior" }, "displayNameReferencePropertyName" : { "type" : "string", "xml" : { "name" : "displaynamereferencepropertyname" } }, "hasStartTask" : { "type" : "boolean", "xml" : { "name" : "hasstarttask" } }, "versionComment" : { "type" : "string", "xml" : { "name" : "versioncomment" } }, "moveToManagedBasket" : { "type" : "boolean", "xml" : { "name" : "movetomanagedbasket" } } } }, "XmlBusinessProcessMetadataList" : { "type" : "object", "xml" : { "name" : "businessprocessmetadatalist" }, "properties" : { "processMetadatas" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlBusinessProcessMetadata" }, "xml" : { "name" : "businessprocessmetadata" } } } }, "XmlBusinessProcessResult" : { "type" : "object", "xml" : { "name" : "businessprocessresult" }, "properties" : { "id" : { "type" : "string" }, "displayName" : { "type" : "string", "xml" : { "name" : "displayname" } }, "count" : { "type" : "integer", "format" : "int32" }, "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlBusinessProcessResultItem", "xml" : { "name" : "item" } }, "xml" : { "wrapped" : true } } } }, "XmlBusinessProcessResultItem" : { "type" : "object", "xml" : { "name" : "businessprocessresultitem" }, "properties" : { "businessProcessInstanceKey" : { "type" : "object", "xml" : { "name" : "businessprocessinstancekey" }, "$ref" : "#/components/schemas/XmlBusinessProcessInstanceKey" }, "properties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlProperty", "xml" : { "name" : "property" } }, "xml" : { "wrapped" : true } } } }, "XmlBusinessProcessStartTemplate" : { "type" : "object", "xml" : { "name" : "businessprocessstarttemplate" }, "properties" : { "name" : { "type" : "string" }, "displayNameId" : { "type" : "string", "xml" : { "name" : "displaynameid" } }, "descriptionId" : { "type" : "string", "xml" : { "name" : "descriptionid" } }, "processDefinition" : { "type" : "string", "xml" : { "name" : "businessprocessdefinition" } }, "basketObjectclass" : { "type" : "string", "xml" : { "name" : "basketobjectclass" } }, "properties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlProperty", "xml" : { "name" : "property" } }, "xml" : { "wrapped" : true } }, "associatedOrgEntityIds" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "associatedorgentityid" } }, "xml" : { "wrapped" : true, "name" : "associatedorgentityids" } }, "associatedRoleNames" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "associatedrolename" } }, "xml" : { "wrapped" : true, "name" : "associatedrolenames" } }, "lastModified" : { "type" : "object", "xml" : { "name" : "lastmodified" } } } }, "XmlBusinessProcessStartTemplateList" : { "type" : "object", "xml" : { "name" : "businessprocessstarttemplatelist" }, "properties" : { "businessprocessStartTemplates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlBusinessProcessStartTemplate" }, "xml" : { "name" : "businessprocessstarttemplate" } } } }, "XmlCalendar" : { "type" : "object", "xml" : { "name" : "calendar" }, "properties" : { "type" : { "$ref" : "#/components/schemas/CalendarType" }, "calendarId" : { "type" : "string", "xml" : { "name" : "calendarid" } }, "uid" : { "type" : "string" }, "sequence" : { "type" : "integer", "format" : "int32" }, "recurrenceDate" : { "type" : "object", "xml" : { "name" : "recurrencedate" }, "$ref" : "#/components/schemas/XmlCalendarDateTime" }, "method" : { "type" : "string" }, "initialCreator" : { "type" : "string", "xml" : { "name" : "initialcreator" } }, "creator" : { "type" : "string" }, "creationDate" : { "type" : "object", "xml" : { "name" : "creationdate" }, "$ref" : "#/components/schemas/XmlCalendarDateTime" }, "stampDate" : { "type" : "object", "xml" : { "name" : "stampdate" }, "$ref" : "#/components/schemas/XmlCalendarDateTime" }, "startDate" : { "type" : "object", "xml" : { "name" : "startdate" }, "$ref" : "#/components/schemas/XmlCalendarDateTime" }, "description" : { "type" : "string" }, "summary" : { "type" : "string" }, "attendees" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlCalendarAttendee" } }, "duration" : { "type" : "integer", "format" : "int32" }, "attachments" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlContentData" } }, "referencedResources" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlCalendarReference" }, "xml" : { "name" : "referencedresources" } }, "referencedProcesses" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlCalendarReference" }, "xml" : { "name" : "referencedprocesses" } }, "documentAreaName" : { "type" : "string", "xml" : { "name" : "documentareaname" } }, "classes" : { "type" : "array", "items" : { "type" : "string" } }, "enabled" : { "type" : "boolean" }, "protected_" : { "type" : "boolean", "xml" : { "name" : "protected" } }, "lastModified" : { "type" : "object", "xml" : { "name" : "lastmodified" }, "$ref" : "#/components/schemas/XmlCalendarDateTime" }, "organizer" : { "$ref" : "#/components/schemas/XmlCalendarUser" }, "endDate" : { "type" : "object", "xml" : { "name" : "enddate" }, "$ref" : "#/components/schemas/XmlCalendarDateTime" }, "categories" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "category" } }, "xml" : { "wrapped" : true } }, "visibility" : { "$ref" : "#/components/schemas/CalendarVisibility" }, "comment" : { "type" : "string" }, "geoX" : { "type" : "number", "format" : "double", "xml" : { "name" : "geox" } }, "geoY" : { "type" : "number", "format" : "double", "xml" : { "name" : "geoy" } }, "location" : { "type" : "string" }, "priority" : { "type" : "integer", "format" : "int32" }, "status" : { "$ref" : "#/components/schemas/CalendarStatus" }, "url" : { "type" : "string" }, "contact" : { "$ref" : "#/components/schemas/XmlCalendarUser" }, "resources" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "resource" } }, "xml" : { "wrapped" : true } }, "relations" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "relation" } }, "xml" : { "wrapped" : true } }, "recurrence" : { "$ref" : "#/components/schemas/XmlCalendarRecurrence" }, "pastRecurrenceDates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlCalendarInterval", "xml" : { "name" : "pastrecurrencedate" } }, "xml" : { "wrapped" : true, "name" : "pastrecurrencedates" } }, "futureRecurrenceDates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlCalendarInterval", "xml" : { "name" : "futurerecurrencedate" } }, "xml" : { "wrapped" : true, "name" : "futurerecurrencedates" } }, "relatedTo" : { "type" : "string", "xml" : { "name" : "relatedto" } }, "transparent" : { "type" : "boolean" }, "freeBusyTimes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlFreeBusyTime", "xml" : { "name" : "freebusytime" } }, "xml" : { "wrapped" : true, "name" : "freebusytimes" } }, "timeZoneId" : { "type" : "string", "xml" : { "name" : "timezoneid" } }, "timeZoneProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlTimeZoneProperty", "xml" : { "name" : "timezoneproperty" } }, "xml" : { "wrapped" : true, "name" : "timezoneproperties" } }, "completionDate" : { "type" : "object", "xml" : { "name" : "completiondate" }, "$ref" : "#/components/schemas/XmlCalendarDateTime" }, "completionRate" : { "type" : "number", "format" : "double", "xml" : { "name" : "completionrate" } }, "dueDate" : { "type" : "object", "xml" : { "name" : "duedate" }, "$ref" : "#/components/schemas/XmlCalendarDateTime" }, "action" : { "$ref" : "#/components/schemas/AlarmAction" }, "referenceProperty" : { "type" : "string", "xml" : { "name" : "referenceproperty" }, "$ref" : "#/components/schemas/AlarmReferenceProperty" }, "repetitions" : { "type" : "integer", "format" : "int32" }, "trigger" : { "type" : "integer", "format" : "int32" }, "triggerDates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlCalendarDateTime", "xml" : { "name" : "triggerdate" } }, "xml" : { "wrapped" : true, "name" : "triggerdates" } } } }, "XmlCalendarAttendee" : { "type" : "object", "xml" : { "name" : "calendarattendee" }, "properties" : { "attendee" : { "$ref" : "#/components/schemas/XmlCalendarUser" }, "replyExpected" : { "type" : "boolean", "xml" : { "name" : "replyexpected" } }, "status" : { "$ref" : "#/components/schemas/ParticipationStatus" }, "role" : { "$ref" : "#/components/schemas/ParticipationRole" } } }, "XmlCalendarDateTime" : { "type" : "object", "xml" : { "name" : "calendardatetime" }, "properties" : { "date" : { "$ref" : "#/components/schemas/XmlDate" }, "dateTime" : { "type" : "object", "xml" : { "name" : "datetime" } }, "timeZone" : { "type" : "string", "xml" : { "name" : "timezone" } }, "triggered" : { "type" : "boolean" } } }, "XmlCalendarInterval" : { "type" : "object", "xml" : { "name" : "calendarinterval" }, "properties" : { "start" : { "$ref" : "#/components/schemas/XmlCalendarDateTime" }, "end" : { "$ref" : "#/components/schemas/XmlCalendarDateTime" } } }, "XmlCalendarList" : { "type" : "object", "xml" : { "name" : "calendars" }, "properties" : { "calendars" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlCalendar" } } } }, "XmlCalendarPropertyDefinition" : { "type" : "object", "xml" : { "name" : "calendarpropertydefinition" }, "properties" : { "name" : { "type" : "string" }, "type" : { "$ref" : "#/components/schemas/XmlPropertyType" }, "displayNameId" : { "type" : "string", "xml" : { "name" : "displaynameid" } }, "descriptionId" : { "type" : "string", "xml" : { "name" : "descriptionid" } }, "typeDetails" : { "type" : "object", "xml" : { "name" : "typedetails" }, "$ref" : "#/components/schemas/XmlPropertyTypeDetails" }, "multiValueScope" : { "type" : "string", "xml" : { "name" : "multivaluescope" } }, "system" : { "type" : "boolean" } } }, "XmlCalendarPropertyDefinitionList" : { "type" : "object", "xml" : { "name" : "calendarpropertydefinitions" }, "properties" : { "calendarPropertyDefinitions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlCalendarPropertyDefinition" }, "xml" : { "name" : "calendarpropertydefinitions" } } } }, "XmlCalendarRecurrence" : { "type" : "object", "xml" : { "name" : "calendarrecurrence" }, "properties" : { "frequency" : { "$ref" : "#/components/schemas/RecurrenceFrequency" }, "end" : { "$ref" : "#/components/schemas/XmlCalendarDateTime" }, "repetitions" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "repititions" } }, "interval" : { "type" : "integer", "format" : "int32" }, "position" : { "type" : "integer", "format" : "int32" }, "includedDates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlCalendarInterval", "xml" : { "name" : "includeddate" } }, "xml" : { "wrapped" : true, "name" : "includeddates" } }, "excludedDates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlCalendarInterval", "xml" : { "name" : "excludeddate" } }, "xml" : { "wrapped" : true, "name" : "excludeddates" } } } }, "XmlCalendarReference" : { "type" : "object", "xml" : { "name" : "calendarreference" }, "properties" : { "referencedId" : { "type" : "integer", "format" : "int64", "xml" : { "name" : "referencedid" } }, "referencedSId" : { "type" : "string", "xml" : { "name" : "referencedsid" } }, "referencedProperty" : { "type" : "string", "xml" : { "name" : "referencedproperty" } } } }, "XmlCalendarResultItem" : { "type" : "object", "xml" : { "name" : "calendarresultitem" }, "properties" : { "id" : { "type" : "string" }, "properties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlProperty", "xml" : { "name" : "property" } }, "xml" : { "wrapped" : true } } } }, "XmlCalendarResults" : { "type" : "object", "xml" : { "name" : "calendarresult" }, "properties" : { "count" : { "type" : "integer", "format" : "int32" }, "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlCalendarResultItem", "xml" : { "name" : "item" } }, "xml" : { "wrapped" : true } } } }, "XmlCalendarUser" : { "type" : "object", "xml" : { "name" : "calendaruser" }, "properties" : { "referenceId" : { "type" : "string", "xml" : { "name" : "referenceid" } }, "type" : { "$ref" : "#/components/schemas/CalendarUserType" }, "uri" : { "type" : "string" }, "name" : { "type" : "string" }, "fullName" : { "type" : "string", "xml" : { "name" : "fullname" } }, "domainName" : { "type" : "string", "xml" : { "name" : "domainname" } }, "email" : { "type" : "string" } } }, "XmlClientType" : { "type" : "string", "enum" : [ "DESKTOP_ID", "WEBCLIENT_ID", "ASCENTCAPTURE_ID", "CUSTOM_ID", "COCKPIT_ID", "COCKPITWEB_ID", "MOBILE_ID", "WEB_ID", "EXPLORER_ID", "XTERNAL_CONNECTOR_ID", "DEVICE_ID", "COMMON_ID", "DYNAMIC_ID" ] }, "XmlCollaborationMessageAction" : { "type" : "string", "enum" : [ "Created", "Updated", "ContentUpdated", "Deleted" ] }, "XmlCommonMessageSetting" : { "type" : "object", "xml" : { "name" : "commonmessagesetting" }, "properties" : { "messageStoreSize" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "messagestoresize" } } } }, "XmlCommonSetting" : { "type" : "object", "xml" : { "name" : "commonsetting" }, "properties" : { "approximateCountLookAheadPages" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "approximatecountlookaheadpages" } }, "archivedDeletionAllowance" : { "type" : "string", "xml" : { "name" : "archiveddeletionallowance" }, "$ref" : "#/components/schemas/XmlArchivedDeletionAllowance" }, "deletionPolicy" : { "type" : "string", "xml" : { "name" : "deletionpolicy" }, "$ref" : "#/components/schemas/XmlDeletionPolicy" }, "excludeBusinessKeyRegulationParts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlBusinessKeyRegulationPart", "xml" : { "name" : "excludebusinesskeyregulationpart" } }, "xml" : { "wrapped" : true, "name" : "excludebusinesskeyregulationparts" } }, "extensionStates" : { "type" : "object", "xml" : { "name" : "extensionstates" }, "$ref" : "#/components/schemas/XmlExtensionStates" }, "fulltextSearchOrderEntityRelation" : { "type" : "string", "xml" : { "name" : "fulltextsearchorderentityrelation" }, "$ref" : "#/components/schemas/XmlFulltextSearchOrder" }, "fulltextSearchOrderRepository" : { "type" : "string", "xml" : { "name" : "fulltextsearchorderrepository" }, "$ref" : "#/components/schemas/XmlFulltextSearchOrder" }, "fulltextSearchOrderWorkflow" : { "type" : "string", "xml" : { "name" : "fulltextsearchorderworkflow" }, "$ref" : "#/components/schemas/XmlFulltextSearchOrder" }, "idleSessionLifeTime" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "idlesessionlifetime" } }, "includeBusinessKeyRegulationParts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlBusinessKeyRegulationPart", "xml" : { "name" : "includebusinesskeyregulationpart" } }, "xml" : { "wrapped" : true, "name" : "includebusinesskeyregulationparts" } }, "jdbcBatchSize" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "jdbcbatchsize" } }, "lastModified" : { "type" : "string", "xml" : { "name" : "lastmodified" } }, "masterdataReferenceIntegrity" : { "type" : "string", "xml" : { "name" : "masterdatareferenceintegrity" }, "$ref" : "#/components/schemas/XmlMasterdataReferenceIntegrity" }, "minimumPdfaVersionArchive" : { "type" : "string", "xml" : { "name" : "minimumpdfaversionarchive" }, "$ref" : "#/components/schemas/XmlPDFAVersion" }, "minimumPdfaVersionVirtualRendition" : { "type" : "string", "xml" : { "name" : "minimumpdfaversionvirtualrendition" }, "$ref" : "#/components/schemas/XmlPDFAVersion" }, "parallelSearchFetchSize" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "parallelsearchfetchsize" } }, "parallelSearchInClauseSize" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "parallelsearchinclausesize" } }, "parallelSearchMaxThreads" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "parallelsearchmaxthreads" } }, "pdfaCreationPolicy" : { "type" : "string", "xml" : { "name" : "pdfacreationpolicy" }, "$ref" : "#/components/schemas/XmlPDFACreationPolicy" }, "pdfaExceptionPolicy" : { "type" : "string", "xml" : { "name" : "pdfaexceptionpolicy" }, "$ref" : "#/components/schemas/XmlPDFAExceptionPolicy" }, "pdfRenditionSetting" : { "type" : "object", "xml" : { "name" : "pdfrenditionsetting" }, "$ref" : "#/components/schemas/XmlPdfRenditionSetting" }, "physicalDeleteThreshold" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "physicaldeletethreshold" } }, "previewSetting" : { "type" : "object", "xml" : { "name" : "previewsetting" }, "$ref" : "#/components/schemas/XmlPreviewSetting" }, "publishedResourcesDeleteThreshold" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "publishedresourcesdeletethreshold" } }, "searchPageSizeEntityRelationFulltextFactor" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "searchpagesizeentityrelationfulltextfactor" } }, "searchPageSizeRepositoryFulltextFactor" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "searchpagesizerepositoryfulltextfactor" } }, "searchPageSizeWorkflowFulltextFactor" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "searchpagesizeworkflowfulltextfactor" } }, "securitySetting" : { "type" : "object", "xml" : { "name" : "securitysetting" }, "$ref" : "#/components/schemas/XmlSecuritySetting" }, "subtypeSettings" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlSubtypeSetting", "xml" : { "name" : "subtypesetting" } }, "xml" : { "wrapped" : true, "name" : "subtypesettings" } }, "thumbnailSetting" : { "type" : "object", "xml" : { "name" : "thumbnailsetting" }, "$ref" : "#/components/schemas/XmlThumbnailSetting" }, "passwordHashAlgorithm" : { "$ref" : "#/components/schemas/XmlHashAlgorithm" } } }, "XmlComputedIndexingPropertyDefinition" : { "type" : "object", "xml" : { "name" : "computedindexingpropertydefinition" }, "properties" : { "name" : { "type" : "string" }, "type" : { "$ref" : "#/components/schemas/XmlPropertyType" }, "displayNameId" : { "type" : "string", "xml" : { "name" : "displaynameid" } }, "descriptionId" : { "type" : "string", "xml" : { "name" : "descriptionid" } }, "typeDetails" : { "type" : "object", "xml" : { "name" : "typedetails" }, "properties" : { "systemPropertyOnly" : { "type" : "boolean", "xml" : { "name" : "systempropertyonly" } }, "length" : { "type" : "integer", "format" : "int32" }, "doubleScale" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "doublescale" } }, "doublePrecision" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "doubleprecision" } } } }, "usageCategory" : { "type" : "string", "xml" : { "name" : "usagecategory" }, "$ref" : "#/components/schemas/XmlUsageCategory" }, "multiValueScope" : { "type" : "string", "xml" : { "name" : "multivaluescope" } }, "propertyStateDescription" : { "type" : "object", "xml" : { "name" : "propertystatedescription" }, "$ref" : "#/components/schemas/XmlPropertyStateDescription" }, "group" : { "type" : "string" }, "necessaryIndexingProperties" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "propertyname" } }, "xml" : { "wrapped" : true, "name" : "necessaryindexingproperties" } } } }, "XmlContentData" : { "type" : "object", "xml" : { "name" : "contentdata" }, "properties" : { "name" : { "type" : "string" }, "contentType" : { "type" : "string", "xml" : { "name" : "contenttype" } }, "data" : { "type" : "string", "format" : "binary" } } }, "XmlContentItemMetaData" : { "type" : "object", "xml" : { "name" : "contentitemmetadata" }, "properties" : { "index" : { "type" : "integer", "format" : "int32", "xml" : { "attribute" : true } }, "properties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlProperty", "xml" : { "name" : "property" } }, "xml" : { "wrapped" : true } } } }, "XmlContentMetadata" : { "type" : "object", "xml" : { "name" : "contentmetadata" }, "properties" : { "id" : { "type" : "string", "xml" : { "attribute" : true } }, "itemCount" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "itemcount" } }, "contentType" : { "type" : "string", "xml" : { "name" : "contenttype" } }, "length" : { "type" : "integer", "format" : "int64" }, "contentItems" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlContentItemMetaData", "xml" : { "name" : "contentitem" } }, "xml" : { "wrapped" : true, "name" : "contentitems" } } } }, "XmlContentSetting" : { "type" : "object", "xml" : { "name" : "contentsetting" }, "properties" : { "additionalContentTypes" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "string", "xml" : { "name" : "contenttype" } }, "xml" : { "wrapped" : true, "name" : "additionalcontenttypes" } }, "fileExtContentTypeMapping" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlFileExtContentType", "xml" : { "name" : "fileextcontenttype" } }, "xml" : { "wrapped" : true, "name" : "fileextcontenttypemapping" } }, "maxContentLength" : { "type" : "integer", "format" : "int64", "xml" : { "name" : "maxcontentlength" } }, "lastModified" : { "type" : "object", "xml" : { "name" : "lastmodified" } } } }, "XmlDate" : { "type" : "object", "properties" : { "value" : { "type" : "string" } } }, "XmlDeletionPolicy" : { "type" : "string", "enum" : [ "DeleteLogical", "DeleteStateAware", "DeletePhysical" ] }, "XmlDocumentArchiveType" : { "type" : "object", "xml" : { "name" : "documentarchivetype" }, "properties" : { "resourceArchiveType" : { "type" : "string", "xml" : { "name" : "resourcearchivetype" } }, "noteDepositType" : { "type" : "string", "xml" : { "name" : "notedeposittype" } }, "noteArchiveType" : { "type" : "string", "xml" : { "name" : "notearchivetype" } }, "resourceDepositType" : { "type" : "string", "xml" : { "name" : "resourcedeposittype" } }, "annotationDepositType" : { "type" : "string", "xml" : { "name" : "annotationteposittype" } }, "annotationArchiveType" : { "type" : "string", "xml" : { "name" : "annotationarchivetype" } }, "renditionDepositType" : { "type" : "string", "xml" : { "name" : "renditiondeposittype" } }, "renditionArchiveType" : { "type" : "string", "xml" : { "name" : "renditionarchivetype" } } } }, "XmlDocumentArea" : { "type" : "object", "xml" : { "name" : "docarea" }, "properties" : { "areaName" : { "type" : "string", "xml" : { "attribute" : true, "name" : "areaname" } }, "displayNameId" : { "type" : "string", "xml" : { "name" : "displaynameid" } }, "descriptionId" : { "type" : "string", "xml" : { "name" : "descriptionid" } }, "lockOwner" : { "type" : "string", "xml" : { "name" : "lockowner" } }, "rootFolderId" : { "type" : "string", "xml" : { "name" : "rootfolderid" } }, "personalFolderId" : { "type" : "string", "xml" : { "name" : "personalfolderid" } } } }, "XmlDocumentAreaList" : { "type" : "object", "xml" : { "name" : "docareas" }, "properties" : { "docAreas" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlDocumentArea" }, "xml" : { "name" : "docarea" } } } }, "XmlDocumentMetaData" : { "type" : "object", "xml" : { "name" : "documentmetadata" }, "properties" : { "objectclassname" : { "type" : "string" }, "properties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlProperty", "xml" : { "name" : "property" } }, "xml" : { "wrapped" : true } }, "contentProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlProperty", "xml" : { "name" : "contentproperty" } }, "xml" : { "wrapped" : true, "name" : "contentproperties" } }, "contentItemProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlPropertyList", "xml" : { "name" : "contentitemproperty" } }, "xml" : { "wrapped" : true, "name" : "contentitemproperties" } } } }, "XmlDocumentObjectclass" : { "type" : "object", "xml" : { "name" : "documentobjectclass" }, "properties" : { "name" : { "type" : "string" }, "displayNameId" : { "type" : "string", "xml" : { "name" : "displaynameid" } }, "descriptionId" : { "type" : "string", "xml" : { "name" : "descriptionid" } }, "associatedResourceType" : { "type" : "string", "xml" : { "name" : "associatedresourcetype" } }, "superposedPropertyStateDescriptions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlSuperposedPropertyStateDescription" }, "xml" : { "name" : "superposedpropertystatedescriptions" } }, "fulltextEnabled" : { "type" : "boolean", "xml" : { "name" : "fulltextenabled" } }, "fulltextIndexStartDate" : { "type" : "object", "xml" : { "name" : "fulltextindextstartdate" } }, "deletionPolicy" : { "type" : "string", "xml" : { "name" : "deletionpolicy" }, "$ref" : "#/components/schemas/DeletionPolicy" }, "rearchiveOnChangedArchiveType" : { "type" : "boolean", "xml" : { "name" : "rearchiveonchangedarchivetype" } }, "archivedDeletionAllowance" : { "type" : "string", "xml" : { "name" : "archiveddeletionallowance" }, "$ref" : "#/components/schemas/ArchivedDeletionAllowance" }, "system" : { "type" : "boolean" }, "archiveType" : { "type" : "object", "xml" : { "name" : "archivetype" }, "$ref" : "#/components/schemas/XmlDocumentArchiveType" }, "retentionPeriodSettingName" : { "type" : "string", "xml" : { "name" : "retentionperiodsettingname" } }, "preferredLinkObjectclassName" : { "type" : "string", "xml" : { "name" : "preferredlinkobjectclassname" } }, "oldVersionArchive" : { "type" : "boolean", "xml" : { "name" : "oldversionarchive" } }, "versioningContent" : { "type" : "boolean", "xml" : { "name" : "versioningcontent" } }, "header" : { "type" : "string" }, "footer" : { "type" : "string" }, "expirationRuleName" : { "type" : "string", "xml" : { "name" : "expirationrulename" } }, "retentionRuleName" : { "type" : "string", "xml" : { "name" : "retentionrulename" } }, "pdfaCreationPolicy" : { "type" : "string", "xml" : { "name" : "pdfacreationpolicy" }, "$ref" : "#/components/schemas/PDFACreationPolicy" }, "pdfaExceptionPolicy" : { "type" : "string", "xml" : { "name" : "pdfaexceptionpolicy" }, "$ref" : "#/components/schemas/PDFAExceptionPolicy" }, "createThumbnails" : { "type" : "boolean", "xml" : { "name" : "createthumbnails" } }, "associatedContentTypes" : { "type" : "array", "items" : { "type" : "string" }, "xml" : { "name" : "associatedcontenttypes" } }, "associatedDepositContentTypes" : { "type" : "array", "items" : { "type" : "string" }, "xml" : { "name" : "associateddepositcontenttypes" } }, "associatedArchiveContentTypes" : { "type" : "array", "items" : { "type" : "string" }, "xml" : { "name" : "associatedarchivecontenttypes" } }, "defaultDepositContentType" : { "type" : "string", "xml" : { "name" : "defaultdepositcontenttype" } }, "defaultArchiveContentType" : { "type" : "string", "xml" : { "name" : "defaultarchivecontenttype" } } } }, "XmlDocumentPermissions" : { "type" : "object", "xml" : { "name" : "documentpermissions" }, "properties" : { "customPermissions" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "permission" } }, "xml" : { "wrapped" : true, "name" : "custompermissions" } }, "areaName" : { "type" : "string", "xml" : { "name" : "areaname" } }, "objectclassName" : { "type" : "string", "xml" : { "name" : "objectclassname" } }, "readProperties" : { "type" : "boolean", "xml" : { "name" : "readproperties" } }, "writeProperties" : { "type" : "boolean", "xml" : { "name" : "writeproperties" } }, "changeObjectclass" : { "type" : "boolean", "xml" : { "name" : "changeobjectclass" } }, "readNote" : { "type" : "boolean", "xml" : { "name" : "readnote" } }, "writeNote" : { "type" : "boolean", "xml" : { "name" : "writenote" } }, "lock" : { "type" : "boolean" }, "delete" : { "type" : "boolean" }, "finalize" : { "type" : "boolean" }, "archive" : { "type" : "boolean" }, "move" : { "type" : "boolean" }, "deleteNote" : { "type" : "boolean", "xml" : { "name" : "deletenote" } }, "readContent" : { "type" : "boolean", "xml" : { "name" : "readcontent" } }, "writeContent" : { "type" : "boolean", "xml" : { "name" : "writecontent" } }, "readAnnotation" : { "type" : "boolean", "xml" : { "name" : "readannotation" } }, "writeAnnotation" : { "type" : "boolean", "xml" : { "name" : "writeannotation" } }, "readRendition" : { "type" : "boolean", "xml" : { "name" : "readrendition" } }, "writeRendition" : { "type" : "boolean", "xml" : { "name" : "writerendition" } }, "internalViewerPrint" : { "type" : "boolean", "xml" : { "name" : "internalviewerPrint" } }, "deleteAnnotation" : { "type" : "boolean", "xml" : { "name" : "deleteannotation" } }, "deleteRendition" : { "type" : "boolean", "xml" : { "name" : "deleterendition" } }, "writeArchivedContent" : { "type" : "boolean", "xml" : { "name" : "writearchivedcontent" } }, "writeArchivedProperties" : { "type" : "boolean", "xml" : { "name" : "writearchivedproperties" } }, "revertToVersion" : { "type" : "boolean", "xml" : { "name" : "reverttoversion" } } } }, "XmlDomain" : { "type" : "object", "xml" : { "name" : "domain" }, "properties" : { "domainName" : { "type" : "string", "xml" : { "attribute" : true, "name" : "domainname" } }, "displayNameId" : { "type" : "string", "xml" : { "name" : "displaynameid" } }, "descriptionId" : { "type" : "string", "xml" : { "name" : "descriptionid" } }, "system" : { "type" : "boolean" }, "default_" : { "type" : "boolean", "xml" : { "name" : "default" } }, "ldapServiceName" : { "type" : "string", "xml" : { "name" : "" } }, "gssRealmName" : { "type" : "string", "xml" : { "name" : "" } }, "authenticationType" : { "type" : "string", "xml" : { "name" : "authenticationtype" }, "$ref" : "#/components/schemas/XmlAuthenticationType" }, "protected_" : { "type" : "boolean", "xml" : { "name" : "protected" } }, "synchronized_" : { "type" : "boolean", "xml" : { "name" : "synchronized" } }, "clientAuthenticationEnabled" : { "type" : "boolean", "xml" : { "name" : "clientauthenticationenabled" } }, "userManagementRealmName" : { "type" : "string", "xml" : { "name" : "usermanagementrealmname" } }, "windowsPrincipalPrefix" : { "type" : "string", "xml" : { "name" : "windowsprincipalprefix" } }, "knmSettingName" : { "type" : "string", "xml" : { "name" : "knmsettingname" } }, "lastModified" : { "type" : "object", "xml" : { "name" : "lastmodified" } } } }, "XmlDomainList" : { "type" : "object", "xml" : { "name" : "domains" }, "properties" : { "domains" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlDomain" }, "xml" : { "name" : "domain" } } } }, "XmlElementKey" : { "type" : "object", "xml" : { "name" : "elementkey" }, "properties" : { "id" : { "type" : "string", "xml" : { "attribute" : true } }, "areaName" : { "type" : "string", "xml" : { "name" : "areaname" } }, "type" : { "type" : "string" } } }, "XmlExceptionLoggingGrade" : { "type" : "string", "enum" : [ "Normal", "Extended", "Verbose" ] }, "XmlExtensionStates" : { "type" : "object", "xml" : { "name" : "extensionstates" }, "properties" : { "annotationStateControl" : { "type" : "boolean", "xml" : { "name" : "annotationstatecontrol" } }, "notesStateControl" : { "type" : "boolean", "xml" : { "name" : "notesstatecontrol" } }, "renditionStateControl" : { "type" : "boolean", "xml" : { "name" : "renditionstatecontrol" } }, "annotationVersionControl" : { "type" : "boolean", "xml" : { "name" : "annotationversioncontrol" } }, "notesVersionControl" : { "type" : "boolean", "xml" : { "name" : "notesversioncontrol" } }, "renditionVersionControl" : { "type" : "boolean", "xml" : { "name" : "renditionversioncontrol" } }, "dropAdditionOnContentUpdate" : { "type" : "boolean", "xml" : { "name" : "dropadditiononcontentupdate" } } } }, "XmlFileExtContentType" : { "type" : "object", "xml" : { "name" : "fileextcontenttype" }, "properties" : { "fileExtension" : { "type" : "string", "xml" : { "name" : "extension" } }, "contentType" : { "type" : "string", "xml" : { "name" : "contenttype" } } } }, "XmlFolderArchiveType" : { "type" : "object", "xml" : { "name" : "folderarchivetype" }, "properties" : { "resourceArchiveType" : { "type" : "string", "xml" : { "name" : "resourcearchivetype" } }, "noteDepositType" : { "type" : "string", "xml" : { "name" : "notedeposittype" } }, "noteArchiveType" : { "type" : "string", "xml" : { "name" : "notearchivetype" } } } }, "XmlFolderObjectclass" : { "type" : "object", "xml" : { "name" : "folderobjectclass" }, "properties" : { "name" : { "type" : "string" }, "displayNameId" : { "type" : "string", "xml" : { "name" : "displaynameid" } }, "descriptionId" : { "type" : "string", "xml" : { "name" : "descriptionid" } }, "associatedResourceType" : { "type" : "string", "xml" : { "name" : "associatedresourcetype" } }, "superposedPropertyStateDescriptions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlSuperposedPropertyStateDescription" }, "xml" : { "name" : "superposedpropertystatedescriptions" } }, "fulltextEnabled" : { "type" : "boolean", "xml" : { "name" : "fulltextenabled" } }, "fulltextIndexStartDate" : { "type" : "object", "xml" : { "name" : "fulltextindextstartdate" } }, "deletionPolicy" : { "type" : "string", "xml" : { "name" : "deletionpolicy" }, "$ref" : "#/components/schemas/DeletionPolicy" }, "rearchiveOnChangedArchiveType" : { "type" : "boolean", "xml" : { "name" : "rearchiveonchangedarchivetype" } }, "archivedDeletionAllowance" : { "type" : "string", "xml" : { "name" : "archiveddeletionallowance" }, "$ref" : "#/components/schemas/ArchivedDeletionAllowance" }, "system" : { "type" : "boolean" }, "archiveType" : { "$ref" : "#/components/schemas/XmlFolderArchiveType" }, "preferredLinkObjectclassName" : { "type" : "string", "xml" : { "name" : "preferredlinkobjectclassname" } }, "allowedFolderObjectclassNames" : { "type" : "array", "items" : { "type" : "string" }, "xml" : { "name" : "allowedfolderobjectclassnames" } }, "allowedLinkObjectclassNames" : { "type" : "array", "items" : { "type" : "string" }, "xml" : { "name" : "allowedlinkobjectclassnames" } }, "allowedDocumentObjectclassNames" : { "type" : "array", "items" : { "type" : "string" }, "xml" : { "name" : "alloweddocumentobjectclassnames" } }, "allowAllFolderObjectclasses" : { "type" : "boolean", "xml" : { "name" : "allowallfolderobjectclasses" } }, "allowAllLinkObjectclasses" : { "type" : "boolean", "xml" : { "name" : "allowalllinkobjectclasses" } }, "allowAllDocumentObjectclasses" : { "type" : "boolean", "xml" : { "name" : "allowalldocumentobjectclasses" } }, "notAllowable" : { "type" : "boolean", "xml" : { "name" : "notallowable" } }, "folderTemplateName" : { "type" : "string", "xml" : { "name" : "foldertemplatename" } } } }, "XmlFolderPermissions" : { "type" : "object", "xml" : { "name" : "folderpermissions" }, "properties" : { "customPermissions" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "permission" } }, "xml" : { "wrapped" : true, "name" : "custompermissions" } }, "areaName" : { "type" : "string", "xml" : { "name" : "areaname" } }, "objectclassName" : { "type" : "string", "xml" : { "name" : "objectclassname" } }, "readProperties" : { "type" : "boolean", "xml" : { "name" : "readproperties" } }, "writeProperties" : { "type" : "boolean", "xml" : { "name" : "writeproperties" } }, "changeObjectclass" : { "type" : "boolean", "xml" : { "name" : "changeobjectclass" } }, "readNote" : { "type" : "boolean", "xml" : { "name" : "readnote" } }, "writeNote" : { "type" : "boolean", "xml" : { "name" : "writenote" } }, "lock" : { "type" : "boolean" }, "delete" : { "type" : "boolean" }, "finalize" : { "type" : "boolean" }, "archive" : { "type" : "boolean" }, "move" : { "type" : "boolean" }, "deleteNote" : { "type" : "boolean", "xml" : { "name" : "deletenote" } }, "createFolder" : { "type" : "boolean", "xml" : { "name" : "createfolder" } }, "createDocument" : { "type" : "boolean", "xml" : { "name" : "createdocument" } }, "createLink" : { "type" : "boolean", "xml" : { "name" : "createlink" } } } }, "XmlFormattedIndexingPropertyDefinition" : { "type" : "object", "xml" : { "name" : "formattedindexingpropertydefinition" }, "properties" : { "name" : { "type" : "string" }, "type" : { "$ref" : "#/components/schemas/XmlPropertyType" }, "displayNameId" : { "type" : "string", "xml" : { "name" : "displaynameid" } }, "descriptionId" : { "type" : "string", "xml" : { "name" : "descriptionid" } }, "typeDetails" : { "type" : "object", "xml" : { "name" : "typedetails" }, "properties" : { "systemPropertyOnly" : { "type" : "boolean", "xml" : { "name" : "systempropertyonly" } }, "length" : { "type" : "integer", "format" : "int32" }, "doubleScale" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "doublescale" } }, "doublePrecision" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "doubleprecision" } } } }, "usageCategory" : { "type" : "string", "xml" : { "name" : "usagecategory" }, "$ref" : "#/components/schemas/XmlUsageCategory" }, "multiValueScope" : { "type" : "string", "xml" : { "name" : "multivaluescope" } }, "propertyStateDescription" : { "$ref" : "#/components/schemas/XmlPropertyStateDescription" }, "group" : { "type" : "string" }, "system" : { "type" : "boolean" }, "queryOperand" : { "type" : "string", "xml" : { "name" : "queryoperand" } }, "lastModified" : { "type" : "object", "xml" : { "name" : "lastmodified" } } } }, "XmlFreeBusyTime" : { "type" : "object", "xml" : { "name" : "freebusytime" }, "properties" : { "interval" : { "$ref" : "#/components/schemas/XmlCalendarInterval" }, "busy" : { "type" : "boolean" } } }, "XmlFulltextPropertyDefinition" : { "type" : "object", "xml" : { "name" : "fulltextpropertydefinition" }, "properties" : { "name" : { "type" : "string" }, "type" : { "$ref" : "#/components/schemas/XmlPropertyType" }, "displayNameId" : { "type" : "string", "xml" : { "name" : "displaynameid" } }, "descriptionId" : { "type" : "string", "xml" : { "name" : "descriptionid" } }, "typeDetails" : { "type" : "object", "xml" : { "name" : "typedetails" }, "properties" : { "systemPropertyOnly" : { "type" : "boolean", "xml" : { "name" : "systempropertyonly" } }, "length" : { "type" : "integer", "format" : "int32" }, "doubleScale" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "doublescale" } }, "doublePrecision" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "doubleprecision" } } } } } }, "XmlFulltextSearchOrder" : { "type" : "string", "enum" : [ "FT", "DB" ] }, "XmlGlobalClientSetting" : { "type" : "object", "xml" : { "name" : "globalclientsetting" }, "properties" : { "clientId" : { "type" : "string", "xml" : { "name" : "clientid" } }, "value" : { "type" : "string", "format" : "binary" }, "lastModified" : { "type" : "object", "xml" : { "name" : "lastmodified" } } } }, "XmlGlobalClientSettingList" : { "type" : "object", "xml" : { "name" : "globalclientsettings" }, "properties" : { "globalClientSettings" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlGlobalClientSetting" }, "xml" : { "name" : "globalclientsetting" } } } }, "XmlGroup" : { "type" : "object", "xml" : { "name" : "group" }, "properties" : { "principalId" : { "type" : "string", "xml" : { "name" : "principalid" } }, "name" : { "type" : "string" }, "domainName" : { "type" : "string", "xml" : { "name" : "domainname" } }, "commonName" : { "type" : "string", "xml" : { "name" : "commonname" } }, "email" : { "type" : "string" }, "description" : { "type" : "string" }, "active" : { "type" : "boolean" }, "activationDate" : { "type" : "object", "xml" : { "name" : "activationdate" }, "$ref" : "#/components/schemas/XmlDate" }, "deactivationDate" : { "type" : "object", "xml" : { "name" : "deactivationdate" }, "$ref" : "#/components/schemas/XmlDate" }, "deactivationReason" : { "type" : "string", "xml" : { "name" : "deactivationreason" } }, "lastModified" : { "type" : "object", "xml" : { "name" : "lastmodified" } }, "imported" : { "type" : "boolean" }, "synchronized_" : { "type" : "boolean", "xml" : { "name" : "synchronized" } } } }, "XmlHashAlgorithm" : { "type" : "string", "enum" : [ "MD5", "SHA1", "SHA256", "SHA512" ] }, "XmlIndexingPropertyDefinition" : { "type" : "object", "xml" : { "name" : "indexingpropertydefinition" }, "properties" : { "name" : { "type" : "string" }, "type" : { "$ref" : "#/components/schemas/XmlPropertyType" }, "displayNameId" : { "type" : "string", "xml" : { "name" : "displaynameid" } }, "descriptionId" : { "type" : "string", "xml" : { "name" : "descriptionid" } }, "typeDetails" : { "type" : "object", "xml" : { "name" : "typedetails" }, "properties" : { "systemPropertyOnly" : { "type" : "boolean", "xml" : { "name" : "systempropertyonly" } }, "length" : { "type" : "integer", "format" : "int32" }, "doubleScale" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "doublescale" } }, "doublePrecision" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "doubleprecision" } } } }, "usageCategory" : { "type" : "string", "xml" : { "name" : "usagecategory" }, "$ref" : "#/components/schemas/XmlUsageCategory" }, "multiValueScope" : { "type" : "string", "xml" : { "name" : "multivaluescope" } }, "propertyStateDescription" : { "$ref" : "#/components/schemas/XmlPropertyStateDescription" }, "group" : { "type" : "string" }, "columnName" : { "type" : "string", "xml" : { "name" : "columnname" } }, "tableName" : { "type" : "string", "xml" : { "name" : "tablename" } }, "keyColumnName" : { "type" : "string", "xml" : { "name" : "keycolumnname" } }, "indexingReferenceKey" : { "type" : "string", "xml" : { "name" : "indexingreferencekey" } }, "masterdataReference" : { "type" : "object", "xml" : { "name" : "masterdatareference" }, "$ref" : "#/components/schemas/XmlMasterdataPropertyName" }, "system" : { "type" : "boolean" }, "virtual" : { "type" : "boolean" }, "originalClassName" : { "type" : "string", "xml" : { "name" : "originalclassname" } }, "originalAttributeName" : { "type" : "string", "xml" : { "name" : "originalattributename" } }, "transmitPolicy" : { "type" : "string", "xml" : { "name" : "transmitpolicy" }, "$ref" : "#/components/schemas/TransmitPolicy" }, "lastModified" : { "type" : "object", "xml" : { "name" : "lastmodified" } } } }, "XmlIntList" : { "type" : "object", "xml" : { "name" : "intlist" }, "properties" : { "intList" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" }, "xml" : { "name" : "int" } } } }, "XmlLayout" : { "type" : "object", "xml" : { "name" : "layout" }, "properties" : { "layoutName" : { "$ref" : "#/components/schemas/XmlLayoutName" }, "layoutMetadata" : { "type" : "object", "xml" : { "name" : "layoutmetadata" }, "$ref" : "#/components/schemas/XmlLayoutMetadata" }, "layoutData" : { "type" : "object", "xml" : { "name" : "layoutdata" }, "$ref" : "#/components/schemas/XmlLayoutData" }, "masterdataScopeName" : { "type" : "string", "xml" : { "name" : "masterdatascopename" } } } }, "XmlLayoutData" : { "type" : "object", "xml" : { "name" : "layoutdata" }, "properties" : { "layoutName" : { "$ref" : "#/components/schemas/XmlLayoutName" }, "blobEntries" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlBlobEntry", "xml" : { "name" : "blobentry" } }, "xml" : { "wrapped" : true, "name" : "blobentries" } } } }, "XmlLayoutList" : { "type" : "object", "xml" : { "name" : "layouts" }, "properties" : { "layouts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlLayout" }, "xml" : { "name" : "layout" } } } }, "XmlLayoutMetadata" : { "type" : "object", "xml" : { "name" : "layoutmetadata" }, "properties" : { "layoutName" : { "$ref" : "#/components/schemas/XmlLayoutName" }, "masterdataScopeName" : { "type" : "string", "xml" : { "name" : "masterdatascopename" } }, "lastModified" : { "type" : "object" }, "displayNameId" : { "type" : "string", "xml" : { "name" : "displaynameid" } }, "searchTemplate" : { "type" : "object", "xml" : { "name" : "searchtemplate" }, "$ref" : "#/components/schemas/XmlSearchTemplate" }, "versionCreator" : { "type" : "string" }, "versionComment" : { "type" : "string" }, "version" : { "type" : "integer", "format" : "int32" }, "assignable" : { "type" : "boolean" }, "propertiesUsed" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "string" } }, "xml" : { "wrapped" : true, "name" : "propertiesused" } }, "valueSetsUsed" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "string" } }, "xml" : { "wrapped" : true, "name" : "valuesetsused" } }, "layoutsUsed" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlLayoutName", "xml" : { "name" : "layout" } }, "xml" : { "wrapped" : true, "name" : "layoutsused" } }, "packetsUsed" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "string" } }, "xml" : { "wrapped" : true, "name" : "packetsused" } }, "embeddedLayoutTypes" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "string" } }, "xml" : { "wrapped" : true } }, "group" : { "type" : "string" }, "excludedClientTypes" : { "type" : "array", "uniqueItems" : true, "items" : { "$ref" : "#/components/schemas/XmlClientType", "xml" : { "name" : "clienttype" } }, "xml" : { "wrapped" : true, "name" : "excludedclienttypes" } }, "embeddedLayoutName" : { "type" : "object", "xml" : { "name" : "embeddedlayoutname" }, "properties" : { "name" : { "type" : "string", "xml" : { "attribute" : true } }, "clientType" : { "type" : "string", "xml" : { "name" : "clienttype" } }, "layoutType" : { "type" : "string", "xml" : { "name" : "layouttype" } } } }, "embeddedLayoutNameSet" : { "type" : "boolean", "xml" : { "name" : "embeddedlayoutnameset" } } } }, "XmlLayoutMetadataList" : { "type" : "object", "xml" : { "name" : "layoutmetadatas" }, "properties" : { "layoutMetadatas" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlLayoutMetadata" }, "xml" : { "name" : "layoutmetadata" } } } }, "XmlLayoutName" : { "type" : "object", "xml" : { "name" : "layoutname" }, "properties" : { "name" : { "type" : "string", "xml" : { "attribute" : true } }, "clientType" : { "type" : "string", "xml" : { "name" : "clienttype" } }, "layoutType" : { "type" : "string", "xml" : { "name" : "layouttype" } } } }, "XmlLayoutTypeMapping" : { "type" : "object", "xml" : { "name" : "layouttypemapping" }, "properties" : { "name" : { "type" : "string", "xml" : { "attribute" : true } }, "layoutNames" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlLayoutName", "xml" : { "name" : "layoutname" } }, "xml" : { "wrapped" : true, "name" : "layoutnames" } } } }, "XmlLinkArchiveType" : { "type" : "object", "xml" : { "name" : "linkarchivetype" }, "properties" : { "resourceArchiveType" : { "type" : "string", "xml" : { "name" : "resourcearchivetype" } }, "noteDepositType" : { "type" : "string", "xml" : { "name" : "notedeposittype" } }, "noteArchiveType" : { "type" : "string", "xml" : { "name" : "notearchivetype" } } } }, "XmlLinkObjectclass" : { "type" : "object", "xml" : { "name" : "linkobjectclass" }, "properties" : { "name" : { "type" : "string" }, "displayNameId" : { "type" : "string", "xml" : { "name" : "displaynameid" } }, "descriptionId" : { "type" : "string", "xml" : { "name" : "descriptionid" } }, "associatedResourceType" : { "type" : "string", "xml" : { "name" : "associatedresourcetype" } }, "superposedPropertyStateDescriptions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlSuperposedPropertyStateDescription" }, "xml" : { "name" : "superposedpropertystatedescriptions" } }, "fulltextEnabled" : { "type" : "boolean", "xml" : { "name" : "fulltextenabled" } }, "fulltextIndexStartDate" : { "type" : "object", "xml" : { "name" : "fulltextindextstartdate" } }, "deletionPolicy" : { "type" : "string", "xml" : { "name" : "deletionpolicy" }, "$ref" : "#/components/schemas/DeletionPolicy" }, "rearchiveOnChangedArchiveType" : { "type" : "boolean", "xml" : { "name" : "rearchiveonchangedarchivetype" } }, "archivedDeletionAllowance" : { "type" : "string", "xml" : { "name" : "archiveddeletionallowance" }, "$ref" : "#/components/schemas/ArchivedDeletionAllowance" }, "system" : { "type" : "boolean" }, "archiveType" : { "type" : "object", "xml" : { "name" : "archivetype" }, "$ref" : "#/components/schemas/XmlLinkArchiveType" }, "defaultReferenceType" : { "type" : "string", "xml" : { "name" : "defaultreferencetype" } } } }, "XmlLinkPermissions" : { "type" : "object", "xml" : { "name" : "linkpermissions" }, "properties" : { "customPermissions" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "permission" } }, "xml" : { "wrapped" : true, "name" : "custompermissions" } }, "areaName" : { "type" : "string", "xml" : { "name" : "areaname" } }, "objectclassName" : { "type" : "string", "xml" : { "name" : "objectclassname" } }, "readProperties" : { "type" : "boolean", "xml" : { "name" : "readproperties" } }, "writeProperties" : { "type" : "boolean", "xml" : { "name" : "writeproperties" } }, "changeObjectclass" : { "type" : "boolean", "xml" : { "name" : "changeobjectclass" } }, "readNote" : { "type" : "boolean", "xml" : { "name" : "readnote" } }, "writeNote" : { "type" : "boolean", "xml" : { "name" : "writenote" } }, "lock" : { "type" : "boolean" }, "delete" : { "type" : "boolean" }, "finalize" : { "type" : "boolean" }, "archive" : { "type" : "boolean" }, "move" : { "type" : "boolean" }, "deleteNote" : { "type" : "boolean", "xml" : { "name" : "deletenote" } }, "updateReferenceType" : { "type" : "boolean", "xml" : { "name" : "updatereferencetype" } } } }, "XmlMappedLayoutNames" : { "type" : "object", "xml" : { "name" : "mappedlayoutnames" }, "properties" : { "task" : { "type" : "string", "xml" : { "attribute" : true } }, "layoutNames" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlLayoutName", "xml" : { "name" : "layoutname" } }, "xml" : { "wrapped" : true, "name" : "layoutnames" } } } }, "XmlMasterdataKey" : { "type" : "object", "xml" : { "name" : "masterdatakey" }, "properties" : { "id" : { "type" : "string", "xml" : { "attribute" : true } }, "masterdataScopeName" : { "type" : "string", "xml" : { "name" : "masterdatascopename" } }, "ownerDocumentAreaName" : { "type" : "string", "xml" : { "name" : "ownerdocumentareaname" } } } }, "XmlMasterdataPropertyDefinition" : { "type" : "object", "xml" : { "name" : "masterdatapropertydefinition" }, "properties" : { "name" : { "type" : "string" }, "type" : { "$ref" : "#/components/schemas/XmlPropertyType" }, "displayNameId" : { "type" : "string", "xml" : { "name" : "displaynameid" } }, "descriptionId" : { "type" : "string", "xml" : { "name" : "descriptionid" } }, "typeDetails" : { "type" : "object", "xml" : { "name" : "typedetails" }, "properties" : { "systemPropertyOnly" : { "type" : "boolean", "xml" : { "name" : "systempropertyonly" } }, "length" : { "type" : "integer", "format" : "int32" }, "doubleScale" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "doublescale" } }, "doublePrecision" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "doubleprecision" } } } }, "masterdataScopeName" : { "type" : "string", "xml" : { "name" : "masterdatascopename" } }, "columnName" : { "type" : "string", "xml" : { "name" : "columnname" } }, "keyProperty" : { "type" : "boolean", "xml" : { "name" : "keyproperty" } }, "lastModified" : { "type" : "object", "xml" : { "name" : "lastmodified" } } } }, "XmlMasterdataPropertyName" : { "type" : "object", "xml" : { "name" : "masterdatapropertyname" }, "properties" : { "name" : { "type" : "string" }, "masterdataScopeName" : { "type" : "string", "xml" : { "name" : "masterdatascopename" } }, "ownerDocumentAreaName" : { "type" : "string", "xml" : { "name" : "ownerdocumentareaname" } } } }, "XmlMasterdataReferenceIntegrity" : { "type" : "string", "enum" : [ "Unchecked", "WriteOnly", "ReadWrite" ] }, "XmlMasterdataResult" : { "type" : "object", "xml" : { "name" : "masterdataresult" }, "properties" : { "id" : { "type" : "string" }, "displayName" : { "type" : "string", "xml" : { "name" : "displayname" } }, "count" : { "type" : "integer", "format" : "int32" }, "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlMasterdataResultItem", "xml" : { "name" : "item" } }, "xml" : { "wrapped" : true } } } }, "XmlMasterdataResultItem" : { "type" : "object", "xml" : { "name" : "masterdataresultitem" }, "properties" : { "masterdataKey" : { "$ref" : "#/components/schemas/XmlMasterdataKey" }, "properties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlProperty", "xml" : { "name" : "property" } }, "xml" : { "wrapped" : true } } } }, "XmlMasterdataScope" : { "type" : "object", "xml" : { "name" : "masterdatascope" }, "properties" : { "name" : { "type" : "string", "xml" : { "attribute" : true } }, "displayNameId" : { "type" : "string", "xml" : { "name" : "displaynameid" } }, "descriptionId" : { "type" : "string", "xml" : { "name" : "descriptionid" } }, "lastModified" : { "type" : "object", "xml" : { "name" : "lastmodified" } }, "ownerDocumentAreaName" : { "type" : "string", "xml" : { "name" : "ownerdocumentareaname" } }, "baseTableName" : { "type" : "string", "xml" : { "name" : "basetablename" } }, "writable" : { "type" : "boolean" }, "generateKey" : { "type" : "boolean", "xml" : { "name" : "generatekey" } }, "catalog" : { "type" : "string" }, "schema" : { "type" : "string" }, "group" : { "type" : "string" } } }, "XmlMasterdataScopeList" : { "type" : "object", "xml" : { "name" : "masterdatascopes" }, "properties" : { "masterdatascopes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlMasterdataScope" }, "xml" : { "name" : "masterdatascope" } } } }, "XmlObjectclass" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "displayNameId" : { "type" : "string", "xml" : { "name" : "displaynameid" } }, "descriptionId" : { "type" : "string", "xml" : { "name" : "descriptionid" } }, "associatedResourceType" : { "type" : "string", "xml" : { "name" : "associatedresourcetype" } }, "superposedPropertyStateDescriptions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlSuperposedPropertyStateDescription" }, "xml" : { "name" : "superposedpropertystatedescriptions" } }, "fulltextEnabled" : { "type" : "boolean", "xml" : { "name" : "fulltextenabled" } }, "fulltextIndexStartDate" : { "type" : "object", "xml" : { "name" : "fulltextindextstartdate" } }, "deletionPolicy" : { "type" : "string", "xml" : { "name" : "deletionpolicy" }, "$ref" : "#/components/schemas/DeletionPolicy" }, "rearchiveOnChangedArchiveType" : { "type" : "boolean", "xml" : { "name" : "rearchiveonchangedarchivetype" } }, "archivedDeletionAllowance" : { "type" : "string", "xml" : { "name" : "archiveddeletionallowance" }, "$ref" : "#/components/schemas/ArchivedDeletionAllowance" }, "system" : { "type" : "boolean" } } }, "XmlObjectclassList" : { "type" : "object", "xml" : { "name" : "objectclasslist" }, "properties" : { "documentObjectclasses" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlDocumentObjectclass", "xml" : { "name" : "documentobjectclasses" } }, "xml" : { "wrapped" : true, "name" : "documentobjectclasses" } }, "folderObjectclasses" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlFolderObjectclass", "xml" : { "name" : "folderobjectclasses" } }, "xml" : { "wrapped" : true, "name" : "folderobjectclasses" } }, "linkObjectclasses" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlLinkObjectclass", "xml" : { "name" : "linkobjectclasses" } }, "xml" : { "wrapped" : true, "name" : "linkobjectclasses" } } } }, "XmlObjectclassToLayoutTypedVariousLayouts" : { "type" : "object", "xml" : { "name" : "objectclasstolayouttypedvariouslayouts" }, "properties" : { "areaName" : { "type" : "string", "xml" : { "name" : "areaname" } }, "objectclassName" : { "type" : "string", "xml" : { "name" : "objectclassname" } }, "layoutTypeMappings" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlLayoutTypeMapping", "xml" : { "name" : "layouttypemapping" } }, "xml" : { "wrapped" : true, "name" : "layouttypemappings" } } } }, "XmlObjectclassToLayoutTypedVariousLayoutsMapping" : { "type" : "object", "xml" : { "name" : "objectclasstolayouttypedvariouslayoutsmapping" }, "properties" : { "objectclassToLayoutTypedVariousLayouts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlObjectclassToLayoutTypedVariousLayouts" }, "xml" : { "name" : "objectclasstolayouttypedvariouslayout" } } } }, "XmlObjectclassToLayouts" : { "type" : "object", "xml" : { "name" : "objectclasstolayouts" }, "properties" : { "areaName" : { "type" : "string", "xml" : { "name" : "areaname" } }, "objectclassName" : { "type" : "string", "xml" : { "name" : "objectclassname" } }, "layoutNames" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlLayoutName", "xml" : { "name" : "layoutname" } }, "xml" : { "wrapped" : true, "name" : "layoutnames" } } } }, "XmlObjectclassToLayoutsMapping" : { "type" : "object", "xml" : { "name" : "objectclasstolayoutsmapping" }, "properties" : { "objectclassToLayouts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlObjectclassToLayouts" }, "xml" : { "name" : "objectclasstolayout" } } } }, "XmlPDFACreationPolicy" : { "type" : "string", "enum" : [ "None", "Add", "Replace", "Exchange" ] }, "XmlPDFAExceptionPolicy" : { "type" : "string", "enum" : [ "Fail", "UseCreationPolicy_None" ] }, "XmlPDFAVersion" : { "type" : "string", "enum" : [ "PDFA_1", "PDFA_2", "PDFA_3" ] }, "XmlPdfRenditionSetting" : { "type" : "object", "xml" : { "name" : "pdfrenditionsetting" }, "properties" : { "creationPolicy" : { "type" : "string", "xml" : { "name" : "creationpolicy" } }, "emailPDFRenderPolicy" : { "type" : "string", "xml" : { "name" : "emailpdfrenderpolicy" } }, "imageToPdfOcrPolicy" : { "type" : "string", "xml" : { "name" : "imagetopdfocrpolicy" } }, "maxDocumentAreaResources" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "maxdocumentarearesources" } }, "pdfaVersion" : { "type" : "string", "xml" : { "name" : "pdfaversion" }, "$ref" : "#/components/schemas/XmlPDFAVersion" }, "renditionServer" : { "type" : "string", "xml" : { "name" : "renditionserver" } }, "selectedContentTypes" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "selectedcontenttype" } }, "xml" : { "wrapped" : true, "name" : "selectedcontenttypes" } } } }, "XmlPermissionsList" : { "type" : "object", "xml" : { "name" : "permissionslist" }, "properties" : { "folderPermissions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlFolderPermissions", "xml" : { "name" : "folderpermission" } }, "xml" : { "wrapped" : true, "name" : "folderpermissions" } }, "documentPermissions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlDocumentPermissions", "xml" : { "name" : "documentpermission" } }, "xml" : { "wrapped" : true, "name" : "documentpermissions" } }, "linkPermissions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlLinkPermissions", "xml" : { "name" : "linkpermission" } }, "xml" : { "wrapped" : true, "name" : "linkpermissions" } }, "workflowPermissions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlWorkflowPermissions", "xml" : { "name" : "workflowpermission" } }, "xml" : { "wrapped" : true, "name" : "workflowpermissions" } } } }, "XmlPosition" : { "type" : "object", "xml" : { "name" : "position" }, "properties" : { "principalId" : { "type" : "string", "xml" : { "name" : "principalid" } }, "name" : { "type" : "string" }, "domainName" : { "type" : "string", "xml" : { "name" : "domainname" } }, "commonName" : { "type" : "string", "xml" : { "name" : "commonname" } }, "email" : { "type" : "string" }, "description" : { "type" : "string" }, "active" : { "type" : "boolean" }, "activationDate" : { "type" : "object", "xml" : { "name" : "activationdate" }, "$ref" : "#/components/schemas/XmlDate" }, "deactivationDate" : { "type" : "object", "xml" : { "name" : "deactivationdate" }, "$ref" : "#/components/schemas/XmlDate" }, "deactivationReason" : { "type" : "string", "xml" : { "name" : "deactivationreason" } }, "lastModified" : { "type" : "object", "xml" : { "name" : "lastmodified" } }, "default_" : { "type" : "boolean", "xml" : { "name" : "default" } }, "userId" : { "type" : "string", "xml" : { "name" : "userid" } } } }, "XmlPreviewSetting" : { "type" : "object", "xml" : { "name" : "previewsetting" }, "properties" : { "selectedContentTypes" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "selectedcontenttype" } }, "xml" : { "wrapped" : true, "name" : "selectedcontenttypes" } }, "previewResolution" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "previewresolution" } }, "renditionServer" : { "type" : "string", "xml" : { "name" : "renditionserver" } }, "maxDocumentAreaResources" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "maxdocumentarearesources" } } } }, "XmlPrincipalCollaborationMessage" : { "type" : "object", "xml" : { "name" : "principalcollaborationmessage" }, "properties" : { "element" : { "$ref" : "#/components/schemas/XmlElementKey" }, "name" : { "type" : "string" }, "collaborationMessageAction" : { "$ref" : "#/components/schemas/XmlCollaborationMessageAction" } } }, "XmlPrincipalEntityItem" : { "type" : "object", "xml" : { "name" : "principalentityitem" }, "properties" : { "pid" : { "type" : "string", "xml" : { "attribute" : true } }, "type" : { "type" : "string", "xml" : { "attribute" : true } }, "properties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlProperty", "xml" : { "name" : "property" } }, "xml" : { "wrapped" : true } } } }, "XmlPrincipalEntityList" : { "type" : "object", "xml" : { "name" : "principalentitylist" }, "properties" : { "users" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlUser", "xml" : { "name" : "user" } }, "xml" : { "wrapped" : true } }, "groups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlGroup", "xml" : { "name" : "group" } }, "xml" : { "wrapped" : true } }, "positions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlPosition", "xml" : { "name" : "position" } }, "xml" : { "wrapped" : true } } } }, "XmlPrincipalEntityResult" : { "type" : "object", "xml" : { "name" : "principalentityresult" }, "properties" : { "count" : { "type" : "integer", "format" : "int32" }, "principalEntityItems" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlPrincipalEntityItem", "xml" : { "name" : "item" } }, "xml" : { "wrapped" : true, "name" : "principalentityitems" } } } }, "XmlPrincipalMessageSetting" : { "type" : "object", "xml" : { "name" : "principalmessagesetting" }, "properties" : { "repository" : { "type" : "boolean" }, "workflow" : { "type" : "boolean" }, "collaboration" : { "type" : "boolean" } } }, "XmlPrincipalMessagesList" : { "type" : "object", "xml" : { "name" : "principalmessageslist" }, "properties" : { "principalResourceMessages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlPrincipalResourceMessage", "xml" : { "name" : "principalresourcemessages" } }, "xml" : { "wrapped" : true, "name" : "principalresourcemessages" } }, "principalWorkflowInstanceMessages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlPrincipalWorkflowInstanceMessage", "xml" : { "name" : "principalworkflowinstancemessages" } }, "xml" : { "wrapped" : true, "name" : "principalworkflowinstancemessages" } }, "principalCollaborationMessages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlPrincipalCollaborationMessage", "xml" : { "name" : "principalcollaborationmessages" } }, "xml" : { "wrapped" : true, "name" : "principalcollaborationmessages" } } } }, "XmlPrincipalResourceMessage" : { "type" : "object", "xml" : { "name" : "principalresourcemessage" }, "properties" : { "resource" : { "$ref" : "#/components/schemas/XmlResourceKey" }, "name" : { "type" : "string" }, "resourceMessageAction" : { "type" : "string", "xml" : { "name" : "resourcemessageaction" }, "$ref" : "#/components/schemas/XmlResourceMessageAction" } } }, "XmlPrincipalWorkflowInstanceMessage" : { "type" : "object", "xml" : { "name" : "principalworkflowinstancemessage" }, "properties" : { "workflow" : { "$ref" : "#/components/schemas/XmlWorkflowInstanceKey" }, "name" : { "type" : "string" }, "workflowInstanceMessageAction" : { "type" : "string", "xml" : { "name" : "workflowinstancemessageaction" }, "$ref" : "#/components/schemas/XmlWorkflowInstanceMessageAction" } } }, "XmlPriorityBehavior" : { "type" : "string", "enum" : [ "VeryHigh", "High", "Normal", "Low", "VeryLow" ] }, "XmlProcessMetadata" : { "type" : "object", "xml" : { "name" : "processmetadata" }, "properties" : { "processName" : { "type" : "string", "xml" : { "name" : "processname" } }, "displayNameId" : { "type" : "string", "xml" : { "name" : "displaynameid" } }, "descriptionId" : { "type" : "string", "xml" : { "name" : "descriptionid" } }, "definitionTypeId" : { "type" : "string", "xml" : { "name" : "definitiontypeid" } }, "creationDate" : { "type" : "object", "xml" : { "name" : "creationdate" } }, "lastModified" : { "type" : "object", "xml" : { "name" : "lastmodified" } }, "taskNames" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "tasknames" } }, "xml" : { "wrapped" : true, "name" : "tasknames" } }, "mappedLayouts" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlMappedLayoutNames", "xml" : { "name" : "mappedlayouts" } }, "xml" : { "wrapped" : true, "name" : "mappedlayouts" } }, "taskMetadata" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlTaskMetadata", "xml" : { "name" : "taskmetadata" } }, "xml" : { "wrapped" : true, "name" : "taskmetadata" } }, "propertiesUsed" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "propertiesused" } }, "xml" : { "wrapped" : true, "name" : "propertiesused" } }, "orgEntityIdsUsed" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "orgentityidsused" } }, "xml" : { "wrapped" : true, "name" : "orgentityidsused" } }, "active" : { "type" : "boolean" }, "activationDate" : { "type" : "object", "xml" : { "name" : "activationdate" } }, "lastStartDate" : { "type" : "object", "xml" : { "name" : "laststartdate" } }, "version" : { "type" : "integer", "format" : "int32" }, "startBehavior" : { "type" : "object", "xml" : { "name" : "startbehavior" }, "properties" : { "basketBehavior" : { "type" : "string", "xml" : { "name" : "basketbehavior" }, "$ref" : "#/components/schemas/XmlBasketBehavior" }, "attachmentBehavior" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlAttachmentBehavior" }, "xml" : { "name" : "attachmentbehavior" } }, "priorityBehavior" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlPriorityBehavior" }, "xml" : { "name" : "prioritybehavior" } }, "allowedFolderObjectclasses" : { "type" : "array", "items" : { "type" : "string" }, "xml" : { "name" : "allowedfolderobjectclasses" } }, "allowAllFolderObjectclasses" : { "type" : "boolean", "xml" : { "name" : "allowallfolderobjectclasses" } } } }, "allocableSubProcessDefinitions" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "allocablesubprocessdefinitions" } }, "xml" : { "wrapped" : true, "name" : "allocablesubprocessdefinitions" } }, "displayNameReferencePropertyName" : { "type" : "string", "xml" : { "name" : "displaynamereferencepropertyname" } }, "hasStartTask" : { "type" : "boolean", "xml" : { "name" : "hasstarttask" } }, "versionComment" : { "type" : "string", "xml" : { "name" : "versioncomment" } }, "moveToManagedBasket" : { "type" : "boolean", "xml" : { "name" : "movetomanagedbasket" } } } }, "XmlProcessMetadataList" : { "type" : "object", "xml" : { "name" : "processmetadatalist" }, "properties" : { "processMetadatas" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlProcessMetadata" }, "xml" : { "name" : "processmetadata" } } } }, "XmlProcessStartBehavior" : { "type" : "object", "xml" : { "name" : "processstartbehavior" }, "properties" : { "basketBehavior" : { "type" : "string", "xml" : { "name" : "basketbehavior" }, "$ref" : "#/components/schemas/XmlBasketBehavior" }, "attachmentBehavior" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlAttachmentBehavior" }, "xml" : { "name" : "attachmentbehavior" } }, "priorityBehavior" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlPriorityBehavior" }, "xml" : { "name" : "prioritybehavior" } }, "allowedFolderObjectclasses" : { "type" : "array", "items" : { "type" : "string" }, "xml" : { "name" : "allowedfolderobjectclasses" } }, "allowAllFolderObjectclasses" : { "type" : "boolean", "xml" : { "name" : "allowallfolderobjectclasses" } } } }, "XmlProperty" : { "type" : "object", "xml" : { "name" : "property" }, "properties" : { "name" : { "type" : "string", "description" : "the property name", "examples" : [ "displayname" ], "xml" : { "attribute" : true } }, "value" : { "description" : "the property name", "examples" : [ "my-value" ] } } }, "XmlPropertyDefinition" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "type" : { "$ref" : "#/components/schemas/XmlPropertyType" }, "displayNameId" : { "type" : "string", "xml" : { "name" : "displaynameid" } }, "descriptionId" : { "type" : "string", "xml" : { "name" : "descriptionid" } }, "typeDetails" : { "type" : "object", "xml" : { "name" : "typedetails" }, "properties" : { "systemPropertyOnly" : { "type" : "boolean", "xml" : { "name" : "systempropertyonly" } }, "length" : { "type" : "integer", "format" : "int32" }, "doubleScale" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "doublescale" } }, "doublePrecision" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "doubleprecision" } } } } } }, "XmlPropertyDefinitions" : { "type" : "object", "xml" : { "name" : "propertydefinitions" }, "properties" : { "indexingPropertyDefinitions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlIndexingPropertyDefinition", "xml" : { "name" : "indexingpropertydefinition" } }, "xml" : { "wrapped" : true, "name" : "indexingpropertydefinitions" } }, "formattedIndexingPropertyDefinitions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlFormattedIndexingPropertyDefinition", "xml" : { "name" : "formattedindexingpropertydefinition" } }, "xml" : { "wrapped" : true, "name" : "formattedindexingpropertydefinitions" } }, "computedIndexingPropertyDefinitions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlComputedIndexingPropertyDefinition", "xml" : { "name" : "computedindexingpropertydefinition" } }, "xml" : { "wrapped" : true, "name" : "computedindexingpropertydefinitions" } }, "fulltextPropertyDefinitions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlFulltextPropertyDefinition", "xml" : { "name" : "fulltextpropertydefinition" } }, "xml" : { "wrapped" : true, "name" : "fulltextpropertydefinitions" } }, "masterdataPropertyDefinitions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlMasterdataPropertyDefinition", "xml" : { "name" : "masterdatapropertydefinition" } }, "xml" : { "wrapped" : true, "name" : "masterdatapropertydefinitions" } } } }, "XmlPropertyList" : { "type" : "object", "xml" : { "name" : "properties" }, "properties" : { "properties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlProperty" }, "xml" : { "name" : "property" } } } }, "XmlPropertyStateDescription" : { "type" : "object", "xml" : { "name" : "propertystatedescription" }, "properties" : { "protected_" : { "type" : "boolean", "xml" : { "name" : "protected" } }, "selectable" : { "type" : "boolean" }, "searchable" : { "type" : "boolean" }, "sortable" : { "type" : "boolean" }, "headerState" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "headerstate" } }, "mandatory" : { "type" : "boolean" }, "free" : { "type" : "boolean" }, "newVersion" : { "type" : "boolean", "xml" : { "name" : "newversion" } }, "pdfaXmpState" : { "type" : "string", "xml" : { "name" : "pdfaxmpstate" }, "$ref" : "#/components/schemas/PDFA_XMPState" }, "audited" : { "type" : "boolean" } } }, "XmlPropertyType" : { "type" : "string", "enum" : [ "AreaQualifiedIdentifierType", "BlobType", "BooleanType", "DateType", "DoubleType", "IntegerType", "LongType", "StringType", "TimestampType" ] }, "XmlPropertyTypeDetails" : { "type" : "object", "xml" : { "name" : "propertytypedetails" }, "properties" : { "systemPropertyOnly" : { "type" : "boolean", "xml" : { "name" : "systempropertyonly" } }, "length" : { "type" : "integer", "format" : "int32" }, "doubleScale" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "doublescale" } }, "doublePrecision" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "doubleprecision" } } } }, "XmlPublishedResource" : { "type" : "object", "xml" : { "name" : "publishedresource" }, "properties" : { "uuid" : { "type" : "string", "xml" : { "attribute" : true } }, "resourceKey" : { "$ref" : "#/components/schemas/XmlResourceKey" }, "publisher" : { "type" : "string" }, "publisherName" : { "type" : "string", "xml" : { "name" : "publishername" } }, "publisherCommonName" : { "type" : "string", "xml" : { "name" : "publishercommonname" } }, "publishDate" : { "type" : "object", "xml" : { "name" : "publishdate" } }, "duration" : { "type" : "integer", "format" : "int32" }, "areaName" : { "type" : "string", "xml" : { "name" : "areaname" } }, "displayname" : { "type" : "string" }, "contentType" : { "type" : "string", "xml" : { "name" : "contenttype" } }, "lastModifiedDate" : { "type" : "object", "xml" : { "name" : "lastmodifieddate" } } } }, "XmlPublishedResourceList" : { "type" : "object", "xml" : { "name" : "publishedresourcelist" }, "properties" : { "publishedResource" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlPublishedResource" }, "xml" : { "name" : "publishedresource" } } } }, "XmlResourceKey" : { "type" : "object", "xml" : { "name" : "resourcekey" }, "properties" : { "id" : { "type" : "string", "description" : "resource id as string", "examples" : [ "DA$NOTSET$-1$1$NOTSET" ], "xml" : { "attribute" : true } }, "areaName" : { "type" : "string", "description" : "document area", "examples" : [ "DA" ], "xml" : { "name" : "areaname" } }, "type" : { "type" : "string", "description" : "resource type", "examples" : [ "FOLDER" ] } } }, "XmlResourceKeyList" : { "type" : "object", "xml" : { "name" : "resourcekeylist" }, "properties" : { "resourceKeys" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlResourceKey" }, "xml" : { "name" : "resourcekey" } } } }, "XmlResourceMessageAction" : { "type" : "string", "enum" : [ "Created", "Updated", "ContentUpdated", "Deleted" ] }, "XmlResourceMessageSetting" : { "type" : "object", "xml" : { "name" : "resourcemessagesetting" }, "properties" : { "messagePropertyNames" : { "type" : "array", "items" : { "type" : "string" }, "xml" : { "name" : "messagepropertyname" } }, "searchPropertyNames" : { "type" : "array", "items" : { "type" : "string" }, "xml" : { "name" : "searchpropertyname" } }, "propertyChangePropertyNames" : { "type" : "array", "items" : { "type" : "string" }, "xml" : { "name" : "propertychangepropertyname" } }, "allPropertyChanges" : { "type" : "boolean", "xml" : { "name" : "allpropertychanges" } }, "contentPropertyChanges" : { "type" : "boolean", "xml" : { "name" : "contentpropertychanges" } }, "textPlainContentChangeAsPropertyChange" : { "type" : "boolean", "xml" : { "name" : "textplaincontentchangeaspropertychange" } }, "textPlainContentHeadOffSize" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "textplaincontentheadoffsize" } } } }, "XmlResourceResult" : { "description" : "result object of a search for resources", "type" : "object", "xml" : { "name" : "resourceresult" }, "properties" : { "id" : { "type" : "string", "description" : "source id", "examples" : [ "DA$NOTSET$-1$1$NOTSET" ] }, "displayName" : { "type" : "string", "description" : "source description", "examples" : [ "ResourceByLink" ], "xml" : { "name" : "displayname" } }, "count" : { "type" : "integer", "format" : "int32", "description" : "count of results", "examples" : [ 10 ] }, "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlResourceResultItem", "xml" : { "name" : "item" } }, "xml" : { "wrapped" : true } } } }, "XmlResourceResultItem" : { "type" : "object", "description" : "one result item of a search for resources", "xml" : { "name" : "resourceresultitem" }, "properties" : { "resourceKey" : { "description" : "resource key", "type" : "object", "examples" : [ "DA$NOTSET$11730$1$NOTSET" ], "xml" : { "name" : "resourcekey" }, "$ref" : "#/components/schemas/XmlResourceKey" }, "properties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlProperty" }, "description" : "list of properties", "xml" : { "wrapped" : true } } } }, "XmlRole" : { "description" : "role is used to assign permissions", "type" : "object", "xml" : { "name" : "role" }, "properties" : { "areaName" : { "type" : "string", "description" : "The document area name", "examples" : [ "DOCAREA" ], "xml" : { "name" : "areaname" } }, "roleName" : { "type" : "string", "description" : "The role name", "examples" : [ "ROLE_USER" ], "xml" : { "name" : "rolename" } }, "everyone" : { "type" : "boolean", "description" : "Indication whether this role is the role everyone" }, "systemAdmin" : { "type" : "boolean", "description" : "Indication whether this role is the role SystemAdmin", "xml" : { "name" : "systemadmin" } }, "descriptionId" : { "type" : "string", "description" : "The description id.", "xml" : { "name" : "descriptionid" } }, "displayNameId" : { "type" : "string", "description" : "The display name id.", "xml" : { "name" : "displaynameid" } }, "lastModified" : { "type" : "object", "description" : "The last modified date.", "xml" : { "name" : "lastmodified" } } } }, "XmlRoleList" : { "description" : "List of roles bag", "type" : "object", "xml" : { "name" : "roles" }, "properties" : { "roles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlRole" }, "description" : "The role list", "xml" : { "name" : "role" } } } }, "XmlSearchTemplate" : { "type" : "object", "xml" : { "name" : "searchtemplate" }, "properties" : { "searchTemplateType" : { "$ref" : "#/components/schemas/XmlSearchTemplateType" }, "searchName" : { "type" : "object", "xml" : { "name" : "searchname" }, "properties" : { "name" : { "type" : "string", "xml" : { "attribute" : true } }, "clientType" : { "type" : "string", "xml" : { "name" : "clienttype" } }, "layoutType" : { "type" : "string", "xml" : { "name" : "layouttype" } } } }, "hitlistName" : { "type" : "object", "xml" : { "name" : "hitlistname" }, "properties" : { "name" : { "type" : "string", "xml" : { "attribute" : true } }, "clientType" : { "type" : "string", "xml" : { "name" : "clienttype" } }, "layoutType" : { "type" : "string", "xml" : { "name" : "layouttype" } } } }, "includeSubFolders" : { "type" : "boolean", "xml" : { "name" : "includesubfolders" } }, "findFolders" : { "type" : "boolean", "xml" : { "name" : "findfolders" } }, "findDocuments" : { "type" : "boolean", "xml" : { "name" : "finddocuments" } }, "findLinks" : { "type" : "boolean", "xml" : { "name" : "findlinks" } }, "replacementForNavigation" : { "type" : "boolean", "xml" : { "name" : "replacementfornavigation" } }, "showSearchCriteria" : { "type" : "boolean", "xml" : { "name" : "showsearchcriteria" } }, "searchScopeDocumentArea" : { "type" : "boolean", "xml" : { "name" : "searchscopedocumentarea" } } } }, "XmlSearchTemplateType" : { "type" : "string", "enum" : [ "BasicSearchTemplate", "QuickSearchTemplate", "WorkflowBasicSearchTemplate", "WorkflowQuickSearchTemplate", "MasterdataBasicSearchTemplate" ] }, "XmlSecuritySetting" : { "type" : "object", "xml" : { "name" : "securitysetting" }, "properties" : { "strictConfigurationPermissions" : { "type" : "boolean", "xml" : { "name" : "strictconfigurationpermissions" } }, "ignorePermissionsOnReferenceResolving" : { "type" : "boolean", "xml" : { "name" : "ignorepermissionsonreferenceresolving" } }, "strictPrincipalInfoPermissions" : { "type" : "boolean", "xml" : { "name" : "strictprincipalinfopermissions" } }, "idAuthenticationEnabled" : { "type" : "boolean", "xml" : { "name" : "idauthenticationenabled" } }, "idAuthenticationDisableThreshold" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "idauthenticationdisablethreshold" } }, "restrictPrincipalEntityVisibility" : { "type" : "boolean", "xml" : { "name" : "restrictprincipalentityvisibility" } }, "strictResourceWithdrawPermissions" : { "type" : "boolean", "xml" : { "name" : "strictresourcewithdrawpermissions" } }, "disableAutomaticRelogin" : { "type" : "boolean", "xml" : { "name" : "disableautomaticrelogin" } }, "restrictAccessibleDocumentAreas" : { "type" : "boolean", "xml" : { "name" : "restrictaccessibledocumentareas" } }, "fuzzyAuthenticationFailedMessage" : { "type" : "boolean", "xml" : { "name" : "fuzzyauthenticationfailedmessage" } }, "strictCopyResourcePermissions" : { "type" : "boolean", "xml" : { "name" : "strictcopyresourcepermissions" } }, "strictMoveResourcePermissions" : { "type" : "boolean", "xml" : { "name" : "strictmoveresourcepermissions" } }, "exceptionLoggingGrade" : { "type" : "string", "xml" : { "name" : "exceptionlogginggrade" }, "$ref" : "#/components/schemas/XmlExceptionLoggingGrade" } } }, "XmlSessionInfo" : { "type" : "object", "xml" : { "name" : "sessioninfo" }, "properties" : { "principalId" : { "type" : "string", "xml" : { "name" : "principalid" } }, "userName" : { "type" : "string", "xml" : { "name" : "username" } }, "sessionId" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "sessionid" } }, "sessionCreationDate" : { "type" : "object", "xml" : { "name" : "sessioncreationdate" } }, "sessionIdleDate" : { "type" : "object", "xml" : { "name" : "sessionidledate" } }, "clientApplication" : { "type" : "string", "xml" : { "name" : "clientapplication" } }, "clientHost" : { "type" : "string", "xml" : { "name" : "clienthost" } }, "clientVersion" : { "type" : "string", "xml" : { "name" : "clientversion" } }, "serverName" : { "type" : "string", "xml" : { "name" : "servername" } } } }, "XmlSessionInfoList" : { "type" : "object", "xml" : { "name" : "sessioninfolist" }, "properties" : { "sessionInfo" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlSessionInfo" }, "xml" : { "name" : "sessioninfo" } } } }, "XmlStringList" : { "type" : "object", "xml" : { "name" : "stringlist" }, "properties" : { "elements" : { "type" : "array", "items" : { "type" : "string" }, "xml" : { "name" : "string" } } } }, "XmlSubtypeSetting" : { "type" : "object", "xml" : { "name" : "subtypesetting" }, "properties" : { "name" : { "type" : "string", "xml" : { "attribute" : true } }, "ignoreTextPlainEncodingRecognition" : { "type" : "boolean", "xml" : { "name" : "ignoretextplainencodingrecognition" } }, "handleArchiveAsNoContentUpdate" : { "type" : "boolean", "xml" : { "name" : "handlearchiveasnocontentupdate" } }, "autoAddDocumentAreaConfiguration" : { "type" : "boolean", "xml" : { "name" : "autoadddocumentareaconfiguration" } } } }, "XmlSuperposedPropertyStateDescription" : { "type" : "object", "xml" : { "name" : "superposedpropertystatedescription" }, "properties" : { "name" : { "type" : "string" }, "protected_" : { "type" : "boolean", "xml" : { "name" : "protected" } }, "headerState" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "headerstate" } }, "mandatory" : { "type" : "boolean" }, "free" : { "type" : "boolean" }, "newVersion" : { "type" : "boolean", "xml" : { "name" : "newversion" } }, "pdfaXmpState" : { "type" : "string", "xml" : { "name" : "pdfaxmpstate" }, "$ref" : "#/components/schemas/PDFA_XMPState" }, "audited" : { "type" : "boolean" } } }, "XmlSystemInfo" : { "type" : "object", "xml" : { "name" : "systeminfo" }, "properties" : { "version" : { "type" : "string" }, "systemId" : { "type" : "string", "xml" : { "name" : "systemid" } }, "serverTime" : { "type" : "object", "xml" : { "name" : "servertime" } }, "locales" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "locale" } }, "xml" : { "wrapped" : true } }, "fulltextActive" : { "type" : "boolean", "xml" : { "name" : "fulltextactive" } } } }, "XmlTaskLayoutNames" : { "type" : "object", "xml" : { "name" : "tasklayoutnames" }, "properties" : { "processName" : { "type" : "string", "xml" : { "name" : "processname" } }, "mappedLayoutNames" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlMappedLayoutNames", "xml" : { "name" : "mappedlayoutname" } }, "xml" : { "wrapped" : true, "name" : "mappedlayoutnames" } } } }, "XmlTaskLayoutNamesList" : { "type" : "object", "xml" : { "name" : "tasklayoutnameslist" }, "properties" : { "taskLayoutNames" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlTaskLayoutNames" }, "xml" : { "name" : "tasklayoutnames" } } } }, "XmlTaskMetadata" : { "type" : "object", "xml" : { "name" : "taskmetadata" }, "properties" : { "taskName" : { "type" : "string", "xml" : { "name" : "taskname" } }, "displayNameId" : { "type" : "string", "xml" : { "name" : "displaynameid" } }, "descriptionId" : { "type" : "string", "xml" : { "name" : "descriptionid" } }, "endLabelId" : { "type" : "string", "xml" : { "name" : "endlabelid" } } } }, "XmlThumbnailSetting" : { "type" : "object", "xml" : { "name" : "thumbnailsetting" }, "properties" : { "selectedContentTypes" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "selectedcontenttype" } }, "xml" : { "wrapped" : true, "name" : "selectedcontenttypes" } }, "thumbnailWidth" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "thumbnailwidth" } }, "renditionServer" : { "type" : "string", "xml" : { "name" : "renditionserver" } }, "maxDocumentAreaResources" : { "type" : "integer", "format" : "int32", "xml" : { "name" : "maxdocumentarearesources" } } } }, "XmlTimeZoneProperty" : { "type" : "object", "xml" : { "name" : "timezoneproperty" }, "properties" : { "startDate" : { "type" : "object", "xml" : { "name" : "startdate" }, "properties" : { "date" : { "$ref" : "#/components/schemas/XmlDate" }, "dateTime" : { "type" : "object", "xml" : { "name" : "datetime" } }, "timeZone" : { "type" : "string", "xml" : { "name" : "timezone" } }, "triggered" : { "type" : "boolean" } } }, "standard" : { "type" : "boolean" }, "offsetTo" : { "type" : "string", "xml" : { "name" : "offsetto" } }, "offsetFrom" : { "type" : "string", "xml" : { "name" : "offsetfrom" } }, "timeZone" : { "type" : "string", "xml" : { "name" : "timezone" } }, "recurrence" : { "$ref" : "#/components/schemas/XmlCalendarRecurrence" } } }, "XmlUsageCategory" : { "type" : "string", "enum" : [ "REPOSITORY", "WORKFLOW" ] }, "XmlUser" : { "type" : "object", "xml" : { "name" : "user" }, "properties" : { "principalId" : { "type" : "string", "xml" : { "name" : "principalid" } }, "name" : { "type" : "string" }, "domainName" : { "type" : "string", "xml" : { "name" : "domainname" } }, "commonName" : { "type" : "string", "xml" : { "name" : "commonname" } }, "email" : { "type" : "string" }, "description" : { "type" : "string" }, "active" : { "type" : "boolean" }, "activationDate" : { "type" : "object", "xml" : { "name" : "activationdate" }, "$ref" : "#/components/schemas/XmlDate" }, "deactivationDate" : { "type" : "object", "xml" : { "name" : "deactivationdate" }, "$ref" : "#/components/schemas/XmlDate" }, "deactivationReason" : { "type" : "string", "xml" : { "name" : "deactivationreason" } }, "lastModified" : { "type" : "object", "xml" : { "name" : "lastmodified" } }, "changePasswordAllowed" : { "type" : "boolean", "xml" : { "name" : "changepasswordallowed" } }, "mustChangePassword" : { "type" : "boolean", "xml" : { "name" : "mustchangepassword" } }, "passwordNeverExpires" : { "type" : "boolean", "xml" : { "name" : "passwordneverexpires" } }, "imported" : { "type" : "boolean" }, "synchronized_" : { "type" : "boolean", "xml" : { "name" : "synchronized" } }, "passwordExpirationDate" : { "type" : "object", "xml" : { "name" : "passwordexpirationdate" }, "$ref" : "#/components/schemas/XmlDate" } } }, "XmlValueSet" : { "type" : "object", "xml" : { "name" : "valueset" }, "properties" : { "name" : { "type" : "string" }, "lastModified" : { "type" : "object" }, "displayNameId" : { "type" : "string" }, "data" : { "type" : "string", "format" : "binary" } } }, "XmlValueSetList" : { "type" : "object", "xml" : { "name" : "valuesetlist" }, "properties" : { "valueSets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlValueSet" }, "xml" : { "name" : "valueset" } } } }, "XmlWorkflowInstanceAutoAddMode" : { "type" : "string", "enum" : [ "None", "Started" ] }, "XmlWorkflowInstanceKey" : { "type" : "object", "xml" : { "name" : "workflowinstancekey" }, "properties" : { "id" : { "type" : "string", "xml" : { "attribute" : true } }, "documentAreaName" : { "type" : "string", "xml" : { "name" : "areaname" } }, "instanceType" : { "type" : "string", "xml" : { "name" : "type" } } } }, "XmlWorkflowInstanceKeyList" : { "type" : "object", "xml" : { "name" : "workflowinstancekeylist" }, "properties" : { "workflowInstanceKeys" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlWorkflowInstanceKey" }, "xml" : { "name" : "workflowinstancekey" } } } }, "XmlWorkflowInstanceMessageAction" : { "type" : "string", "enum" : [ "Started", "Ended", "Updated", "Assigned" ] }, "XmlWorkflowMessageSetting" : { "type" : "object", "xml" : { "name" : "workflowmessagesetting" }, "properties" : { "messagePropertyNames" : { "type" : "array", "items" : { "type" : "string" }, "xml" : { "name" : "messagepropertyname" } }, "searchPropertyNames" : { "type" : "array", "items" : { "type" : "string" }, "xml" : { "name" : "searchpropertyname" } }, "propertyChangePropertyNames" : { "type" : "array", "items" : { "type" : "string" }, "xml" : { "name" : "propertychangepropertyname" } }, "allPropertyChanges" : { "type" : "boolean", "xml" : { "name" : "allpropertychanges" } }, "instanceAutoAddMode" : { "type" : "string", "xml" : { "name" : "instanceautoaddmode" }, "$ref" : "#/components/schemas/XmlWorkflowInstanceAutoAddMode" } } }, "XmlWorkflowPermissions" : { "type" : "object", "xml" : { "name" : "workflowpermissions" }, "properties" : { "customPermissions" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "permission" } }, "xml" : { "wrapped" : true, "name" : "custompermissions" } }, "areaName" : { "type" : "string", "xml" : { "name" : "areaname" } }, "wfname" : { "type" : "string" }, "start" : { "type" : "boolean" }, "writeProperties" : { "type" : "boolean", "xml" : { "name" : "writeproperties" } }, "suspend" : { "type" : "boolean" }, "resume" : { "type" : "boolean" }, "end" : { "type" : "boolean" }, "withdraw" : { "type" : "boolean" }, "reset" : { "type" : "boolean" }, "readTasks" : { "type" : "boolean", "xml" : { "name" : "readtasks" } }, "readProcesses" : { "type" : "boolean", "xml" : { "name" : "readprocesses" } } } }, "XmlWorkflowProcess" : { "type" : "object", "xml" : { "name" : "workflowprocess" }, "properties" : { "name" : { "type" : "string" }, "properties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlProperty", "xml" : { "name" : "property" } }, "xml" : { "wrapped" : true } } } }, "XmlWorkflowResult" : { "type" : "object", "xml" : { "name" : "workflowresult" }, "properties" : { "id" : { "type" : "string" }, "displayName" : { "type" : "string", "xml" : { "name" : "displayname" } }, "count" : { "type" : "integer", "format" : "int32" }, "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlWorkflowResultItem", "xml" : { "name" : "item" } }, "xml" : { "wrapped" : true } } } }, "XmlWorkflowResultItem" : { "type" : "object", "xml" : { "name" : "workflowresultitem" }, "properties" : { "workflowInstanceKey" : { "$ref" : "#/components/schemas/XmlWorkflowInstanceKey" }, "properties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlProperty", "xml" : { "name" : "property" } }, "xml" : { "wrapped" : true } } } }, "XmlWorkflowStartTemplate" : { "type" : "object", "xml" : { "name" : "workflowstarttemplate" }, "properties" : { "name" : { "type" : "string" }, "displayNameId" : { "type" : "string", "xml" : { "name" : "displaynameid" } }, "descriptionId" : { "type" : "string", "xml" : { "name" : "descriptionid" } }, "processDefinition" : { "type" : "string", "xml" : { "name" : "processdefinition" } }, "basketObjectclass" : { "type" : "string", "xml" : { "name" : "basketobjectclass" } }, "properties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlProperty", "xml" : { "name" : "property" } }, "xml" : { "wrapped" : true } }, "associatedOrgEntityIds" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "associatedorgentityid" } }, "xml" : { "wrapped" : true, "name" : "associatedorgentityids" } }, "associatedRoleNames" : { "type" : "array", "items" : { "type" : "string", "xml" : { "name" : "associatedrolename" } }, "xml" : { "wrapped" : true, "name" : "associatedrolenames" } }, "lastModified" : { "type" : "object", "xml" : { "name" : "lastmodified" } } } }, "XmlWorkflowStartTemplateList" : { "type" : "object", "xml" : { "name" : "workflowstarttemplatelist" }, "properties" : { "workflowStartTemplates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlWorkflowStartTemplate" }, "xml" : { "name" : "workflowstarttemplate" } } } } }, "securitySchemes" : { "basic" : { "type" : "http", "description" : "user/password authentication", "scheme" : "basic" }, "openId" : { "type" : "openIdConnect", "description" : "openid connect authentication", "scheme" : "openId" } } }, "info" : { "contact" : { "email" : "support@ceyoniq.com", "name" : "Ceyoniq Technology GmbH", "url" : "https://www.ceyoniq.com" }, "title" : "ApplicationLayer REST API", "version" : "10.0.1000" }, "servers" : [ { "url" : "http://localhost:8080/nscalealinst1/rest" }, { "url" : "https://localhost:8443/nscalealinst1/rest" } ], "security" : [ { "basic" : [ ] }, { "openid" : [ ] } ], "paths" : { "/ai/{path}" : { "put" : { "responses" : { "200" : { "description" : "OK" } } }, "post" : { "responses" : { "200" : { "description" : "OK" } } }, "patch" : { "responses" : { "200" : { "description" : "OK" } } }, "options" : { "responses" : { "200" : { "description" : "OK" } } }, "head" : { "responses" : { "200" : { "description" : "OK" } } }, "get" : { "responses" : { "200" : { "description" : "OK" } } }, "delete" : { "responses" : { "200" : { "description" : "OK" } } } }, "/application.wadl" : { "get" : { "responses" : { "200" : { "description" : "OK" } } } }, "/application.wadl/{path}" : { "get" : { "parameters" : [ { "name" : "path", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/authoritymanagement/roles" : { "get" : { "summary" : "Get system roles.", "tags" : [ "AuthorityManagementService" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlRoleList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlRoleList" } } } } }, "security" : [ { "basic" : [ ] } ] } }, "/authoritymanagement/roles/docarea/{docarea}" : { "get" : { "summary" : "Get the roles of a specific document area.", "tags" : [ "AuthorityManagementService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlRoleList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlRoleList" } } } } }, "security" : [ { "basic" : [ ] } ] } }, "/authoritymanagement/roles/docarea/{docarea}/name/{name}" : { "get" : { "summary" : " Get a role with a specific name for a specific document area.", "tags" : [ "AuthorityManagementService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlRole" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlRole" } } } } }, "security" : [ { "basic" : [ ] } ] } }, "/authoritymanagement/roles/docarea/{docarea}/principal/{id}" : { "get" : { "summary" : "Get the roles of a specific document area and a specific user.", "tags" : [ "AuthorityManagementService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlRoleList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlRoleList" } } } } }, "security" : [ { "basic" : [ ] } ] } }, "/businessprocess/docarea/{docarea}/process/{id}" : { "put" : { "summary" : "Updates business process properties of a specific business process.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "get" : { "summary" : "Retrieves a specific set of business process properties for the requested business process.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } }, "head" : { "summary" : "Checks whether a specific business process exists or not.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/businessprocess/docarea/{docarea}/process/{id}/end" : { "put" : { "summary" : "Ends the specific process (instance) while updating its properties.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } } }, "/businessprocess/docarea/{docarea}/process/{id}/lock" : { "put" : { "summary" : "Locks a business process.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/businessprocess/docarea/{docarea}/process/{id}/reset" : { "put" : { "summary" : " Resets the specified business process part(s) by deleting the error message(s) of the hung process.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } } }, "/businessprocess/docarea/{docarea}/process/{id}/resume" : { "put" : { "summary" : "Resumes the execution of the specified business process.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/businessprocess/docarea/{docarea}/process/{id}/suspend" : { "put" : { "summary" : "Suspends the execution of the specified business process.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/businessprocess/docarea/{docarea}/process/{id}/tasks" : { "get" : { "summary" : "Retrieves unfinished tasks for a specific business process.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessResult" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/businessprocess/docarea/{docarea}/process/{id}/unlock" : { "put" : { "summary" : "Unlocks a business process.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/businessprocess/docarea/{docarea}/process/{processId}/tags" : { "post" : { "summary" : "Adds given category tag for given entity.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "processId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/businessprocess/docarea/{docarea}/process/{processId}/tags/{tagId}" : { "delete" : { "summary" : "Removes given category tag from given entity if it is associated.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "processId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/businessprocess/docarea/{docarea}/processes" : { "post" : { "summary" : "Starts a process (instance) of a specified xml business process.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "creator", "in" : "query", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcess" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcess" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessInstanceKey" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessInstanceKey" } } } } } }, "get" : { "summary" : "Retrieves all unfinished business processes of the authenticated principal.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessResult" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/businessprocess/docarea/{docarea}/processes/search" : { "get" : { "summary" : "Searches the specified document area for business processes.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessResult" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/businessprocess/docarea/{docarea}/processes/search/aggregate" : { "get" : { "summary" : "Searches the specified document area for business processes by using aggregate functions.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessResult" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/businessprocess/docarea/{docarea}/task/{id}" : { "put" : { "summary" : "Updates properties of a specific task, process or node (instance).", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "get" : { "summary" : "Retrieves a specific set of business process properties for the requested task.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } }, "head" : { "summary" : "Checks whether a specific task exists or not.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/businessprocess/docarea/{docarea}/task/{id}/assign" : { "put" : { "summary" : "Assigns one or more positions to a specific business process task.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "position", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/businessprocess/docarea/{docarea}/task/{id}/assignpooled" : { "put" : { "summary" : "Assigns a business process task to a pool of specified positions or groups.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } } }, "/businessprocess/docarea/{docarea}/task/{id}/end" : { "put" : { "summary" : "Ends the specified task (instance) while updating its properties.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } } }, "/businessprocess/docarea/{docarea}/task/{processId}/tags" : { "post" : { "summary" : "Adds given category tag for given entity.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "processId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/businessprocess/docarea/{docarea}/task/{processId}/tags/{tagId}" : { "delete" : { "summary" : "Removes given category tag from given entity if it is associated.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "processId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/businessprocess/docarea/{docarea}/tasks" : { "get" : { "summary" : "Retrieves all business process tasks for a specific user.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "sortorder", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "type", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessResult" } } } } } } }, "/businessprocess/docarea/{docarea}/tasks/search" : { "get" : { "summary" : "Searches the specified document area for tasks, for a specific user.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessResult" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/businessprocess/docarea/{docarea}/tasks/search/aggregate" : { "get" : { "summary" : "Searches the specified document area for tasks by using aggregate functions.", "tags" : [ "BusinessProcessService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessResult" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/collaboration/calendars" : { "get" : { "summary" : "Searches for calendars, controlled by the specified query.", "tags" : [ "CollaborationService" ], "parameters" : [ { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlCalendarResults" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlCalendarResults" } } } } } }, "post" : { "summary" : "Creates a calendar from given properties.", "tags" : [ "CollaborationService" ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK" } } } }, "/collaboration/calendars/aggregate" : { "get" : { "summary" : "Searches for calendars by using aggregate functions.", "tags" : [ "CollaborationService" ], "parameters" : [ { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlCalendarResults" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlCalendarResults" } } } } } } }, "/collaboration/calendars/detect/{id}" : { "put" : { "summary" : " Detects future and past recurrence dates of given calendar.", "tags" : [ "CollaborationService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/collaboration/calendars/ics" : { "get" : { "summary" : "Searches for calendars, controlled by the specified query.", "tags" : [ "CollaborationService" ], "parameters" : [ { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/collaboration/calendars/id/{id}" : { "put" : { "summary" : "Updates a calendar from given properties.", "tags" : [ "CollaborationService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "get" : { "summary" : "Gets the calendar with given id.", "tags" : [ "CollaborationService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlCalendar" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlCalendar" } } } } } }, "delete" : { "summary" : "Deletes calendar with given id.", "tags" : [ "CollaborationService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/collaboration/calendars/propdefs" : { "get" : { "summary" : "Gets a list of all existing calendar property definitions.", "tags" : [ "CollaborationService" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlCalendarPropertyDefinitionList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlCalendarPropertyDefinitionList" } } } } } } }, "/collaboration/calendars/propdefs/name/{name}" : { "get" : { "summary" : "Gets the calendar property definition with given name.", "tags" : [ "CollaborationService" ], "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlCalendarPropertyDefinition" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlCalendarPropertyDefinition" } } } } } } }, "/collaboration/calendars/uid/{uid}" : { "get" : { "summary" : "Gets all calendars of given uid.", "tags" : [ "CollaborationService" ], "parameters" : [ { "name" : "uid", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlCalendarList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlCalendarList" } } } } } }, "delete" : { "summary" : "Deletes all calendars with given uid.", "tags" : [ "CollaborationService" ], "parameters" : [ { "name" : "uid", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/collaboration/tags" : { "post" : { "summary" : "Adds a category tag for current user.", "tags" : [ "CollaborationService" ], "responses" : { "200" : { "description" : "OK" } } }, "get" : { "summary" : "Gets the category tags of current user.", "tags" : [ "CollaborationService" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RestCategoryTag" } } } } } } } }, "/collaboration/tags/{tagId}" : { "put" : { "summary" : "Updates a category tag of current user.", "tags" : [ "CollaborationService" ], "parameters" : [ { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestCategoryTag" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestCategoryTag" } } } } } }, "patch" : { "summary" : "Patch a category tag of current user.", "tags" : [ "CollaborationService" ], "parameters" : [ { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestCategoryTag" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestCategoryTag" } } } } } }, "get" : { "summary" : "Gets the category tag with given id of current user.", "tags" : [ "CollaborationService" ], "parameters" : [ { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RestCategoryTag" } } } } } } }, "/collaboration/teamspaces" : { "get" : { "summary" : "Gets teamspace group ids of current user.", "tags" : [ "CollaborationService" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } } } } } }, "post" : { "summary" : "Creates a group which acts as a teamspace.", "tags" : [ "CollaborationService" ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlGroup" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlGroup" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlGroup" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlGroup" } } } } } } }, "/collaboration/teamspaces/docarea/{docarea}" : { "get" : { "summary" : "Gets the resource keys of all principal folders of teamspace groups of current user.", "tags" : [ "CollaborationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceKeyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceKeyList" } } } } } } }, "/collaboration/teamspaces/domain/{domain}" : { "get" : { "summary" : "Gets available teamspace group ids of given domain.", "tags" : [ "CollaborationService" ], "parameters" : [ { "name" : "domain", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } } } } } } }, "/collaboration/teamspaces/id/{id}" : { "put" : { "summary" : "Updates a teamspace group.", "tags" : [ "CollaborationService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlGroup" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlGroup" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "get" : { "summary" : "Gets the teamspace with given id.", "tags" : [ "CollaborationService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlGroup" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlGroup" } } } } } }, "delete" : { "summary" : "Drops teamspace group with given id.", "tags" : [ "CollaborationService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/collaboration/teamspaces/id/{id}/groupadmin" : { "delete" : { "summary" : "Removes the teamspace admin competences from specified organizational positions.", "tags" : [ "CollaborationService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "post" : { "summary" : "Adds the teamspace admin competences to a specified organizational positions.", "tags" : [ "CollaborationService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } } }, "required" : true }, "responses" : { "201" : { "description" : "Created" } } } }, "/configuration/commonsetting" : { "get" : { "summary" : "Gets global common configuration settings.", "tags" : [ "ConfigurationService" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlCommonSetting" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlCommonSetting" } } } } } } }, "/configuration/contentsetting" : { "put" : { "summary" : "Updates global content configuration settings.", "tags" : [ "ConfigurationService" ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlContentSetting" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlContentSetting" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "get" : { "summary" : "Gets global content configuration settings.", "tags" : [ "ConfigurationService" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlContentSetting" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlContentSetting" } } } } } } }, "/configuration/dictionary" : { "get" : { "summary" : "Gets the superposed dictionary of specified languages.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "locales", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/configuration/docarea/{docarea}/businessprocessdefinitions" : { "get" : { "summary" : "Retrieves the names of all available business processes.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "evaluatestart", "in" : "query", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } } } } } } }, "/configuration/docarea/{docarea}/businessprocessdefinitions/metadata" : { "get" : { "summary" : "Retrieves the metadata for all available business processes.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessMetadataList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessMetadataList" } } } } } } }, "/configuration/docarea/{docarea}/businessprocessdefinitions/metadata/businessprocessdefinition/{name}" : { "get" : { "summary" : "Retrieves the metadata for a specific business process identified by its name.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessMetadata" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessMetadata" } } } } } } }, "/configuration/docarea/{docarea}/businessprocessdefinitions/metadata/mobile" : { "get" : { "summary" : "Retrieve the metadata for all business processes with a mobile layout configured.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessMetadataList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessMetadataList" } } } } } } }, "/configuration/docarea/{docarea}/businessprocessdefinitions/mobile" : { "get" : { "summary" : "Retrieves the names of all business processes with a mobile layout configured.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "evaluatestart", "in" : "query", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } } } } } } }, "/configuration/docarea/{docarea}/businessprocessstarttemplates" : { "get" : { "summary" : "Gets a list of all business process start templates which have been configured in given document area.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "associated", "in" : "query", "schema" : { "$ref" : "#/components/schemas/BooleanParam" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessStartTemplateList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlBusinessProcessStartTemplateList" } } } } } } }, "/configuration/docarea/{docarea}/fulltextsetting" : { "get" : { "summary" : "Gets document area-specific fulltext configuration for specified document area.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/configuration/docarea/{docarea}/layoutmetadatas" : { "get" : { "summary" : "Gets a list of all available layout metadatas contained in the specified document area.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlLayoutMetadataList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlLayoutMetadataList" } } } } } } }, "/configuration/docarea/{docarea}/layoutmetadatas/name/{name}/clienttype/{clienttype}/layouttype/{layouttype}" : { "get" : { "summary" : "Gets a specific layout's metadata.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "clienttype", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "layouttype", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/configuration/docarea/{docarea}/layoutnames" : { "get" : { "summary" : "Gets a list of mapped layout-names from all available workflow process definitions.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlTaskLayoutNamesList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlTaskLayoutNamesList" } } } } } } }, "/configuration/docarea/{docarea}/layoutnames/name/{name}" : { "get" : { "summary" : "Get mapped layout-name from given process definition name.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlTaskLayoutNames" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlTaskLayoutNames" } } } } } } }, "/configuration/docarea/{docarea}/layouts" : { "get" : { "summary" : "Gets a list of all available layouts contained by the specified document area.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlLayoutList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlLayoutList" } } } } } } }, "/configuration/docarea/{docarea}/layouts/name/{name}/clienttype/{clienttype}/layouttype/{layouttype}" : { "get" : { "summary" : "Gets a layout specified by a layout name, a client type (Cockpit, Web,...) and the layout type.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "clienttype", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "layouttype", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/configuration/docarea/{docarea}/masterdatascopes" : { "get" : { "summary" : "Gets the masterdata scope specified by name plus document area the masterdata scope belongs to.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlMasterdataScopeList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlMasterdataScopeList" } } } } } } }, "/configuration/docarea/{docarea}/masterdatascopes/scope/{scope}" : { "get" : { "summary" : "Gets the masterdata scope specified by its name and the name of the document area the masterdata scope belongs to.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "scope", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlMasterdataScope" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlMasterdataScope" } } } } } } }, "/configuration/docarea/{docarea}/objectclasses" : { "get" : { "summary" : "Gets an object class specified by name.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlObjectclassList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlObjectclassList" } } } } } } }, "/configuration/docarea/{docarea}/objectclasses/name/{name}" : { "get" : { "summary" : "Gets all object classes contained by the specified document area.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlObjectclass" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlObjectclass" } } } } } } }, "/configuration/docarea/{docarea}/processdefinitions" : { "get" : { "summary" : " Retrieves the names of all available processes.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "evaluatestart", "in" : "query", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } } } } } } }, "/configuration/docarea/{docarea}/processdefinitions/metadata" : { "get" : { "summary" : "Retrieves the metadata for all available processes.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlProcessMetadataList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlProcessMetadataList" } } } } } } }, "/configuration/docarea/{docarea}/processdefinitions/metadata/mobile" : { "get" : { "summary" : "Retrieve the metadata for all processes with a mobile layout configured.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlProcessMetadataList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlProcessMetadataList" } } } } } } }, "/configuration/docarea/{docarea}/processdefinitions/metadata/processdefinition/{name}" : { "get" : { "summary" : "Retrieve the metadata for all processes with a mobile layout configured.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlProcessMetadata" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlProcessMetadata" } } } } } } }, "/configuration/docarea/{docarea}/processdefinitions/mobile" : { "get" : { "summary" : " Retrieves the names of all processes with a mobile layout configured.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "evaluatestart", "in" : "query", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } } } } } } }, "/configuration/docarea/{docarea}/propertydefinitions" : { "get" : { "summary" : "Gets a list of all available property definitions contained by the specified document area.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyDefinitions" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyDefinitions" } } } } } } }, "/configuration/docarea/{docarea}/propertydefinitions/computed" : { "get" : { "summary" : "Gets a list of all available computed indexing property definitions contained by the specified document area.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "usagecategory", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyDefinitions" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyDefinitions" } } } } } } }, "/configuration/docarea/{docarea}/propertydefinitions/formatted" : { "get" : { "summary" : "Gets a list of all available formatted indexing property definitions contained by the specified document area.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyDefinitions" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyDefinitions" } } } } } } }, "/configuration/docarea/{docarea}/propertydefinitions/fulltext" : { "get" : { "summary" : "Gets all property definitions for fulltext for the specified document area.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyDefinitions" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyDefinitions" } } } } } } }, "/configuration/docarea/{docarea}/propertydefinitions/indexing" : { "get" : { "summary" : "Gets a list of all available indexing property definitions contained by the specified document area.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "usagecategory", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyDefinitions" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyDefinitions" } } } } } } }, "/configuration/docarea/{docarea}/propertydefinitions/masterdata" : { "get" : { "summary" : "Gets a list of all available masterdata property definitions contained by all masterdata scopes of the specified document area.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyDefinitions" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyDefinitions" } } } } } } }, "/configuration/docarea/{docarea}/propertydefinitions/name/{name}" : { "get" : { "summary" : "Gets the abstract indexing property definition specified by its name.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyDefinition" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyDefinition" } } } } } } }, "/configuration/docarea/{docarea}/valuesets" : { "get" : { "summary" : "Gets a list of all available value sets contained by the specified document area.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlValueSetList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlValueSetList" } } } } } } }, "/configuration/docarea/{docarea}/valuesets/name/{name}" : { "get" : { "summary" : "Gets a value set specified by a value set name.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlValueSet" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlValueSet" } } } } } } }, "/configuration/docarea/{docarea}/workflowstarttemplates" : { "get" : { "summary" : "Gets a list of all workflow start templates which have been configured in given document area.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "associated", "in" : "query", "schema" : { "$ref" : "#/components/schemas/BooleanParam" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowStartTemplateList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowStartTemplateList" } } } } } } }, "/configuration/globalclientsetting" : { "put" : { "summary" : "Update existing global client settings.", "tags" : [ "ConfigurationService" ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlGlobalClientSettingList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlGlobalClientSettingList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "post" : { "summary" : "Adds new global client settings.", "tags" : [ "ConfigurationService" ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlGlobalClientSettingList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlGlobalClientSettingList" } } }, "required" : true }, "responses" : { "201" : { "description" : "Created" } } }, "get" : { "summary" : "Gets all global client settings, stored in application layer.", "tags" : [ "ConfigurationService" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlGlobalClientSettingList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlGlobalClientSettingList" } } } } } }, "delete" : { "summary" : "Deletes list of global client settings.", "tags" : [ "ConfigurationService" ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } } }, "/configuration/globalclientsetting/{id}" : { "put" : { "summary" : "Updates global client setting by given id. The value is plain text.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "post" : { "summary" : "Adds global client setting by given id. The value is plain text.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } }, "required" : true }, "responses" : { "201" : { "description" : "Created" } } }, "get" : { "summary" : "Gets the global client setting identified by clientId as plain text.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlGlobalClientSetting" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlGlobalClientSetting" } }, "text/plain" : { "schema" : { "type" : "string" } } } } } }, "delete" : { "summary" : "Deletes global client setting by given id.", "tags" : [ "ConfigurationService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/configuration/sysinfo" : { "get" : { "summary" : "Get system information.", "tags" : [ "ConfigurationService" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlSystemInfo" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlSystemInfo" } }, "text/plain" : { "schema" : { "type" : "string" } } } } } } }, "/login" : { "get" : { "tags" : [ "AuthenticationService" ], "parameters" : [ { "name" : "appid", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } }, "default" : { "description" : "The authentication info", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlAuthenticationInfo" } } } } }, "security" : [ { "basic" : [ ] } ], "summary" : "retrieve session permissions (and optional login)" } }, "/logout" : { "get" : { "summary" : "logout and remove http session", "tags" : [ "AuthenticationService" ], "responses" : { "200" : { "description" : "OK", "content" : { "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/masterdata/docarea/{docarea}/scope/{scope}" : { "get" : { "summary" : "Performs a masterdata search.", "tags" : [ "MasterdataService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "scope", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/atom+xml" : { "schema" : { "$ref" : "#/components/schemas/XmlMasterdataResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlMasterdataResult" } } } } } }, "post" : { "summary" : "Adds a new entry to the specified masterdata scope with given properties.", "tags" : [ "MasterdataService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "scope", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlMasterdataKey" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlMasterdataKey" } } } } } } }, "/masterdata/docarea/{docarea}/scope/{scope}/aggregate" : { "get" : { "summary" : "Performs a masterdata aggregated search.", "tags" : [ "MasterdataService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "scope", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/atom+xml" : { "schema" : { "$ref" : "#/components/schemas/XmlMasterdataResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlMasterdataResult" } } } } } } }, "/masterdata/docarea/{docarea}/scope/{scope}/id/{id}" : { "put" : { "summary" : "Updates the masterdata entry specified by its key with given properties.", "tags" : [ "MasterdataService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "scope", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "post" : { "summary" : "Adds masterdata properties with the specified masterdata key.", "tags" : [ "MasterdataService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "scope", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlMasterdataKey" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlMasterdataKey" } } } } } }, "get" : { "summary" : "Gets the specified properties of the masterdata entry specified by its key.", "tags" : [ "MasterdataService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "scope", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } } } } }, "head" : { "summary" : "Checks if the specified masterdata entry exists.", "tags" : [ "MasterdataService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "scope", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } }, "delete" : { "summary" : "Deletes the masterdata entry specified by its key.", "tags" : [ "MasterdataService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "scope", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/messaging/docarea/{docarea}/messages" : { "get" : { "summary" : "Gets feed for given area name.", "tags" : [ "MessagingService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "agent", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "linktypes", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "type", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/messaging/docarea/{docarea}/settings" : { "put" : { "summary" : "Sets a new common message setting for the signed in user.", "tags" : [ "MessagingService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlCommonMessageSetting" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlCommonMessageSetting" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "get" : { "summary" : "Retrieves the personal common message settings.", "tags" : [ "MessagingService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlCommonMessageSetting" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlCommonMessageSetting" } } } } } }, "delete" : { "summary" : "Deletes the personal common message setting.", "tags" : [ "MessagingService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/messaging/docarea/{docarea}/settings/resource" : { "put" : { "summary" : "Sets a new resource message setting for the signed in user.", "tags" : [ "MessagingService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceMessageSetting" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceMessageSetting" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "get" : { "summary" : "Retrieves the personal resource message setting.", "tags" : [ "MessagingService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceMessageSetting" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceMessageSetting" } } } } } }, "delete" : { "summary" : "Deletes the personal resource message setting.", "tags" : [ "MessagingService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/messaging/docarea/{docarea}/settings/workflow" : { "put" : { "summary" : "Sets a new workflow message setting for the signed in user.", "tags" : [ "MessagingService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowMessageSetting" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowMessageSetting" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "get" : { "summary" : "Retrieves the personal workflow message setting.", "tags" : [ "MessagingService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowMessageSetting" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowMessageSetting" } } } } } }, "delete" : { "summary" : "Deletes the personal workflow message setting.", "tags" : [ "MessagingService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/messaging/docarea/{docarea}/subscription/resource" : { "get" : { "summary" : "Retrieves the subscribed repository resource of the current user.", "tags" : [ "MessagingService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/messaging/docarea/{docarea}/subscription/resource/{id}" : { "delete" : { "summary" : "Removes repository resources from the subscription of the current user.", "tags" : [ "MessagingService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } }, "put" : { "summary" : "Adds repository resources to the subscription of the current user.", "tags" : [ "MessagingService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/messaging/docarea/{docarea}/subscription/workflowinstance" : { "get" : { "summary" : "Retrieves the subscribed workflows of the current user.", "tags" : [ "MessagingService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowInstanceKeyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowInstanceKeyList" } } } } } } }, "/messaging/docarea/{docarea}/subscription/workflowinstance/{id}" : { "delete" : { "summary" : "Removes workflows from the subscription of the current user.", "tags" : [ "MessagingService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } }, "put" : { "summary" : "Adds workflows to the subscription of the current user.", "tags" : [ "MessagingService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/messaging/messages" : { "get" : { "summary" : "Retrieves document area independent messages.", "tags" : [ "MessagingService" ], "parameters" : [ { "name" : "agent", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "linktypes", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "type", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalMessagesList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalMessagesList" } } } } } } }, "/messaging/settings" : { "put" : { "summary" : "Sets a new document area independent common message setting for the signed in user.", "tags" : [ "MessagingService" ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlCommonMessageSetting" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlCommonMessageSetting" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "get" : { "summary" : "Retrieves the personal, document area independent common message settings.", "tags" : [ "MessagingService" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlCommonMessageSetting" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlCommonMessageSetting" } } } } } }, "delete" : { "summary" : "Deletes the personal, document area independent common message setting.", "tags" : [ "MessagingService" ], "responses" : { "204" : { "description" : "No Content" } } } }, "/messaging/settings/principal" : { "put" : { "summary" : "Sets a new principal message setting for the signed in user.", "tags" : [ "MessagingService" ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalMessageSetting" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalMessageSetting" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "get" : { "summary" : "Retrieves the personal principal message settings.", "tags" : [ "MessagingService" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalMessageSetting" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalMessageSetting" } } } } } }, "delete" : { "summary" : "Deletes the principal message setting.", "tags" : [ "MessagingService" ], "responses" : { "204" : { "description" : "No Content" } } } }, "/messaging/subscription/principal" : { "delete" : { "summary" : "Removes the subscription of the caller.", "tags" : [ "MessagingService" ], "responses" : { "204" : { "description" : "No Content" } } }, "put" : { "summary" : "Establishes a subscription for the caller.", "tags" : [ "MessagingService" ], "responses" : { "204" : { "description" : "No Content" } } } }, "/monitoring/connectedusers" : { "get" : { "summary" : "Gets information about the currently connected users.", "tags" : [ "MonitoringService" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlSessionInfoList" } }, "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/XmlSessionInfo" } } } } } } } }, "/monitoring/connectedusers/invalidate" : { "put" : { "summary" : "Invalidates the sessions with given ids.", "tags" : [ "MonitoringService" ], "parameters" : [ { "name" : "reason", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "sessioncache", "in" : "query", "schema" : { "type" : "boolean" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlIntList" } }, "application/json" : { "schema" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "integer", "format" : "int32" } } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlIntList" } }, "application/json" : { "schema" : { "type" : "array", "uniqueItems" : true, "items" : { "type" : "integer", "format" : "int32" } } } } } } } }, "/monitoring/connectedusers/{id}" : { "delete" : { "summary" : "Invalidates the session with given id.", "tags" : [ "MonitoringService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/monitoring/invokemethod/{method}" : { "put" : { "summary" : "Invoke generic method (eg. monitoring sensor).", "tags" : [ "MonitoringService" ], "parameters" : [ { "name" : "method", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } }, "application/xml" : { "schema" : { "type" : "string" } }, "multipart/mixed" : { "schema" : { "$ref" : "#/components/schemas/MultiPartStreamable" } }, "application/json" : { "schema" : { } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "text/plain" : { "schema" : { "type" : "string" } }, "application/xml" : { "schema" : { "type" : "string" } }, "application/json" : { "schema" : { } } } } } } }, "/nscalelink" : { "get" : { "summary" : "create nscale link", "responses" : { "200" : { "description" : "OK" } } } }, "/repository/doc/{docId}/tags" : { "post" : { "summary" : "Adds given category tag for given entity.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "docId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/repository/doc/{docId}/tags/{tagId}" : { "delete" : { "summary" : "Removes given category tag from given entity if it is associated.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "docId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/repository/doc/{id}" : { "put" : { "summary" : "Updates the properties and the content of a specific resource.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "multipart/mixed" : { "schema" : { "$ref" : "#/components/schemas/MultiPartStreamable" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "get" : { "summary" : "Retrieves a specific set of properties for the requested resource.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } }, "delete" : { "summary" : "Delete document.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/repository/doc/{id}/content" : { "put" : { "summary" : "Updates the text content resource.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } }, "get" : { "summary" : "Retrieve content (as single document, or zip for multipart/mixed.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/repository/doc/{id}/contentitem/{index}" : { "head" : { "summary" : "Get metadata of extended content stream.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "index", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "On success return the URI reference to the document. Link headers provide other operations.", "headers" : { "Location" : { "description" : "The URI where the created document is accessible." }, "Content-Type" : { "description" : "The content type." }, "Content-Length" : { "description" : "Content length of content item." }, "Last-Modified" : { "description" : "Modification date." } } }, "204" : { "description" : "There is no content." } } }, "get" : { "summary" : "Get the whole extended content of any kind of resource in the repository.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "index", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "showError", "in" : "query", "schema" : { "type" : "boolean" } }, { "name" : "useContentLength", "in" : "query", "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "On success return the URI reference to the document. Link headers provide other operations.", "headers" : { "Content-Type" : { "description" : "The content type." }, "Last-Modified" : { "description" : "Modification date." } } }, "404" : { "description" : "Content item does not exist." } } } }, "/repository/doc/{id}/contentitems" : { "put" : { "summary" : "Updates the extended content of a specific resource.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "multipart/mixed" : { "schema" : { "$ref" : "#/components/schemas/MultiPartStreamable" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "get" : { "summary" : "Retrieves the extended content metadata of the requested resource.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlContentMetadata" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlContentMetadata" } }, "text/plain" : { "schema" : { "type" : "string" } } } } } } }, "/repository/doc/{id}/extensions" : { "get" : { "summary" : "Gets all extensions for the requested resource filtered by given query.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/repository/doc/{id}/extensions/{type}" : { "put" : { "summary" : "Create or update text content of extension. Only notes are supported here.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "type", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } } }, "required" : true }, "responses" : { "201" : { "description" : "On success return the resource key and location header for note uri.", "headers" : { "Location" : { "description" : "The URI where the created note is accessible." } } } } }, "get" : { "summary" : "Retrieves all extensions of given type for the requested resource.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "type", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } }, "post" : { "summary" : "Creates an extension of given type.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "type", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "multipart/mixed" : { "schema" : { "$ref" : "#/components/schemas/MultiPartStreamable" } } }, "required" : true }, "responses" : { "201" : { "description" : "On success return the resource key and location header for extension uri.", "headers" : { "Location" : { "description" : "The URI where the created extension is accessible." } } } } } }, "/repository/doc/{id}/publish" : { "post" : { "summary" : "Publishes the content of the document identified by given document key.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "duration", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : 168 } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "duration" : { "type" : "integer", "format" : "int32", "default" : 168 } } } } }, "required" : true }, "responses" : { "201" : { "description" : "On success return the location header for public document uri.", "headers" : { "Location" : { "description" : "The URI where the public document is accessible." } } } } } }, "/repository/doc/{id}/thumbnail" : { "get" : { "summary" : "Gets the thumbnail renditions for specified document and optionally creates one, if none exists.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "create", "in" : "query", "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceKeyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceKeyList" } } } } } } }, "/repository/doc/{id}/versions" : { "get" : { "summary" : "Gets version history of a specific document.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/repository/docarea/{docarea}/personal" : { "get" : { "summary" : "Retrieves the personal/private folder of current user in given document area.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceKey" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceKey" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/repository/docarea/{docarea}/personal/domain/{name}" : { "get" : { "summary" : "Retrieves the personal/private folder of given principal (user, position or group) in given document area.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } } } } } } }, "/repository/docarea/{docarea}/personal/pid/{id}" : { "get" : { "summary" : "Retrieves the personal/private folder of given principal (user, position or group) in given document area.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceKey" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceKey" } } } } } } }, "/repository/docarea/{docarea}/root" : { "get" : { "summary" : "Retrieves the root folder, that is, the entry point, of a specific document area.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResultItem" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResultItem" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/repository/docareas" : { "get" : { "summary" : "Get list of accessible document areas.", "tags" : [ "RepositoryService" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlDocumentAreaList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlDocumentAreaList" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/repository/folder/{folderId}/tags" : { "post" : { "summary" : "Adds given category tag for given entity.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "folderId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/repository/folder/{folderId}/tags/{tagId}" : { "delete" : { "summary" : "Removes given category tag from given entity if it is associated.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "folderId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/repository/folder/{id}" : { "put" : { "summary" : "Update folder properties.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "get" : { "summary" : "Retrieves a specific set of properties for the requested resource.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } }, "delete" : { "summary" : "Delete folder.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/repository/folder/{id}/children" : { "get" : { "summary" : "Gets the direct children of the specified folder.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "hidden", "in" : "query", "schema" : { "$ref" : "#/components/schemas/BooleanParam" } }, { "name" : "pagenumber", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "pagesize", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string", "default" : "displayname,identifier,resourcetype,lastmodifieddate,creatorcommonname,objectclass,contentlength,contenttype,contentitemcount" } }, { "name" : "resultcount", "in" : "query", "schema" : { "$ref" : "#/components/schemas/BooleanParam" } }, { "name" : "sortorder", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/repository/folder/{id}/children/document" : { "post" : { "summary" : "Creates a document in a parent folder.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "archived", "in" : "query", "schema" : { "type" : "boolean" } }, { "name" : "lock", "in" : "query", "schema" : { "type" : "boolean" } } ], "requestBody" : { "content" : { "multipart/mixed" : { "schema" : { "$ref" : "#/components/schemas/MultiPartStreamable" } }, "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/MultiPartStreamable" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlDocumentMetaData" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlDocumentMetaData" } } }, "required" : true }, "responses" : { "201" : { "description" : "On success return the resource key and location header for document uri.", "headers" : { "Location" : { "description" : "The URI where the created document is accessible." } } }, "303" : { "description" : "On success redirect to location of document.", "headers" : { "Location" : { "description" : "The URI where the created document is accessible." } } } } }, "get" : { "summary" : "Gets the (direct) document-type children of the specified folder.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "hidden", "in" : "query", "schema" : { "$ref" : "#/components/schemas/BooleanParam" } }, { "name" : "pagenumber", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "pagesize", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string", "default" : "displayname,identifier,resourcetype,lastmodifieddate,creatorcommonname,objectclass,contentlength,contenttype,contentitemcount" } }, { "name" : "resultcount", "in" : "query", "schema" : { "$ref" : "#/components/schemas/BooleanParam" } }, { "name" : "sortorder", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/repository/folder/{id}/children/filter" : { "get" : { "summary" : "Gets the direct children of the specified folder with given filter.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "hidden", "in" : "query", "schema" : { "$ref" : "#/components/schemas/BooleanParam" } }, { "name" : "pagenumber", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "pagesize", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "resultcount", "in" : "query", "schema" : { "$ref" : "#/components/schemas/BooleanParam" } }, { "name" : "scope", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : 1 } }, { "name" : "sortorder", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } } } } } } }, "/repository/folder/{id}/children/folder" : { "post" : { "summary" : "Create a folder.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "lock", "in" : "query", "schema" : { "type" : "boolean" } }, { "name" : "objectclass", "in" : "query", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "displayname" : { "type" : "string" } } } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "303" : { "description" : "On success redirect to location of folder.", "headers" : { "Location" : { "description" : "The URI where the created folder is accessible." } } }, "201" : { "description" : "On success return the resource key and location header for folder uri.", "headers" : { "Location" : { "description" : "The URI where the created folder is accessible." } } } } }, "get" : { "summary" : "Gets the (direct) folder-type children of the specified folder.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "hidden", "in" : "query", "schema" : { "$ref" : "#/components/schemas/BooleanParam" } }, { "name" : "pagenumber", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "pagesize", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string", "default" : "displayname,identifier,resourcetype,lastmodifieddate,creatorcommonname,objectclass,contentlength,contenttype,contentitemcount" } }, { "name" : "resultcount", "in" : "query", "schema" : { "$ref" : "#/components/schemas/BooleanParam" } }, { "name" : "sortorder", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/repository/folder/{id}/children/link" : { "get" : { "summary" : "Gets the (direct) link-type children of the specified folder.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "hidden", "in" : "query", "schema" : { "$ref" : "#/components/schemas/BooleanParam" } }, { "name" : "pagenumber", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "pagesize", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string", "default" : "displayname,identifier,resourcetype,lastmodifieddate,creatorcommonname,objectclass,contentlength,contenttype,contentitemcount" } }, { "name" : "resultcount", "in" : "query", "schema" : { "$ref" : "#/components/schemas/BooleanParam" } }, { "name" : "sortorder", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/repository/folder/{id}/children/link/{refid}" : { "post" : { "summary" : "Create a link.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "refid", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "objectclass", "in" : "query", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "201" : { "description" : "On success return the resource key and location header for link uri.", "headers" : { "Location" : { "description" : "The URI where the created link is accessible." } } } } } }, "/repository/folder/{id}/extensions/{type}" : { "get" : { "summary" : "Retrieves all extensions of requested resource. For folders only notes can be retrieved.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "type", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "text/plain" : { "schema" : { "type" : "string" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } } } } } }, "post" : { "summary" : "Creates an extension on a specific folder", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "type", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "multipart/mixed" : { "schema" : { "$ref" : "#/components/schemas/MultiPartStreamable" } } }, "required" : true }, "responses" : { "201" : { "description" : "On success return the resource key and location header for extension uri.", "headers" : { "Location" : { "description" : "The URI where the created extension is accessible." } } } } } }, "/repository/folder/{id}/opensearch" : { "get" : { "summary" : "Open search implementation.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fulltextQuery", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "query", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "useNDF", "in" : "query", "schema" : { "type" : "boolean" } }, { "name" : "webdav", "in" : "query", "schema" : { "type" : "boolean", "default" : true } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/repository/folder/{id}/opensearch/osdx" : { "get" : { "summary" : "Get OSDX file.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/repository/folder/{id}/publish" : { "post" : { "summary" : "Publishes the folder identified by given folder key.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "duration", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : 168 } }, { "name" : "read", "in" : "query", "schema" : { "allOf" : [ { "$ref" : "#/components/schemas/BooleanParam" }, { "default" : "1" } ] } }, { "name" : "write", "in" : "query", "schema" : { "allOf" : [ { "$ref" : "#/components/schemas/BooleanParam" }, { "default" : "0" } ] } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "duration" : { "type" : "integer", "format" : "int32", "default" : 168 }, "write" : { "type" : "boolean" } } } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/repository/folder/{id}/search" : { "get" : { "summary" : "Searches the document area for certain resource items.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "fulltextQuery", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "query", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "delimiter", "in" : "query", "schema" : { "type" : "string", "default" : ";" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } }, "text/csv" : { "schema" : { "type" : "string" } } } } } }, "post" : { "summary" : "Searches the document area for certain resource items.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "type" : "object", "properties" : { "query" : { "type" : "string" }, "fulltext" : { "type" : "string" }, "aggregate" : { "type" : "boolean" } } } } }, "required" : true }, "responses" : { "200" : { "description" : "OK" } } } }, "/repository/folder/{id}/search/aggregate" : { "get" : { "summary" : "Searches the document area by using aggregate functions.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/repository/folder/{id}/searchcontent" : { "get" : { "summary" : "Searches for one document and retrieve content.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "multi", "in" : "query", "schema" : { "$ref" : "#/components/schemas/BooleanParam" } }, { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/repository/folder/{id}/searchversions" : { "get" : { "summary" : "Searches the document area for certain resource items, including versions.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/repository/folder/{id}/searchversions/aggregate" : { "get" : { "summary" : "Searches the document area by using aggregate functions, including versions.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/repository/folder/{id}/searchversions/content" : { "get" : { "summary" : "Searches for one document version and retrieve content.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/repository/link/{id}" : { "put" : { "summary" : "Updates the properties of a link.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "objectclass", "in" : "query", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "get" : { "summary" : "Retrieves a specific set of properties for the requested link.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } }, "delete" : { "summary" : "Deletes a link.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/repository/link/{id}/resource" : { "get" : { "summary" : "Resolves the resource referenced by the link.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } } } } } } }, "/repository/note/{id}" : { "head" : { "summary" : "Gets header information of a notes extended content.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "On success return location and other.", "headers" : { "Location" : { "description" : "The URI where the note is accessible." }, "Content-Type" : { "description" : "The content type." }, "Content-Length" : { "description" : "Content length of content item." }, "Last-Modified" : { "description" : "Modification date." } } } } }, "get" : { "summary" : "Gets the whole extended content of a note.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "On success return location and other.", "headers" : { "Location" : { "description" : "The URI where the note is accessible." }, "Content-Type" : { "description" : "The content type." }, "Content-Length" : { "description" : "Content length of content item." }, "Last-Modified" : { "description" : "Modification date." } } } } }, "put" : { "summary" : "Appends content to an existing note.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "text/plain" : { "schema" : { "type" : "string" } }, "multipart/mixed" : { "schema" : { "$ref" : "#/components/schemas/MultiPartStreamable" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK" } } } }, "/repository/public/{id}" : { "get" : { "summary" : "Gets the published document identified by given published uuid.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPublishedResource" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPublishedResource" } } } } } } }, "/repository/public/{id}/content" : { "head" : { "summary" : "Get content of public document.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } }, "get" : { "summary" : "Get content of public document.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/repository/published" : { "get" : { "summary" : "Gets the published documents of all document areas.", "tags" : [ "RepositoryService" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPublishedResourceList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPublishedResourceList" } } } } } } }, "/repository/published/docarea/{docarea}" : { "get" : { "summary" : "Gets the published documents of given document area.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPublishedResourceList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPublishedResourceList" } } } } } } }, "/repository/published/{id}" : { "delete" : { "summary" : "Revokes access on the content of a document which has been published before.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/repository/res/{id}" : { "put" : { "summary" : "Updates properties of the specified resource.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "head" : { "summary" : "Checks that a specified resource exists.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } }, "get" : { "summary" : "Retrieves a specific set of properties for the requested resource.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } }, "delete" : { "summary" : "Delete resource.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "type", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/repository/res/{id}/ancestors" : { "get" : { "summary" : "Retrieves the ancestor-parent keys.", "tags" : [ "RepositoryService" ], "parameters" : [ { "description" : "resource id of requested resource", "example" : "DA$NOTSET$11730$1$NOTSET", "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "description" : "properties to return", "example" : "displayname,contenttype,objectclass", "name" : "properties", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/repository/res/{id}/command/applyFolderTemplate" : { "put" : { "summary" : "Applies given folder template on given folder.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "foldertemplate", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/repository/res/{id}/command/archive" : { "put" : { "summary" : "Archives a specific resource.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/repository/res/{id}/command/copy/{to}" : { "put" : { "summary" : "Copies a folder, document or link to the specified target folder.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "to", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "objectclass", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/repository/res/{id}/command/finalize" : { "put" : { "summary" : "Finalizes a specific resource.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/repository/res/{id}/command/generatecontentiteminfo" : { "put" : { "summary" : "Generates content item information from content items of given resource.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/repository/res/{id}/command/lock" : { "put" : { "summary" : "Locks the specified resource.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/repository/res/{id}/command/move/{to}" : { "put" : { "summary" : " Moves a folder, document or link to the specified target folder.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "to", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "objectclass", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/repository/res/{id}/command/unarchive" : { "put" : { "summary" : "Unarchives a specific folder.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/repository/res/{id}/command/undelete" : { "put" : { "summary" : "Undeletes a previously logically deleted resource.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/repository/res/{id}/command/unfinalize" : { "put" : { "summary" : "Un-finalizes a specific resource.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "children", "in" : "query", "schema" : { "type" : "boolean" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/repository/res/{id}/command/unlock" : { "put" : { "summary" : "Unlocks a previously locked resource.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/repository/res/{id}/links" : { "get" : { "summary" : "Finds all links pointing to the specified resource, identified by resource.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceResult" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/repository/res/{id}/parent" : { "get" : { "summary" : "Get the parent folder of the given resource.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceKey" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlResourceKey" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/repository/res/{id}/property/{property}" : { "get" : { "summary" : "Retrieves one property for the requested resource.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "property", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlProperty" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlProperty" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/repository/res/{resId}/tags" : { "post" : { "summary" : "Adds given category tag for given entity.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "resId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/repository/res/{resId}/tags/{tagId}" : { "delete" : { "summary" : "Removes given category tag from given entity if it is associated.", "tags" : [ "RepositoryService" ], "parameters" : [ { "name" : "resId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/tx/methods" : { "post" : { "responses" : { "201" : { "description" : "Created" } } } }, "/usermanagement/docarea/{docarea}/orgentities" : { "get" : { "summary" : "Returns all org entities associated to domains referring to a given document area.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalEntityList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalEntityList" } } } } } } }, "/usermanagement/domain" : { "get" : { "summary" : "Get list of accessible domains.", "tags" : [ "UserManagementService" ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlDomainList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlDomainList" } }, "text/plain" : { "schema" : { "type" : "string" } } } } } } }, "/usermanagement/domain/{domain}/groups" : { "get" : { "summary" : "Gets groups of a specified domain with paging.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "domain", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "pagenumber", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "pagesize", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : 100 } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalEntityList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalEntityList" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/usermanagement/domain/{domain}/groups/{name}" : { "get" : { "summary" : "Gets a group specified by domain and login name.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "domain", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlGroup" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlGroup" } } } } } } }, "/usermanagement/domain/{domain}/positions" : { "get" : { "summary" : "Gets positions of a specified domain with paging.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "domain", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "pagenumber", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "pagesize", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : 100 } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalEntityList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalEntityList" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/usermanagement/domain/{domain}/positions/{name}" : { "get" : { "summary" : "Gets a position specified by name and domain name.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "domain", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPosition" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPosition" } } } } } } }, "/usermanagement/domain/{domain}/users" : { "get" : { "summary" : "Gets users of a specified domain with paging.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "domain", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "pagenumber", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "pagesize", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : 100 } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalEntityList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalEntityList" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/usermanagement/domain/{domain}/users/{name}" : { "get" : { "summary" : "Gets a user specified by domain and login name.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "domain", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "name", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlUser" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlUser" } } } } } } }, "/usermanagement/filteredsearch" : { "get" : { "summary" : "Searches for principals or principal info, controlled by the specified filter query.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "filter", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "pagenumber", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "pagesize", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "resultcount", "in" : "query", "schema" : { "$ref" : "#/components/schemas/BooleanParam" } }, { "name" : "scope", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : 1 } }, { "name" : "sortorder", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalEntityResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalEntityResult" } } } } } } }, "/usermanagement/nqlsearch" : { "get" : { "summary" : "Searches for principals or principal info, controlled by the specified query.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalEntityResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalEntityResult" } } } } } } }, "/usermanagement/nqlsearch/aggregate" : { "get" : { "summary" : "Searches for principals or principal info by using aggregate functions.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalEntityResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalEntityResult" } } } } } } }, "/usermanagement/principal/{id}" : { "get" : { "summary" : "Gets all additional properties of a specified principal.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } } } } } }, "/usermanagement/principal/{id}/authid" : { "get" : { "summary" : "Gets all authentication IDs which belong to given user.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlAuthIDList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlAuthIDList" } } } } } }, "post" : { "summary" : "Adds a new authentication ID.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlAuthID" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlAuthID" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlAuthIDEx" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlAuthIDEx" } } } } } } }, "/usermanagement/principal/{id}/authid/type/{type}" : { "delete" : { "summary" : "Deletes all authentication IDs of given type from given user.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "type", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AuthenticationIDType" } } ], "responses" : { "200" : { "description" : "OK" } } }, "get" : { "summary" : "Gets all authentication IDs of given type which belong to given user.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "type", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AuthenticationIDType" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlAuthIDList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlAuthIDList" } } } } } } }, "/usermanagement/principal/{id}/authid/{authid}" : { "put" : { "summary" : "Updates or create given authentication ID.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "authid", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlAuthID" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlAuthID" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "delete" : { "summary" : "Deletes authentication ID with given id from given user.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "authid", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } }, "get" : { "summary" : "Gets the authentication ID with given id which belongs to given user.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "authid", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlAuthID" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlAuthID" } } } } } }, "head" : { "summary" : "Gets indication whether the authentication ID with given id exists for given user.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "authid", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/usermanagement/principal/{id}/members" : { "delete" : { "summary" : "Removes from specified group the specified positions and groups as members.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "get" : { "summary" : "Gets all members of a specific group or position.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } } } } } }, "put" : { "summary" : "Gets the principal ids of members, that is positions and/or groups, of a specified group.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } } }, "/usermanagement/principal/{id}/membership" : { "get" : { "summary" : "Gets a list of groups a position or group is member of, identified by its principal id.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } } } } } } }, "/usermanagement/principal/{id}/positions" : { "get" : { "summary" : "Gets the position ids of the specified user; the first position of the list is the default position.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } } } } } } }, "/usermanagement/principal/{id}/property/{property}" : { "put" : { "summary" : "Sets an additional property of a specified principal as binary.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "property", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlProperty" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlProperty" } }, "application/octet-stream" : { "schema" : { "type" : "string", "format" : "binary" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "get" : { "summary" : "Gets the value of a specified additional property of a specified principal.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "property", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlProperty" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlProperty" } }, "application/octet-stream" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/usermanagement/principal/{id}/userinfo" : { "get" : { "summary" : "Retrieves the user info of a given principal identified by its principal id.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/usermanagement/principal/{id}/userinfo/photo" : { "get" : { "summary" : "Retrieves the photo of a given principal identified by its principal id.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/usermanagement/search" : { "get" : { "summary" : "earches the visible domains for certain principals which are matching the given fulltext query.", "tags" : [ "UserManagementService" ], "parameters" : [ { "name" : "domains", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "fulltextQuery", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "pagenumber", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "pagesize", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "types", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalEntityResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPrincipalEntityResult" } } } } } } }, "/whoami" : { "get" : { "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WhoAmIDto" } } } } } } }, "/workflow/docarea/{docarea}/process/{id}" : { "put" : { "summary" : "Updates workflow properties of a specific process.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "head" : { "summary" : "Checks whether a specific process exists or not.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } }, "get" : { "summary" : "Retrieves a specific set of workflow properties for the requested process.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/workflow/docarea/{docarea}/process/{id}/end" : { "put" : { "summary" : "Ends the specific process (instance) while updating its properties.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } } }, "/workflow/docarea/{docarea}/process/{id}/lock" : { "put" : { "summary" : "Locks the specified workflow instance for exclusive access.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/workflow/docarea/{docarea}/process/{id}/reset" : { "put" : { "summary" : "Resets the specified process part(s) by deleting the error message(s) of the hung process part(s).", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } } }, "/workflow/docarea/{docarea}/process/{id}/resume" : { "put" : { "summary" : "Resumes the execution of the specified process.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/workflow/docarea/{docarea}/process/{id}/suspend" : { "put" : { "summary" : "Suspends the execution of the specified process.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/workflow/docarea/{docarea}/process/{id}/tasks" : { "get" : { "summary" : "Retrieves unfinished tasks for a specific process.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowResult" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/workflow/docarea/{docarea}/process/{id}/unlock" : { "put" : { "summary" : "Unlocks a previously locked process instance.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/workflow/docarea/{docarea}/process/{processId}/tags" : { "post" : { "summary" : "Adds given category tag for given entity.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "processId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/workflow/docarea/{docarea}/process/{processId}/tags/{tagId}" : { "delete" : { "summary" : "Removes given category tag from given entity if it is associated.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "processId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/workflow/docarea/{docarea}/processes" : { "post" : { "summary" : "Starts a process (instance) of a specified xml workflow process.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "creator", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "processkey", "in" : "query", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowProcess" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowProcess" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowInstanceKey" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowInstanceKey" } } } } } }, "get" : { "summary" : "Retrieves all unfinished processes of the authenticated principal.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowResult" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/workflow/docarea/{docarea}/processes/search" : { "get" : { "summary" : "Searches the specified document area either for task, for process or for node instances", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowResult" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/workflow/docarea/{docarea}/processes/search/aggregate" : { "get" : { "summary" : "Searches the specified document area either for task, for process or for node instances by using aggregate functions.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowResult" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/workflow/docarea/{docarea}/task/{id}" : { "put" : { "summary" : "Updates properties of a specific task, process or node (instance).", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } }, "head" : { "summary" : "Checks whether a specific task exists or not.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } }, "get" : { "summary" : "Retrieves a specific set of workflow properties for the requested task.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/workflow/docarea/{docarea}/task/{id}/assign" : { "put" : { "summary" : "Assigns one or more positions to a specific task.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "position", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/workflow/docarea/{docarea}/task/{id}/assignpooled" : { "put" : { "summary" : "Assigns a task to a pool of specified positions or groups.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlStringList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } } }, "/workflow/docarea/{docarea}/task/{id}/end" : { "put" : { "summary" : "Ends the specified task (instance) while updating its properties.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } } }, "/workflow/docarea/{docarea}/task/{id}/exists" : { "head" : { "summary" : "Searches the specified document area either for task.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/workflow/docarea/{docarea}/task/{id}/resume" : { "put" : { "summary" : "Resumes the execution of the specified task.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/workflow/docarea/{docarea}/task/{id}/start" : { "put" : { "summary" : "Starts the specified task (instance) and updates properties.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlPropertyList" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" } } } }, "/workflow/docarea/{docarea}/task/{id}/suspend" : { "put" : { "summary" : "Suspends the execution of the specified task.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" } } } }, "/workflow/docarea/{docarea}/task/{processId}/tags" : { "post" : { "summary" : "Adds given category tag for given entity.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "processId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/workflow/docarea/{docarea}/task/{processId}/tags/{tagId}" : { "delete" : { "summary" : "Removes given category tag from given entity if it is associated.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "processId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "tagId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/workflow/docarea/{docarea}/tasks" : { "get" : { "summary" : "Retrieves all tasks for a specific user.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "properties", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "sortorder", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "type", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowResult" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowResult" } } } } } } }, "/workflow/docarea/{docarea}/tasks/search" : { "get" : { "summary" : "Retrieves all tasks for a specific user.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowResult" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } }, "/workflow/docarea/{docarea}/tasks/search/aggregate" : { "get" : { "summary" : "Retrieves all tasks for a specific user.", "tags" : [ "WorkflowService" ], "parameters" : [ { "name" : "docarea", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "query", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowResult" } }, "application/xml" : { "schema" : { "$ref" : "#/components/schemas/XmlWorkflowResult" } }, "text/plain" : { "schema" : { "type" : "string" } }, "text/html" : { "schema" : { "type" : "string" } }, "application/xhtml+xml" : { "schema" : { "type" : "string" } } } } } } } }, "tags" : [ { "name" : "AuthenticationService", "description" : "uses the authentication service" }, { "name" : "AuthorityManagementService", "description" : "uses the authority management service" }, { "name" : "BusinessProcessService", "description" : "uses the business process service" }, { "name" : "CollaborationService", "description" : "uses the collaboration service" }, { "name" : "ConfigurationService", "description" : "uses the configuration service" }, { "name" : "MasterdataService", "description" : "uses the master-data service" }, { "name" : "MessagingService", "description" : "uses the messaging service" }, { "name" : "MonitoringService", "description" : "uses the monitoring service" }, { "name" : "RepositoryService", "description" : "uses the repository service" }, { "name" : "UserManagementService", "description" : "uses the user management service" }, { "name" : "WorkflowService", "description" : "uses the workflow service" } ] }