openapi: 3.0.1 info: title: FormKiQ API JWT contact: name: FormKiQ url: https://formkiq.com email: support@formkiq.com x-logo: url: https://docs.formkiq.com/docs/latest/_images/formkiq-logo.png backgroundColor: '#FFFFFF' altText: FormKiQ Logo license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html description: |- FormKiQ API: Document Management Platform API using OAuth(JWT) Authentication You can find out more about FormKiQ at [https://formkiq.com](http://formkiq.com). ## Introduction FormKiQ is an API-first (head-less), battle-tested document management API. The FormKiQ API provides all the API endpoints to build your Perfect Document Management Platform. FormKiQ API was built on top of [OpenAPI specification](https://www.openapis.org), so it is easy to use the API spec file with any application that supports the OpenAPI specification. Open API OAuth Specification - https://raw.githubusercontent.com/formkiq/formkiq-core/master/docs/openapi/openapi-jwt.yaml Open API IAM Specification - https://raw.githubusercontent.com/formkiq/formkiq-core/master/docs/openapi/openapi-iam.yaml ## Authentication FormKiQ offers three forms of authentication: - OAuth(JWT) - AWS IAM - API Key version: 1.19.1 tags: - name: documents description: API for the add, updating and fetching of documents x-displayName: Documents - name: attributes description: API for the add, updating and fetching of atttributes x-displayName: Attributes - name: schemas description: API for the add, updating and fetching of schemas x-displayName: Schemas - name: documentTags description: API for the add, updating and fetching of document tags x-displayName: Document Tags - name: documentAttributes description: API for the add, updating and fetching of document attributes x-displayName: Document Attributes - name: documentSearch description: API for searching for documents x-displayName: Document Search - name: systemManagement description: System Management API x-displayName: System Management - name: advancedDocumentSearch description: Advanced Document Search API x-displayName: Advanced Document Search - name: documentActions description: Document Actions API x-displayName: Document Actions - name: documentOCR description: Document OCR API x-displayName: Document OCR - name: documentVersions description: Document Versions API x-displayName: Document Versions - name: documentReviews description: Document Reviews API x-displayName: Document Reviews - name: documentFolders description: Document Folders API x-displayName: Document Folders - name: accessControl description: Access Control API x-displayName: Access Control - name: documentShares description: Document Shares API x-displayName: Document Shares - name: documentWorkflows description: Document Workflows API x-displayName: Document Workflows - name: mappings description: Mappings API x-displayName: Mappings - name: userActivities description: User Activities API x-displayName: User Activities - name: malwareScan description: MalwareScan API x-displayName: MalwareScan - name: examineObjects description: Examine Objects API x-displayName: ExamineObjects - name: public description: Public API Endpoints x-displayName: Public Endpoints - name: webhooks description: Webhooks API x-displayName: Webhooks - name: e-signature description: E-Signature API x-displayName: E-Signature - name: documentGeneration description: Document Generation API x-displayName: Document Generation - name: ruleSets description: Rulesets API x-displayName: Rulesets - name: entity description: Entity API x-displayName: Entity - name: Application x-amazon-apigateway-tag-value: FormKiQ - name: AppEnvironment x-amazon-apigateway-tag-value: Fn::Sub: ${AppEnvironment} servers: - url: http://localhost description: Local development server paths: /userActivities: get: operationId: GetUserActivities summary: Get user activities description: Retrieve a user's activities tags: - User Activities parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/nextParam' - $ref: '#/components/parameters/limitParam' - name: userId in: query description: Fetch specific user activities required: false schema: type: string responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetUserActivitesResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/userActivities: get: operationId: GetDocumentUserActivities summary: Get user activities for a document description: Retrieve a user's activities for a document tags: - User Activities parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/nextParam' - $ref: '#/components/parameters/limitParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetUserActivitesResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /activities: get: operationId: GetResourceActivities summary: Get resource activities description: Retrieve an resource activities tags: - User Activities parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdQuery' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/entityTypeIdQuery' - $ref: '#/components/parameters/namespaceParam' - $ref: '#/components/parameters/entityIdQuery' - $ref: '#/components/parameters/rulesetIdQuery' - $ref: '#/components/parameters/ruleIdQuery' - $ref: '#/components/parameters/workflowIdQuery' - $ref: '#/components/parameters/queueIdQuery' - $ref: '#/components/parameters/webhookIdQuery' - $ref: '#/components/parameters/localeQueryParam' - $ref: '#/components/parameters/attributeKeyQuery' - $ref: '#/components/parameters/schemaQuery' - $ref: '#/components/parameters/classificationIdQuery' - $ref: '#/components/parameters/mappingIdQuery' - $ref: '#/components/parameters/apiKeyQuery' - $ref: '#/components/parameters/controlPolicyQuery' - $ref: '#/components/parameters/startParam' - $ref: '#/components/parameters/endParam' - $ref: '#/components/parameters/sortParam' - $ref: '#/components/parameters/nextParam' - $ref: '#/components/parameters/limitParam' - name: userId in: query description: Fetch specific user activities required: false schema: type: string responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetActivitesResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /attributes: get: operationId: GetAttributes tags: - Attributes description: Returns a list of attributes summary: Get Attributes listing parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/nextParam' - $ref: '#/components/parameters/limitParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetAttributesResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddAttribute description: Creates a new attribute summary: Add new attribute tags: - Attributes parameters: - $ref: '#/components/parameters/siteIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddAttributeRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /attributes/{key}: get: operationId: GetAttribute tags: - Attributes description: Returns a attribute summary: Get Attribute parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/keyParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetAttributeResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' patch: operationId: UpdateAttribute description: Updates existing attribute summary: Update existing attribute tags: - Attributes parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/keyParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAttributeRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/UpdateResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' delete: operationId: DeleteAttribute description: Delete a attribute summary: Delete attribute tags: - Attributes parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/keyParam' responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /attributes/{key}/allowedValues: get: operationId: GetAttributeAllowedValues tags: - Attributes description: Returns an attribute's allowed values that spans across all classifications and site schema summary: Get Attribute Allowed Values parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/keyParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetAttributeAllowedValuesResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/generate: post: operationId: AddDocumentGenerate description: |- Generates a new document using a specified template file and data sources. This operation allows users to merge data from multiple documents into a template to create a new document in the desired output format (e.g., DOCX). By Default data source must include a `data` object, which contains key-value pairs that will be merged into the template. The value can be any valid JSON object. { "data":{}}. The data path can be adjusted via the "dataRoot" field. ; available as an Add-On Module summary: Add Document Generate tags: - Document Generation parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddDocumentGenerateRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddDocumentGenerateResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/documentGenerationLambdaApi201' /documents: get: operationId: GetDocuments tags: - Documents description: Returns a list of the most recent documents added, ordered by inserted, descending summary: Get Documents listing parameters: - $ref: '#/components/parameters/siteIdParam' - name: actionStatus in: query description: Fetch documents with an action status schema: type: string enum: - FAILED - IN_QUEUE - PENDING - RUNNING - SKIPPED - FAILED_RETRY - name: syncStatus in: query description: Fetch documents with an sync status schema: type: string enum: - FULLTEXT_METADATA_FAILED - FULLTEXT_CONTENT_FAILED - $ref: '#/components/parameters/documentSearchSoftDeleted' - $ref: '#/components/parameters/documentSearchDeleted' - name: date in: query description: Fetch documents inserted on a certain date (yyyy-MM-dd) schema: type: string - name: tz in: query description: 'UTC offset to apply to date parameter (IE: -0600)' schema: type: string - $ref: '#/components/parameters/startParam' - $ref: '#/components/parameters/endParam' - $ref: '#/components/parameters/sortParam' - name: next in: query description: Next page of results token schema: type: string - name: previous in: query description: Previous page of results token schema: type: string - name: projection in: query description: Specify a restricted document projection. Use 'DOCUMENT_ID_ONLY' to return only the documentId attribute. schema: type: string enum: - DOCUMENT_ID_ONLY - $ref: '#/components/parameters/limitParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddDocument description: |- Creates a new document; body may include document content if less than 5 MB. Returns a unique **documentId** used in subsequent operations. **Content Type Detection** If the document **Content-Type** is not specified during upload, the service will determine it asynchronously after the upload completes. This may result in a **temporary delay** before the content type and related metadata are available. See POST /documents/{documentId}/tags for adding tags to document schema See POST /documents/{documentId}/actions for adding actions to document schema summary: Add new document tags: - Documents parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/shareKeyParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddDocumentRequest' examples: Simple_File: value: path: test.txt contentType: text/plain isBase64: false content: This is sample data file tags: - key: category value: sample - key: players values: - "111" - "222" metadata: - key: info value: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Child_Document: value: path: doc1.txt contentType: text/plain content: This is document1 content tags: - key: type value: document1 documents: contentType: text/plain, content: This is child document1 content, tags: - key: type value: childdocument1 Document_with_Webhook: value: path: test.txt contentType: text/plain isBase64: false content: This is sample data file actions: - type: webhook parameters: url: responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddDocumentResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /public/documents: post: operationId: PublicAddDocument summary: Public add document description: |- Allow unauthenticated creation of new documents; must be enabled during installation (disabled by default) See POST /documents/{documentId}/tags for adding tags to document schema See POST /documents/{documentId}/actions for adding actions to document schema tags: - Public parameters: - $ref: '#/components/parameters/siteIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddDocumentRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddDocumentResponse' x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /reindex/documents/{documentId}: post: operationId: AddReindexDocument description: |- The API allows for the reindexing of a document's metadata determined by the target. ATTRIBUTE target will regenerate the composite keys for a document based on the Classification / SiteSchema summary: Reindex metadata on a document tags: - Reindex parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddReindexDocumentRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /documents/compress: post: operationId: CompressDocuments summary: Compress multiple documents into a .zip file parameters: - $ref: '#/components/parameters/siteIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DocumentsCompressRequest' description: Compress documents into an .ZIP archive file, and returns a S3 presigned url for the location of the archive file. The operation is async and processing time depends on the number and size of documents included; a 404 status code is returned until the file is ready. tags: - Documents responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DocumentsCompressResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /documents/{documentId}: get: operationId: GetDocument summary: Get document description: Retrieves a document's details, i.e., metadata tags: - Documents parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/shareKeyParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' patch: operationId: UpdateDocument summary: Update document description: "Update a document's details, i.e., metadata\n\nIf no content is specified, the endpoint will return a S3 Presigned that will allow for the uploading of Large document data. \n\nNOTE:\n- provided attributes will overwrite existing matching attribute keys in the document. Attributes not included in the request body will remain unchanged." tags: - Documents parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/shareKeyParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateDocumentRequest' examples: Simple_File: value: path: test.txt contentType: text/plain isBase64: false content: This is sample data file tags: - key: category value: sample - key: players values: - "111" - "222" metadata: - key: info value: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddDocumentResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' delete: operationId: DeleteDocument summary: Delete document description: |- Delete a document's details, i.e., metadata, contents, etc SoftDelete: The SoftDelete parameter allows for the temporary removal of a document's metadata, attributes, etc from being retrieved from all API requests. The document can be permanently deleted by calling the DELETE /documents/{documentId} with softDelete=false or restored using the PUT /documents/{documentId}/restore. Only the GET /documents?softDeleted=true will return all the soft deleted documents. tags: - Documents parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - name: softDelete in: query description: Whether to soft delete document schema: type: boolean responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/actions: get: operationId: GetDocumentActions summary: Get document actions description: Get document actions and their status tags: - Document Actions parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/shareKeyParam' - $ref: '#/components/parameters/nextParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentActionsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddDocumentActions summary: Add document action description: |- Add one or more actions to a document; this appends actions and does not replace previous actions Each action type supports a different set of parameters as shown in the table below: ### Action Parameters | ActionType | Parameter | Description | Example | | -------- | ------- | ------- | ------- | | OCR | ocrParseTypes | Ocr Parsing strategy to use | TEXT, FORMS, TABLES, QUERIES (requires 'ocrTextractQueries') | | OCR | ocrTextractQueries | Required for "QUERIES", questions to ask Textract | | OCR | ocrEngine | Ocr Engine to use | tesseract or textract | | OCR | ocrOutputType | Convert OCR result to an Output format (textract table only) | true | | OCR | ocrNumberOfPages | Number of pages to OCR (from start) | -1 | | OCR | addPdfDetectedCharactersAsText | PDF Documents convert images to text | true or false | | LLMPROMPT | llmPromptEntityName | LLM Prompt Entity Name | | LLMPROMPT | modelId | Override the LLM Prompt Entity model id for this action | | DATA_CLASSIFICATION | llmPromptEntityName | LLM Prompt Entity Name | | METADATA_EXTRACTION | llmPromptEntityName | LLM Prompt Entity Name | | CHECKSUM | checksumType | Checksum algorithm to calculate and persist for the document | SHA1, SHA256, or SHA512 | | FULLTEXT | characterMax | Maximum number of characters to add to Fulltext destination | -1 | | DOCUMENTTAGGING | engine | Tagging Engine to use | chatgpt | | DOCUMENTTAGGING | tags | Comma-deliminted list of keywords | author,title,description | | WEBHOOK | url | Webhook URL | https://yourdomain.com/webhook-endpoint | | NOTIFICATION | notificationType | Type of Notification | email | | NOTIFICATION | notificationToCc | Notification Carbon Copy | email@yourdomain.com | | NOTIFICATION | notificationToBcc | Notification Blind Carbon Copy | email@yourdomain.com | | NOTIFICATION | notificationSubject | Notification Subject | Email Subject | | NOTIFICATION | notificationText | Notification as Text | Email Text | | NOTIFICATION | notificationHtml | Notification as Html | Email HTML Text | | QUEUE | queueId | Id of Queue | | | IDP | mappingId | Id of Mapping | | | EVENTBRIDGE | eventBusName | The name or ARN of the Amazon EventBridge to receive the event. | | | RESIZE | width | The width of the image to resize (or 'auto'). | | | RESIZE | height | The height of the image to resize (or 'auto'). | | | RESIZE | outputType | The output type of the image (optional). | | | RESIZE | path | The path to use when creating resized document (optional). | | tags: - Document Actions parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/AddDocumentActionsRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/actions/retry: post: operationId: AddDocumentRetryAction summary: Retries failed document action(s) description: Retries all failed document action(s). Failed action status changes to "FAILED_RETRY" and a new "PENDING" action is created. tags: - Document Actions parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/artifacts: get: operationId: GetDocumentArtifacts summary: Get document artifacts description: Returns the list of artifact documents associated with the specified document tags: - Documents parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/artifacts/promoteArtifact: put: operationId: PromoteDocumentArtifact summary: Promote document artifact description: Promotes a document artifact to the specified document tags: - Documents parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/PromoteDocumentArtifactRequest' required: true responses: "200": $ref: '#/components/responses/200CorsSetResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/attributes: get: operationId: GetDocumentAttributes summary: Get document's attributes description: Get a listing of a document's attributes tags: - Document Attributes parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentAttributesResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddDocumentAttributes summary: Add attribute to document description: Add multiple attributes to a document; this endpoint also accepts a different body parameter for adding a single attribute tags: - Document Attributes parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddDocumentAttributesRequest' responses: "201": $ref: '#/components/responses/201CorsAddResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' put: operationId: SetDocumentAttributes summary: Set document's attributes description: |- Set multiple attributes to a document; this endpoint also accepts a different body parameter for setting a single attribute Note: - attributes in the request will overwrite existing attributes. tags: - Document Attributes parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetDocumentAttributesRequest' responses: "200": $ref: '#/components/responses/200CorsSetResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/attributes/{attributeKey}: get: operationId: GetDocumentAttribute summary: Get document attribute by key description: Get a document attribute by using its key tags: - Document Attributes parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/attributeKeyParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentAttributeResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' put: operationId: SetDocumentAttributeValue summary: Set document's attributes value description: Set attributes value to a document tags: - Document Attributes parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/attributeKeyParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetDocumentAttributeRequest' responses: "200": $ref: '#/components/responses/200CorsSetResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' delete: operationId: DeleteDocumentAttribute summary: Delete document attribute description: Delete a document attribute by using its key tags: - Document Attributes parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/attributeKeyParam' responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/attributes/{attributeKey}/{attributeValue}: delete: operationId: DeleteDocumentAttributeAndValue summary: Delete document's attribute value description: Delete a specific document attribute key/value combination; the request will be ignored if there is no valid key/value combination found tags: - Document Attributes parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/attributeKeyParam' - $ref: '#/components/parameters/attributeValueParam' responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/attributes/{attributeKey}/generate: post: operationId: GenerateDocumentAttributeValue description: Allocates the next value from the numbering sequence configured for the attribute key and stores it on the document. If the document already has a value for the attribute key, the existing value is returned. summary: Generate document attribute value tags: - Document Attributes parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/attributeKeyParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GenerateDocumentAttributeValueResponse' "400": description: Attribute key is not eligible for generated values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' "404": description: Document or numbering sequence not found content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/certifications: post: operationId: AddDocumentCertification description: |- Applies one or more certifications (digital signatures) to a document using one or more certificates. Target determines whether a presigned download is returned, a new version is created, or a new document is created. ; available as an Add-On Module summary: Add Document Certification tags: - Document Generation parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddDocumentCertificationRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddDocumentCertificationResponse' "400": description: 400 BAD REQUEST content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/documentSignatureLambdaApi' /documents/{documentId}/checkout: put: operationId: SetDocumentCheckout summary: Perform document checkout description: | Creates a checkout for the document. Fails with **409 Conflict** if the document is already checkedout by another user; available as an Add-On Module tags: - Documents parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/legalHold: put: operationId: SetDocumentCheckoutLegalHold summary: Perform document legal hold checkout description: | Creates a legal hold checkout for the document. Fails with **409 Conflict** if the document is already checkedout by another user; available as an Add-On Module tags: - Documents parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' delete: operationId: DeleteDocumentCheckoutLegalHold summary: Delete document legal hold checkout description: | Removes a legal hold checkout for the document; available as an Add-On Module tags: - Documents parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/content: get: operationId: GetDocumentContent summary: Get document's contents description: "Retrieves the content of the document with the specified `documentId`.\n- If the content is plain text and under 6 MB, the content will be returned directly.\n- If the content is plain text but exceeds 6 MB, an error will be returned.\n- For documents not in plain text format, pre-signed S3 URLs will be returned to download the content from S3.\nIt is recommended to use the `/documents/{documentId}/url` endpoint to retrieve pre-signed S3 URLs for downloading the content.\n\nIf the document has a Content-Type of text/, application/json, application/x-www-form-urlencoded the content field will be returned. \nAll other Content-Type, the contentUrl field will be returned, which is a S3 Presigned url.\n" tags: - Documents parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/versionKeyParam' - $ref: '#/components/parameters/shareKeyParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' Location: $ref: '#/components/headers/Location' content: application/json: schema: $ref: '#/components/schemas/GetDocumentContentResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/dataClassification: get: operationId: GetDocumentDataClassification summary: Get document's data classification description: | Retrieve an document's data classification; available as an Add-On Module. **Deprecated**. This endpoint is no longer recommended. Please use **`/documents/{documentId}/ai/prompts/{llmPromptEntityName}`** instead. deprecated: true tags: - Intelligent Document Processing parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentDataClassificationResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/dataClassificationLambdaApi200' put: operationId: SetDocumentDataClassification summary: Set document's data classification description: | Generate Data Classfication attributes within a document; available as an Add-On Module. **Deprecated**. This endpoint is no longer recommended. Please use **`/documents/{documentId}/ai/prompts/{llmPromptEntityName}`** instead. deprecated: true tags: - Intelligent Document Processing parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/SetDocumentDataClassificationRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetDocumentDataClassificationResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/dataClassificationLambdaApi200' /documents/{documentId}/metadataExtractionResults: get: operationId: GetAllDocumentMetadataExtractionResults summary: Get all document's metadata extraction results description: | Retrieve all document's metadata extraction; available as an Add-On Module. **Deprecated**. This endpoint is no longer recommended. Please use **`/documents/{documentId}/ai/prompts/{llmPromptEntityName}`** instead. deprecated: true tags: - Intelligent Document Processing parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentMetadataExtractionResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/dataClassificationLambdaApi200' /documents/{documentId}/metadataExtractionResults/{llmPromptEntityName}: get: operationId: GetDocumentMetadataExtractionResults summary: Get document's metadata extraction results description: | Retrieve an document's metadata extraction; available as an Add-On Module. **Deprecated**. This endpoint is no longer recommended. Please use **`/documents/{documentId}/ai/prompts/{llmPromptEntityName}`** instead. deprecated: true tags: - Intelligent Document Processing parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/llmPromptEntityNameParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentMetadataExtractionResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/dataClassificationLambdaApi200' post: operationId: AddDocumentMetadataExtractionResult summary: Add document's metadata extraction result description: | Create a document Metadatq Extraction Result attributes within a document; available as an Add-On Module. **Deprecated**. This endpoint is no longer recommended. Please use **`/documents/{documentId}/ai/prompts/{llmPromptEntityName}`** instead. deprecated: true tags: - Intelligent Document Processing parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/llmPromptEntityNameParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddDocumentMetadataExtractionResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/dataClassificationLambdaApi200' /documents/{documentId}/ai/prompts: get: operationId: GetDocumentAiPromptsResults summary: Get document AI results from LLM prompts description: Retrieve document AI results from LLM prompts; available as an Add-On Module tags: - Intelligent Document Processing parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/analysisCategoryParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentAiPromptsResultsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/dataClassificationLambdaApi200' /documents/{documentId}/ai/prompts/{llmPromptEntityName}: get: operationId: GetDocumentAiPromptResults summary: Get document AI results from LLM prompt description: Retrieve document AI results from an LLM prompt; available as an Add-On Module tags: - Intelligent Document Processing parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/llmPromptEntityNameParam' - $ref: '#/components/parameters/analysisCategoryParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentAiPromptResultsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/dataClassificationLambdaApi200' post: operationId: AddDocumentAiPrompt summary: Add document AI result from LLM prompt description: Run an LLM prompt against a document; available as an Add-On Module tags: - Intelligent Document Processing parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/llmPromptEntityNameParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddDocumentAiPromptRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddDocumentAiResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/dataClassificationLambdaApi200' /documents/{documentId}/fulltext: get: operationId: GetDocumentFulltext summary: Get document's full-text description: Retrieve an OpenSearch document's details, i.e., metadata tags: - Advanced Document Search parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/shareKeyParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentFulltextResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' delete: operationId: DeleteDocumentFulltext summary: Delete document full-text description: Remove full text search for a document from OpenSearch; available as an Add-On Module tags: - Advanced Document Search parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DeleteFulltextResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' put: operationId: SetDocumentFulltext summary: Set document's full-text description: Set all text/tags found within a document to OpenSearch; available as an Add-On Module tags: - Advanced Document Search parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/SetDocumentFulltextRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetDocumentFulltextResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' post: operationId: AddDocumentFulltext summary: Add document's full-text description: Add a document to OpenSearch; available as an Add-On Module tags: - Advanced Document Search parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/AddDocumentFulltextRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddDocumentFulltextResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' patch: operationId: UpdateDocumentFulltext summary: Update document's full-text description: Update a document in OpenSearch; available as an Add-On Module tags: - Advanced Document Search parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/UpdateDocumentFulltextRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/UpdateDocumentFulltextResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' /documents/{documentId}/fulltext/tags/{tagKey}: delete: operationId: DeleteDocumentFulltextTag summary: Delete document full-text tag description: Remove document tags from OpenSearch; available as an Add-On Module tags: - Advanced Document Search parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/tagkeyParam' - $ref: '#/components/parameters/shareKeyParam' responses: "200": $ref: '#/components/responses/200Cors' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' /documents/{documentId}/fulltext/tags/{tagKey}/{tagValue}: delete: operationId: DeleteDocumentFulltextTagAndValue summary: Delete document full-text tag/value description: Remove document tag/value from OpenSearch; available as an Add-On Module tags: - Advanced Document Search parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/tagkeyParam' - $ref: '#/components/parameters/tagvalueParam' - $ref: '#/components/parameters/shareKeyParam' responses: "200": $ref: '#/components/responses/200Cors' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' /documents/{documentId}/antivirus: put: operationId: SetAntivirus summary: Antivirus document scan description: "Perform an Anti-Malware / Antivirus scan on a document; available as an Add-On Module\n**Deprecated**. This endpoint is no longer recommended. \nPlease use the **`/documents/{document}/malwareScan`** endpoint instead.\n" tags: - MalwareScan parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/shareKeyParam' requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/SetAntivirusRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/antivirusLambdaApi200' /documents/{documentId}/malwareScan: get: operationId: GetMalwareScanResults summary: Get Malware Scan results description: Gets a Malware Scan results; available as an Add-On Module tags: - MalwareScan parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/nextParam' - $ref: '#/components/parameters/limitParam' responses: "200": description: 200 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetMalwareScanResponse' "400": description: 400 BAD REQUEST headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/antivirusLambdaApi200' put: operationId: SetMalwareScan summary: MalwareScan document scan description: | Perform an Anti-Malware / Antivirus scan on a document; available as an Add-On Module tags: - MalwareScan parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/SetMalwareScanRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/antivirusLambdaApi200' /documents/{documentId}/notifications: get: operationId: GetDocumentNotifications summary: Get document notifications description: Get notifications attached to a document or one of its artifacts tags: - Document Notifications parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentNotificationsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddDocumentNotification summary: Add an ad hoc document notification description: Queue an ad hoc notification for a document or one of its artifacts tags: - Document Notifications parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddDocumentNotificationRequest' responses: "202": description: Notification accepted for delivery headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddDocumentNotificationResponse' "400": description: Invalid notification request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/ocr: get: operationId: GetDocumentOcr summary: Get document ocr content description: "Get a document's optical character recognition (OCR) result, if exists; \n\nTesseract available for all editions, but Textract engine and tables and forms options available as an Add-On Module" tags: - Document OCR parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/ocrOutputTypeParam' - $ref: '#/components/parameters/contentUrlParam' - $ref: '#/components/parameters/textParam' - $ref: '#/components/parameters/shareKeyParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentOcrResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/ocrLambdaApi200' post: operationId: AddDocumentOcr summary: Perform document ocr description: "Document optical character recognition (OCR) request; extract text and data from a document; \n\nTesseract available for all editions, but Textract engine and tables and forms options available as an Add-On Module" tags: - Document OCR parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/AddDocumentOcrRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddDocumentOcrResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/ocrLambdaApi200' put: operationId: SetDocumentOcr summary: Set document ocr result description: "Set a document's optical character recognition (OCR) result for a document; \n\nTesseract available for all editions, but Textract engine and tables and forms options available as an Add-On Module" tags: - Document OCR parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/SetDocumentOcrRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddDocumentOcrResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/ocrLambdaApi200' delete: operationId: DeleteDocumentOcr summary: Delete document ocr description: "Delete a document's optical character recognition (OCR) result, if exists; \n\nTesseract available for all editions, but Textract engine and tables and forms options available as an Add-On Module" tags: - Document OCR parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/ocrLambdaApi200' /documents/{documentId}/purge: delete: operationId: PurgeDocument summary: Purge document description: Remove all objects from the S3 bucket, including previous versions and current version, and should remove all metadata as well, so that no trace of the document exists outside of the audit logs and any backups. Can only be called be ADMIN or GOVERN. tags: - Documents parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/restore: put: operationId: SetDocumentRestore summary: Restore soft deleted document parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' description: Restores a soft deleted document tags: - Documents responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetDocumentRestoreResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/reviews: get: operationId: GetDocumentReviews summary: Get document reviews description: Get a listing of reviews for a document tags: - Document Reviews parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentReviewsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddDocumentReview summary: Add document review description: |- Add a review to a document. When notifications are supplied, queue each notification for delivery when the review is created. tags: - Document Reviews parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddDocumentReviewRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddDocumentReviewResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /documents/{documentId}/reviews/{reviewId}: get: operationId: GetDocumentReview summary: Get document review description: Get a document review by review id tags: - Document Reviews parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/reviewIdParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentReviewResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' patch: operationId: UpdateDocumentReview summary: Update document review description: Update a document review by review id tags: - Document Reviews parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/reviewIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateDocumentReviewRequest' responses: "200": $ref: '#/components/responses/200CorsUpdateResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/reviews/{reviewId}/decisions: get: operationId: GetDocumentReviewDecisions summary: Get document review decisions description: Get a listing of decisions for a document review tags: - Document Reviews parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/reviewIdParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentReviewDecisionsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddDocumentReviewDecision summary: Add document review decision description: |- Add a decision to a document review. When approvalGroups is set on the review, the caller must belong to at least one of those groups, in addition to satisfying the existing authorization requirements, before the decision is added. Decisions submitted to a review that is already COMPLETED return 409 Conflict without creating a decision, follow-up review, notification, or activity record. tags: - Document Reviews parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/reviewIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddDocumentReviewDecisionRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddDocumentReviewDecisionResponse' "409": description: The review is already complete. No decision was created. headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: type: object properties: message: type: string example: message: Review is already complete security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /documents/{documentId}/syncs: get: operationId: GetDocumentSyncs summary: Get document syncs description: Retrieve the document syncs with external services status tags: - Documents parameters: - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/shareKeyParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentSyncResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddDocumentSync summary: Add document sync to service description: Add a document to a service tags: - Documents parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/AddDocumentSyncRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/tags: get: operationId: GetDocumentTags summary: Get document's tags description: Get a listing of a document's tags tags: - Document Tags parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/shareKeyParam' - $ref: '#/components/parameters/nextParam' - name: previous in: query description: Previous page of results token schema: type: string responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentTagsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddDocumentTags summary: Add tag to document description: Add multiple tags to a document; this endpoint also accepts a different body parameter for adding a single tag tags: - Document Tags parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddDocumentTagsRequest' examples: Add_Key_Only_Tag: value: key: category Add_Key_and_Value_Tag: value: key: category value: person Add_Key_and_Values_Tag: value: key: category values: - person - canadian responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' patch: operationId: UpdateDocumentTags summary: Update document tags description: Updates multiple tags to a document; this endpoint also accepts a different body parameter for updating a single tag tags: - Document Tags parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddDocumentTagsRequest' examples: Add_Key_Only_Tag: value: tags: - key: category Add_Key_and_Value_Tag: value: tags: - key: category value: sample Add_Key_and_Values_Tag: value: tags: - key: players values: - "111" - "222" responses: "200": $ref: '#/components/responses/200CorsUpdateResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' put: operationId: SetDocumentTags summary: Set document's tags description: Set multiple tags to a document; this endpoint also accepts a different body parameter for setting a single tag tags: - Document Tags parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddDocumentTagsRequest' examples: Add_Key_Only_Tag: value: tags: - key: category Add_Key_and_Value_Tag: value: tags: - key: category value: sample Add_Key_and_Values_Tag: value: tags: - key: players values: - "111" - "222" responses: "200": $ref: '#/components/responses/200CorsSetResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/tags/{tagKey}: get: operationId: GetDocumentTag summary: Get document tag by key description: Get a document tag by using its key tags: - Document Tags parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/tagkeyParam' - $ref: '#/components/parameters/shareKeyParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentTagResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' put: operationId: SetDocumentTag summary: Update document tag value(s) description: Update any and all values of a document tag, by using its key; you can supply one tag value or a list of tag values in the request body tags: - Document Tags parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/tagkeyParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetDocumentTagKeyRequest' responses: "200": $ref: '#/components/responses/200CorsUpdateResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' delete: operationId: DeleteDocumentTag summary: Delete document tag description: Delete a document tag by using its key tags: - Document Tags parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/tagkeyParam' responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/tags/{tagKey}/{tagValue}: delete: operationId: DeleteDocumentTagAndValue summary: Delete document's tag value description: Delete a specific document tag's key/value combination; the request will be ignored if there is no valid key/value combination found tags: - Document Tags parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/tagkeyParam' - $ref: '#/components/parameters/tagvalueParam' - $ref: '#/components/parameters/shareKeyParam' responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/tags: patch: operationId: UpdateMatchingDocumentTags summary: Mass Update document tag(s) description: This API request allows the adding/updating of multiple document tag(s) based on document(s) that have the matching tag. tags: - Document Tags parameters: - $ref: '#/components/parameters/siteIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateMatchingDocumentTagsRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/UpdateMatchingDocumentTagsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/upload: get: operationId: GetDocumentUpload summary: Get url to add large document description: Returns a URL that can be used to upload document content and create a new document; this endpoint (whether GET or POST) is required in order to add content that is larger than 5 MB tags: - Documents parameters: - name: path in: query description: The upload file's path schema: type: string - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/checksumTypeParam' - $ref: '#/components/parameters/checksumParam' - $ref: '#/components/parameters/contentLengthParam' - $ref: '#/components/parameters/durationParam' - $ref: '#/components/parameters/shareKeyParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentUrlResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddDocumentUpload summary: Add large document description: |- Returns a URL that can be used to upload document content and create a new document. This endpoint is required for uploading content larger than 5 MB and allows document metadata to be provided at creation time. **Content Type Detection** If the document **Content-Type** is not specified during upload, the service will determine it asynchronously after the upload completes. This may result in a **temporary delay** before the content type and related metadata are available. tags: - Documents parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/contentLengthParam' - $ref: '#/components/parameters/durationParam' - $ref: '#/components/parameters/shareKeyParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddDocumentUploadRequest' examples: Simple_File: value: path: test.txt contentType: text/plain tags: - key: category value: sample - key: players values: - "111" - "222" metadata: - key: info value: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentUrlResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /documents/{documentId}/upload: get: operationId: GetDocumentIdUpload summary: Get url to update large document parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/checksumTypeParam' - $ref: '#/components/parameters/checksumParam' - $ref: '#/components/parameters/contentLengthParam' - $ref: '#/components/parameters/durationParam' - $ref: '#/components/parameters/shareKeyParam' description: Returns a URL that can be used to upload documents for a specific documentId; this endpoint is required in order to add content that is larger than 5 MB. If versions are enabled, this will create a new version of the document. tags: - Documents responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentUrlResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/url: get: operationId: GetDocumentUrl summary: Get document content url description: Returns a URL for the document's contents; this URL will expire (the default is 48 hours) tags: - Documents parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/versionKeyParam' - $ref: '#/components/parameters/durationParam' - $ref: '#/components/parameters/shareKeyParam' - name: inline in: query description: Request inline delivery. S3-backed SVG documents identified by content type or filename are always served as attachments. schema: type: boolean default: false - name: bypassWatermark in: query description: Allow the by pass of watermark (only allowed by GOVERN / ADMIN permissions) schema: type: boolean default: false - name: format in: query description: Return a shortlink URL when set to `short`; available as an Add-On Module schema: type: string enum: - short responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentUrlResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/versions: get: operationId: GetDocumentVersions summary: Get document's versions description: Get a listing of document content and metadata versions; available as an Add-On Module tags: - Document Versions parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/shareKeyParam' - $ref: '#/components/parameters/nextParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentVersionsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' put: operationId: SetDocumentVersion summary: Set version of document description: Set document to a previous document version; available as an Add-On Module tags: - Document Versions parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetDocumentVersionRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetDocumentVersionResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/versions/{versionKey}: delete: operationId: DeleteDocumentVersion summary: Delete document version description: Delete a specific previous document version; available as an Add-On Module tags: - Document Versions parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/versionKeyPath' - $ref: '#/components/parameters/shareKeyParam' responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/workflows: get: operationId: GetDocumentWorkflows summary: Get document workflows description: Gets a document workflows; available as an Add-On Module tags: - Document Workflows parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' responses: "200": description: 200 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentWorkflowsResponse' "400": description: 400 BAD REQUEST headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddDocumentWorkflow summary: Add document workflow description: Creates a document workflow; available as an Add-On Module tags: - Document Workflows parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddDocumentWorkflowRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddDocumentWorkflowResponse' "400": description: 400 BAD REQUEST headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /documents/{documentId}/workflows/{workflowId}: get: operationId: GetDocumentWorkflow summary: Get document workflow description: Gets a document workflow; available as an Add-On Module tags: - Document Workflows parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/workflowIdParam' responses: "200": description: 200 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocumentWorkflowResponse' "400": description: 400 BAD REQUEST headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /documents/{documentId}/workflow/{workflowId}/decisions: post: operationId: AddDocumentWorkflowDecisions summary: Approve/Reject document in approval queue description: Approve/Reject document in approval queue; available as an Add-On Module tags: - Document Workflows parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/workflowIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddDocumentWorkflowDecisionsRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddDocumentWorkflowDecisionsResponse' "400": description: 400 BAD REQUEST headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /entityTypes: get: operationId: GetEntityTypes tags: - Entity description: Returns a list of entity types summary: Get EntityTypes parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/namespaceParam' - $ref: '#/components/parameters/nextParam' - $ref: '#/components/parameters/limitParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetEntityTypesResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddEntityType description: Creates a Entity Type summary: Add New EntityType tags: - Entity parameters: - $ref: '#/components/parameters/siteIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddEntityTypeRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddEntityTypeResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /entityTypes/{entityTypeId}: get: operationId: GetEntityType tags: - Entity description: Returns a entity type summary: Get EntityType parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/entityTypeIdParam' - $ref: '#/components/parameters/namespaceParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetEntityTypeResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' put: operationId: SetEntityType description: Sets a Entity Type summary: Set EntityType tags: - Entity parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/entityTypeIdParam' - $ref: '#/components/parameters/createIfMissingParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetEntityTypeRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' delete: operationId: DeleteEntityType description: Deletes Entity Type summary: Deletes Entity Type tags: - Entity parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/entityTypeIdParam' responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /entities/{entityTypeId}: get: operationId: GetEntities tags: - Entity description: Returns a list of entities summary: Get Entities parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/entityTypeIdParam' - $ref: '#/components/parameters/namespaceParam' - $ref: '#/components/parameters/nextParam' - $ref: '#/components/parameters/limitParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetEntitiesResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddEntity description: Creates a Entity summary: Add New Entity tags: - Entity parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/entityTypeIdParam' - $ref: '#/components/parameters/namespaceParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddEntityRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddEntityResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /entities/{entityTypeId}/{entityId}: get: operationId: GetEntity tags: - Entity description: Returns a entity summary: Get Entity parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/entityTypeIdParam' - $ref: '#/components/parameters/entityIdParam' - $ref: '#/components/parameters/namespaceParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetEntityResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' put: operationId: SetEntity description: Sets a Entity summary: Set Entity tags: - Entity parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/entityTypeIdParam' - $ref: '#/components/parameters/entityIdParam' - $ref: '#/components/parameters/namespaceParam' - $ref: '#/components/parameters/createIfMissingParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetEntityRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' patch: operationId: UpdateEntity description: Updates a Entity summary: Update Entity tags: - Entity parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/entityTypeIdParam' - $ref: '#/components/parameters/entityIdParam' - $ref: '#/components/parameters/namespaceParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateEntityRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/UpdateResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' delete: operationId: DeleteEntity description: Deletes Entity summary: Deletes Entity tags: - Entity parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/entityTypeIdParam' - $ref: '#/components/parameters/entityIdParam' responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /entities/{entityTypeId}/{entityId}/attributes/{attributeKey}: delete: operationId: DeleteEntityAttribute description: Deletes Entity Attribute summary: Deletes Entity Attribute tags: - Entity parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/entityTypeIdParam' - $ref: '#/components/parameters/entityIdParam' - $ref: '#/components/parameters/attributeKeyParam' responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /esignature/docusign/{documentId}/envelopes: post: operationId: AddDocusignEnvelopes summary: Create Docusign Envelope request description: DocuSign create Docusign Envelope request; available as an Add-On Module tags: - E-Signature parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddDocusignEnvelopesRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddDocusignEnvelopesResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/esignatureLambdaApi200' /esignature/docusign/{documentId}/envelopes/{envelopeId}: get: operationId: GetDocusignEnvelope summary: Get Docusign envelope and recipient status description: Retrieves the DocuSign envelope using include=recipients and returns the DocuSign response directly, including envelope status and recipient routing information. No FormKiQ fields or wrapper are added. The envelope must be associated with the selected document or artifact. This read-only operation does not update document attributes or download the signed document. Available as an Add-On Module. Repeated status polling must be at least 15 minutes apart. Use recipients.signers[].recipientId from this response as entries in the optional recipientIds array in POST /esignature/docusign/{documentId}/envelopes/{envelopeId}/reminders to request reminders for selected signers. tags: - E-Signature parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/docusignEnvelopeIdParam' - name: environment in: query required: false description: DocuSign environment. Defaults to the site's docusignEnvironment; required when the site has no default. Use the environment in which the envelope was created. schema: $ref: '#/components/schemas/DocusignEnvironment' responses: "200": description: DocuSign envelope with recipients headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetDocusignEnvelopeResponse' example: envelopeId: a1111111-b222-c333-d444-e55555555555 status: sent recipients: recipientCount: "3" currentRoutingOrder: "2" signers: - recipientId: "1" name: Alice email: alice@example.com routingOrder: "1" status: completed - recipientId: "2" name: Bob email: bob@example.com routingOrder: "2" status: delivered - recipientId: "3" name: Carol email: carol@example.com routingOrder: "3" status: created "400": description: Invalid parameters or missing DocuSign configuration content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' "401": description: Authentication required "403": description: Access to the selected document or artifact is denied "404": description: Document, artifact, or associated DocuSign envelope not found "429": description: Envelope polling or DocuSign rate limit exceeded headers: Retry-After: description: Seconds to wait before another lookup schema: type: integer minimum: 0 "502": description: DocuSign authentication failure, upstream error, or invalid response "504": description: DocuSign request timed out security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/esignatureLambdaApi200' /esignature/docusign/{documentId}/envelopes/{envelopeId}/reminders: post: operationId: AddDocusignEnvelopeReminders summary: Request DocuSign signing reminders description: Resends signing notifications for an in-progress DocuSign envelope; available as an Add-On Module. With no request body or an empty object, DocuSign reminds all eligible recipients at the current routing step. Supply recipientIds to remind only the selected eligible signers. Obtain IDs from recipients.signers[].recipientId in GET /esignature/docusign/{documentId}/envelopes/{envelopeId}. Every selected signer must still be awaiting action at the current routing step when this request is processed. Validate the entire selection before issuing a resend. Completed and future-step signers cannot be targeted. Invalid targeted requests never fall back to reminding all recipients. Recipient notification settings are respected; this operation does not send FormKiQ notifications to embedded-only or email-suppressed signers. Requires write access to the selected document or artifact and a matching stored envelope ID. The operation resends the existing invitation without changing recipients, documents, routing, or automatic reminder settings. Targeted responses report each selected recipient's acceptance or failure, with no overall status. Acceptance does not confirm notification delivery. Do not automatically retry after a timeout because the reminder may already have been requested. tags: - E-Signature parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/docusignEnvelopeIdParam' - name: environment in: query required: false description: DocuSign environment. Defaults to the site's docusignEnvironment; required when the site has no default. Use the environment in which the envelope was created. schema: $ref: '#/components/schemas/DocusignEnvironment' requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/AddDocusignEnvelopeRemindersRequest' examples: allCurrentRecipients: summary: Remind all eligible current recipients value: {} selectedSigner: summary: Remind one signer identified by the GET envelope response value: recipientIds: - "2" selectedSigners: summary: Remind multiple signers sharing the current routing step value: recipientIds: - "2" - "3" responses: "200": description: Reminder request processed. For targeted requests, inspect each entry in recipients for acceptance or failure; HTTP 200 does not mean all selected recipients succeeded. An envelope-wide request returns an empty object when DocuSign accepts it, because individual recipient outcomes are not returned. Acceptance does not confirm delivery. headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddDocusignEnvelopeRemindersResponse' examples: selectedRecipients: summary: One reminder accepted and one failed after validation value: recipients: - recipientId: "1" status: accepted - recipientId: "2" status: failed message: Recipient is no longer eligible for a reminder. envelopeWide: summary: Envelope-wide reminder accepted without individual outcomes value: {} "400": description: Invalid parameters, missing DocuSign configuration, ineligible envelope state, or unknown or ineligible signers. Null or empty recipientIds arrays, duplicate IDs, and null, blank, or non-string entries are rejected. The singular recipientId field is not accepted. Draft and terminal envelopes cannot be reminded. content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' "401": description: Authentication required "403": description: Write access to the selected document or artifact is denied "404": description: Document, artifact, or associated DocuSign envelope not found "429": description: DocuSign rate limit exceeded "502": description: DocuSign authentication failure, upstream error, or invalid response "504": description: DocuSign request timed out; reminder delivery outcome is unknown security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/esignatureLambdaApi200' /esignature/docusign/{documentId}/envelopes/{envelopeId}/void: post: operationId: VoidDocusignEnvelope summary: Void a DocuSign envelope description: Cancels an in-progress DocuSign envelope; available as an Add-On Module. Requires write access to the selected document or artifact and a matching stored envelope ID. Calls DocuSign's envelope update API, PUT /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}, with status set to voided and the supplied voidedReason. DocuSign notifies recipients that the envelope was voided, including the supplied reason. Only sent or delivered envelopes can be voided. If the envelope is already voided, returns its current state without another update or changing its original reason. Voiding cannot be undone. The existing envelope-voided callback updates the stored FormKiQ status. After a timeout, the outcome is unknown; check the existing GET envelope status endpoint before attempting the operation again. externalDocs: description: DocuSign Envelopes update API url: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopes/update/ tags: - E-Signature parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/docusignEnvelopeIdParam' - name: environment in: query required: false description: DocuSign environment. Defaults to the site's docusignEnvironment; required when the site has no default. Use the environment in which the envelope was created. schema: $ref: '#/components/schemas/DocusignEnvironment' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/VoidDocusignEnvelopeRequest' example: voidedReason: Document has been replaced. responses: "200": description: DocuSign envelope voided successfully headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/VoidDocusignEnvelopeResponse' example: envelopeId: a1111111-b222-c333-d444-e55555555555 status: voided "400": description: Invalid parameters, missing, blank, or overlong voidedReason, missing DocuSign configuration, or an envelope that is not eligible to be voided. content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' "401": description: Authentication required "403": description: Write access to the selected document or artifact is denied "404": description: Document, artifact, or associated DocuSign envelope not found "429": description: DocuSign rate limit exceeded "502": description: DocuSign authentication failure, upstream error, or invalid response "504": description: DocuSign request timed out; the void operation outcome is unknown security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/esignatureLambdaApi200' /esignature/docusign/{documentId}/envelopes/{envelopeId}/views/recipient: post: operationId: AddDocusignRecipientView summary: Create Docusign Recipient View request description: DocuSign create Docusign Recipient View request; available as an Add-On Module tags: - E-Signature parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/docusignEnvelopeIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddDocusignRecipientViewRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddDocusignRecipientViewResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/esignatureLambdaApi200' /esignature/docusign/{documentId}/envelopes/{envelopeId}/views/sender: post: operationId: AddDocusignSenderView summary: Create Docusign Sender View request description: DocuSign create Docusign Sender View request; available as an Add-On Module tags: - E-Signature parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' - $ref: '#/components/parameters/docusignEnvelopeIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddDocusignSenderViewRequest' example: returnUrl: https://console.example.com/agreements/123/esignature responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddDocusignSenderViewResponse' example: viewUrl: https://... "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/esignatureLambdaApi200' /esignature/docusign/events: post: operationId: AddEsignatureDocusignEvents summary: Add E-signature event description: DocuSign callback URL handler; available as an Add-On Module tags: - E-Signature responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddResponse' x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/esignatureLambdaApi200' /folders: get: operationId: GetFolderDocuments summary: Get document folders description: Get list of documents in a folder tags: - Document Folders parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/indexKeyQueryParam' - $ref: '#/components/parameters/pathQueryParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/shareKeyParam' - $ref: '#/components/parameters/nextParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetFoldersResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/searchLambdaApi200' post: operationId: AddFolder summary: Add document folder description: Creates a new folder tags: - Document Folders parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/shareKeyParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddFolderRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddFolderResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /folders/{indexKey}/moves: post: operationId: MoveFolder summary: Move document folder description: Creates an asynchronous folder move request tags: - Document Folders parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/indexKeyParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MoveFolderRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/MoveFolderResponse' example: message: folder move request created security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /folders/{indexKey}: delete: operationId: DeleteFolder summary: Delete document folder description: Delete a specific folder; folder must be empty tags: - Document Folders parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/indexKeyParam' - $ref: '#/components/parameters/shareKeyParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DeleteFolderResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /folders/{indexKey}/permissions: get: operationId: GetFolderPermissions summary: Get folder permissions description: Get list of permissions for a folder tags: - Document Folders parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/indexKeyParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetFolderPermissionsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/searchLambdaApi200' /folders/permissions: put: operationId: SetFolderPermissions summary: Sets Folder Permissions description: |- Sets a folders permissions NOTE: Can only be called be ADMIN or GOVERN. tags: - Document Folders parameters: - $ref: '#/components/parameters/siteIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetFolderPermissionsRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /integrations/google/drive/documents/{documentId}/export: post: operationId: AddGoogleDocumentExport description: Exports a Google Document; available as an Add-On Module summary: Add Google Document Export tags: - Google Integration parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' - $ref: '#/components/parameters/artifactIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddGoogleDocumentExportRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddGoogleDocumentExportResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/googleLambdaApi201' /groups: get: operationId: GetGroups description: Returns the list of user groups summary: Get list of user group(s) parameters: - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' tags: - User Management responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetGroupsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddGroup description: Add a new group summary: Add a group tags: - User Management requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddGroupRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /groups/{groupName}: get: operationId: GetGroup description: Returns a user group summary: Get a user group parameters: - $ref: '#/components/parameters/groupNamePath' tags: - User Management responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetGroupResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' delete: operationId: DeleteGroup summary: Delete Group description: Delete Group tags: - User Management parameters: - $ref: '#/components/parameters/groupNamePath' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /groups/{groupName}/users: get: operationId: GetUsersInGroup description: Returns the list of users in a group summary: Get users in a group parameters: - $ref: '#/components/parameters/groupNamePath' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' tags: - User Management responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetUsersInGroupResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddUserToGroup description: Adds a user to a group summary: Add User to a group parameters: - $ref: '#/components/parameters/groupNamePath' tags: - User Management requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddUserRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /groups/{groupName}/users/{username}: delete: operationId: RemoveUsernameFromGroup summary: Remove Username From Group description: Remove Username From Group tags: - User Management parameters: - $ref: '#/components/parameters/groupNamePath' - $ref: '#/components/parameters/usernamePath' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /users: get: operationId: GetUsers description: Returns the list of users summary: Get list of user(s) parameters: - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' tags: - User Management responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetUsersResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddUser description: Adds a user summary: Add User tags: - User Management requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddUserRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /users/{username}: get: operationId: GetUser description: Returns a user summary: Get a user parameters: - $ref: '#/components/parameters/usernamePath' tags: - User Management responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetUserResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' delete: operationId: DeleteUsername summary: Delete Username description: Delete Username tags: - User Management parameters: - $ref: '#/components/parameters/usernamePath' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /users/{username}/groups: get: operationId: GetListOfUserGroups description: Returns a list of group user belongs to summary: Returns a list of group user belongs to parameters: - $ref: '#/components/parameters/usernamePath' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' tags: - User Management responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetUserGroupsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /users/{username}/{userOperation}: put: operationId: SetUserOperation description: Set User Operation (disable, enable, reset-password) summary: Set User Operation parameters: - $ref: '#/components/parameters/usernamePath' - $ref: '#/components/parameters/usernameOperationPath' tags: - User Management responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /indices/{indexType}/move: post: operationId: IndexFolderMove description: Perform an Folder Index Move tags: - Custom Index parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/indexTypeParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/IndexFolderMoveRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/IndexFolderMoveResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /indices/{indexType}/{indexKey}: delete: operationId: DeleteIndex description: |- Perform a delete on the Folder Index. When deleting a file from the "folder" index, you can set the indexKey to a URLEncoded path variable. tags: - Custom Index parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/indexKeyParam' - $ref: '#/components/parameters/indexTypeParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DeleteIndicesResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /indices/search: post: operationId: IndexSearch description: Perform a search on a index; this is currently available for both folder and tag indices tags: - Custom Index - Tag Index parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' - name: previous in: query description: Previous page of results token schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/IndexSearchRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/IndexSearchResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /mappings: get: operationId: GetMappings tags: - Mappings description: Returns a list of mappings; available as an Add-On Module summary: Get Mappings parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetMappingsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddMapping description: Creates a new mapping; available as an Add-On Module summary: Add New Mapping tags: - Mappings parameters: - $ref: '#/components/parameters/siteIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddMappingRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddMappingResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /mappings/{mappingId}: get: operationId: GetMapping tags: - Mappings description: Get a mapping; available as an Add-On Module summary: Get Mapping parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/mappingIdParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetMappingResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' put: operationId: SetMapping description: Sets an mapping; available as an Add-On Module summary: Set Mapping tags: - Mappings parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/mappingIdParam' - $ref: '#/components/parameters/createIfMissingParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetMappingRequest' responses: "200": description: 200 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' delete: operationId: DeleteMapping description: Delete Mapping; available as an Add-On Module summary: Delete Mapping tags: - Mappings parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/mappingIdParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /objects/examine/pdf: get: operationId: GetExaminePdfUrl description: Get Signed URL for PDF Object Upload of a document to be examined by calling GET /objects/examine/{id}/pdf summary: Add Examine Pdf tags: - Examine Objects parameters: - $ref: '#/components/parameters/siteIdParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetExaminePdfUrlResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/ocrObjectsLambdaApi200' /objects/examine/{id}/pdf: get: operationId: GetExaminePdf description: |- Get PDF details File must have been uploaded previously using the GET /objects/examine/pdf API. summary: Add Examine Pdf tags: - Examine Objects parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/idParam' responses: "201": description: 201 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetExaminePdfResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/ocrObjectsLambdaApi200' /publications/{documentId}: get: operationId: GetPublishedDocumentContent summary: Get published document's contents description: Get a published document's contents. Certain content types, text/*, application/json, and application/x-www-form-urlencoded. return the "content" field, while all other content types return a 'contentUrl' for retrieving the content. tags: - Documents parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' responses: "307": description: Temporary Redirect headers: Location: schema: type: string security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' delete: operationId: DeletePublishedDocumentContent summary: Delete published document's contents description: Delete a published document's contents. Certain content types, text/*, application/json, and application/x-www-form-urlencoded. return the "content" field, while all other content types return a 'contentUrl' for retrieving the content. tags: - Documents parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/documentIdParam' responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /queues: get: operationId: GetQueues summary: Get queues description: Get a listing of queues; available as an Add-On Module parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/nextParam' - $ref: '#/components/parameters/limitParam' tags: - Document Workflows responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetQueuesResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddQueue summary: Add queue description: Creates a new Queue; available as an Add-On Module tags: - Document Workflows parameters: - $ref: '#/components/parameters/siteIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddQueueRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddQueueResponse' "400": description: 400 BAD REQUEST headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /queues/{queueId}: get: operationId: GetQueue summary: Get queue description: Get a queue; available as an Add-On Module parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/queueIdParam' tags: - Document Workflows responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetQueueResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' delete: operationId: DeleteQueue summary: Delete queue description: Delete a Queue; available as an Add-On Module tags: - Document Workflows parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/queueIdParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DeleteQueueResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /queues/{queueId}/documents: get: operationId: GetWorkflowQueueDocuments summary: Get list of documents in queue description: List documents in Workflow Queue; available as an Add-On Module tags: - Document Workflows parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/queueIdParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetWorkflowQueueDocumentsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/searchLambdaApi200' /rulesets: get: operationId: GetRulesets tags: - Rulesets description: Returns a list of rule sets; available as an Add-On Module summary: Get Rulesets parameters: - $ref: '#/components/parameters/siteIdParam' - name: next in: query description: Next page of results token schema: type: string - $ref: '#/components/parameters/limitParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetRulesetsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddRuleset description: Creates a new ruleset; available as an Add-On Module summary: Add New Ruleset tags: - Rulesets parameters: - $ref: '#/components/parameters/siteIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddRulesetRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddRulesetResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /rulesets/{rulesetId}: get: operationId: GetRuleset tags: - Rulesets description: Get a rule sets; available as an Add-On Module summary: Get Ruleset parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/rulesetIdParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetRulesetResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' patch: operationId: UpdateRuleset description: Updates an existing ruleset; available as an Add-On Module summary: Update Ruleset tags: - Rulesets parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/rulesetIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateRulesetRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/UpdateRulesetResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' delete: operationId: DeleteRuleset description: Delete Ruleset; available as an Add-On Module summary: Delete Ruleset tags: - Rulesets parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/rulesetIdParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DeleteRulesetResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /rulesets/{rulesetId}/rules: get: operationId: GetRules tags: - Rulesets description: Returns a list of rules in a ruleset; available as an Add-On Module summary: Get Rules parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/rulesetIdParam' - $ref: '#/components/parameters/nextParam' - $ref: '#/components/parameters/limitParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetRulesResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddRule description: Creates a new rule; available as an Add-On Module summary: Add New Rule tags: - Rulesets parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/rulesetIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddRuleRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddRuleResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /rulesets/{rulesetId}/rules/{ruleId}: get: operationId: GetRule tags: - Rulesets description: Returns a rule in a ruleset; available as an Add-On Module summary: Get Rule parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/rulesetIdParam' - $ref: '#/components/parameters/ruleIdParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetRuleResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' patch: operationId: UpdateRule description: Update Rule; available as an Add-On Module summary: Update Rule tags: - Rulesets parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/rulesetIdParam' - $ref: '#/components/parameters/ruleIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateRuleRequest' responses: "200": description: 200 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/UpdateRuleResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' delete: operationId: DeleteRule description: Delete Rule; available as an Add-On Module summary: Delete Rule tags: - Rulesets parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/rulesetIdParam' - $ref: '#/components/parameters/ruleIdParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DeleteRuleResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /search: post: operationId: DocumentSearch summary: Document search description: "Document search query request; \n\nSupports searching DynamoDB for document(s) by a single TAG key and/or value. Value can be \"exacted\" or \"begins_with\" matched. Search can be filtered to only check certain documentIds (up to 100 documentIds accepted).\n\nIf using Enteprise Composite Keys feature then multiple tag(s) can be searched for.\n\nIf Typesense is enabled, full text search is supported through the \"text\" parameter. Full text search will look for the text in the \"content\" and/or document \"metadata\".\n\nDocumentIds parameter allows you to filter your results to a specific set of documents. \n\nSee requestBody examples below for commmon examples." tags: - Document Search parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' - name: previous in: query description: Previous page of results token schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DocumentSearchRequest' examples: Search_By_Attribute_Key: value: query: attribute: key: category Search_By_Attribute_Value: value: query: attribute: key: category eq: person Search_By_Attribute_Value_Begins_With: value: query: attribute: key: firstname beginsWith: jo Search_By_Tag_Key: value: query: tag: key: category Search_By_Tag_Value: value: query: tag: key: category eq: person Tag_Value_Begins_With: value: query: tag: key: firstname beginsWith: jo Search_By_Value_for_Specific_Documents: value: query: tag: key: category eq: person documentIds: - "1" - "2" Typesense_Fulltext_Search: value: query: text: my search text responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DocumentSearchResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/searchLambdaApi200' /searchFulltext: post: operationId: SearchFulltext summary: Document full-text search description: Document full-text search (and more robust multi-tag search queries, powered by OpenSearch); available as an Add-On Module tags: - Advanced Document Search parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/indexNameQuery' - $ref: '#/components/parameters/limitParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DocumentFulltextRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DocumentFulltextResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' /queryFulltext: post: operationId: QueryFulltext summary: Direct opensearch search API description: |- Endpoint for allowing custom, complex queries using the OpenSearch search API (https://opensearch.org/docs/latest/opensearch/rest-api/search/); available as an Add-On Module Example Request Body: { "query": { "match_all": {} }} tags: - Advanced Document Search parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/indexNameQuery' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/QueryFulltextRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/QueryFulltextResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' /shares: get: operationId: GetUserShares summary: Get user shared folders description: Get a listing of user folder/document shares; available as an Add-On Module parameters: - $ref: '#/components/parameters/groupParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' tags: - Document Shares responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetUserSharesResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /shares/folders/{indexKey}: post: operationId: AddFolderShare summary: Add folder share description: Creates a new folder share; available as an Add-On Module tags: - Document Shares parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/indexKeyParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddFolderShareRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddFolderShareResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /shares/{shareKey}: delete: operationId: DeleteShare summary: Delete folder share description: Delete a specific document share; available as an Add-On Module tags: - Document Shares parameters: - $ref: '#/components/parameters/shareKey' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DeleteShareResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /shortlinks: post: operationId: AddShortlink summary: Add shortlink description: Create a shortlink for a target URL tags: - Shortlinks requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddShortlinkRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddShortlinkResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /sites: get: operationId: GetSites description: Returns the list of sites that the user has access to summary: Get site(s) access tags: - System Management parameters: - name: status in: query description: Fetch sites with status (only valid when using SitePermissions 'defined' schema: $ref: '#/components/schemas/SiteStatus' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetSitesResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddSite description: Add Site summary: Add Site tags: - System Management requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddSiteRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /sites/{siteId}: patch: operationId: UpdateSite description: Update Site summary: Update Site tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateSiteRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/UpdateResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/groups: get: operationId: GetSiteGroups description: Returns list of groups and permissions belonging to site summary: Get group(s) and permissions belonging to site tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetSiteGroupsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/groups/{groupName}: get: operationId: GetSiteGroup description: Returns details of a group and permissions belonging to site summary: Get group and permissions belonging to site tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/groupNamePath' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetSiteGroupResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' delete: operationId: DeleteSiteGroup description: Deletes Site Group and permissions summary: Deletes Site Group and permissions tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/groupNamePath' responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/groups/{groupName}/permissions: put: operationId: SetSiteGroupPermissions description: Set Site's Group Permissions summary: Set Site's Group Permissions tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/groupNamePath' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetGroupPermissionsRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/opensearch/index: get: operationId: GetOpenSearchIndex description: "Returns the OpenSearch index settings \n\n(Deprecated use /sites/{siteId}/opensearch/indices)" summary: Get site(s) OpenSearch index settings tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetOpenSearchIndexResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' put: operationId: SetOpenSearchIndex description: Sets the OpenSearch index settings summary: Set site(s) OpenSearch index settings tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetOpenSearchIndexRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetOpenSearchIndexResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' delete: operationId: DeleteOpenSearchIndex description: Deletes the OpenSearch index summary: Deletes site(s) OpenSearch index tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' /sites/global/opensearch/indices: get: operationId: GetAllOpenSearchIndices description: Returns all OpenSearch indices summary: Get all OpenSearch indices tags: - System Management responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetOpenSearchIndiceResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' /sites/global/opensearch/indices/{indexName}: delete: operationId: DeleteOpenSearchIndexByName description: Deletes the OpenSearch index by name summary: Deletes OpenSearch index by name tags: - System Management parameters: - $ref: '#/components/parameters/indexNamePath' responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' /sites/{siteId}/opensearch/indices: get: operationId: GetOpenSearchIndices description: Returns the OpenSearch indices summary: Get site(s) OpenSearch indices tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetOpenSearchIndiceResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' put: operationId: SetOpenSearchIndices description: Sets the OpenSearch index to use for a SiteId summary: Set site(s) OpenSearch index to use for a SiteId tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetOpenSearchIndiceRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' /sites/global/opensearch/snapshotRepositories: get: operationId: GetOpenSearchSnapshotRepositories description: |- Returns all configured OpenSearch S3 snapshot repositories for the deployment. This endpoint is available to administrators when the fulltext OpenSearch module is installed and snapshot support is enabled. Snapshot repositories are not supported for OpenSearch Serverless. summary: List OpenSearch snapshot repositories tags: - System Management responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetOpenSearchSnapshotRepositoryResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' /sites/global/opensearch/snapshotRepositories/{repositoryName}/cleanup: post: operationId: CleanupOpenSearchSnapshotRepository description: |- Cleans up stale data in the specified OpenSearch snapshot repository. This endpoint clears data no longer referenced by any existing snapshot. This operation is not supported for OpenSearch Serverless. summary: Cleanup OpenSearch snapshot repository tags: - System Management parameters: - $ref: '#/components/parameters/snapshotRepositoryNamePath' - name: cluster_manager_timeout in: query description: The amount of time to wait for a response from the cluster manager node. required: false schema: type: string - name: timeout in: query description: The amount of time to wait for the operation to complete. required: false schema: type: string responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/CleanupOpenSearchSnapshotRepositoryResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' /sites/{siteId}/opensearch/snapshotRepository: get: operationId: GetOpenSearchSnapshotRepository description: |- Returns the S3 snapshot repository configured for the specified site. The repository stores manual snapshots for the site's OpenSearch index. It is named from the site and application environment and is created automatically when a snapshot is requested. Snapshot repositories are not supported for OpenSearch Serverless. summary: Get site OpenSearch snapshot repository tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetOpenSearchSnapshotRepositoryResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' delete: operationId: DeleteOpenSearchSnapshotRepository description: |- Deletes the S3 snapshot repository configured for the specified site's OpenSearch index. This removes the OpenSearch repository registration, not the site's index. This operation is not supported for OpenSearch Serverless. summary: Delete site OpenSearch snapshot repository tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' /sites/{siteId}/opensearch/snapshots: get: operationId: GetOpenSearchSnapshots description: |- Returns snapshots for the specified site's OpenSearch index. For provisioned OpenSearch domains, the response is read from the site's S3 snapshot repository. For OpenSearch Serverless, the response is read from the automated snapshot repository. summary: List site OpenSearch snapshots tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetOpenSearchSnapshotResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' /sites/{siteId}/opensearch/snapshots/{snapshotName}: get: operationId: GetOpenSearchSnapshot description: |- Returns details for a snapshot of the specified site's OpenSearch index. For provisioned OpenSearch domains, the supplied snapshot name is resolved to the site's stored snapshot name before lookup. For OpenSearch Serverless, the response is read from the automated snapshot repository. summary: Get site OpenSearch snapshot tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/snapshotNamePath' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetOpenSearchSnapshotResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' post: operationId: AddOpenSearchSnapshot description: |- Creates a manual snapshot of the specified site's OpenSearch index. If the site's S3 snapshot repository does not already exist, it is registered before the snapshot is created. The supplied snapshot name is stored with the site prefix. This operation is not supported for OpenSearch Serverless. summary: Create site OpenSearch snapshot tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/snapshotNamePath' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' delete: operationId: DeleteOpenSearchSnapshot description: |- Deletes a manual snapshot from the specified site's S3 snapshot repository. The supplied snapshot name is resolved to the site's stored snapshot name before deletion. This operation is not supported for OpenSearch Serverless. summary: Delete site OpenSearch snapshot tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/snapshotNamePath' responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' /sites/{siteId}/opensearch/snapshots/{snapshotName}/restore: post: operationId: AddOpenSearchRestoreSnapshot description: |- Restores the specified snapshot into a separate OpenSearch index for the site. The restored index is created from the site's current index name with the snapshot name and "_restored" suffix. For provisioned OpenSearch domains, the snapshot is read from the site's S3 snapshot repository. For OpenSearch Serverless, the snapshot is read from the automated snapshot repository. summary: Restore site OpenSearch snapshot tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/snapshotNamePath' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' delete: operationId: DeleteOpenSearchRestoreSnapshot description: |- Deletes the restored OpenSearch index created from the specified snapshot. This deletes only the restored index named with the snapshot name and "_restored" suffix. It does not delete the original site index or the snapshot. This operation is not supported for OpenSearch Serverless. summary: Delete restored OpenSearch snapshot index tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/snapshotNamePath' responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200' /sites/{siteId}/schema/document: get: operationId: GetSitesSchema description: Gets Sites schema summary: Get Sites Schema tags: - Schemas parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/localeQueryParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetSitesSchemaResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' put: operationId: SetSitesSchema description: Sets Sites schema summary: Set Sites Schema tags: - Schemas parameters: - $ref: '#/components/parameters/siteIdPathParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetSitesSchemaRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/schema/document/attributes/{key}/allowedValues: get: operationId: GetSitesSchemaAttributeAllowedValues tags: - Schemas description: Returns an attribute's allowed values from the site schema summary: Get Attribute Allowed Values parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/keyParam' - $ref: '#/components/parameters/localeQueryParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetAttributeAllowedValuesResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/classifications: get: operationId: GetSitesClassifications description: Gets Sites Classifications summary: Get Sites Classifications tags: - Schemas parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetClassificationsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddClassification description: Add Classification summary: Add Classification tags: - Schemas parameters: - $ref: '#/components/parameters/siteIdPathParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddClassificationRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddClassificationResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/classifications/{classificationId}: get: operationId: GetClassification description: Get Classification summary: Get Classification tags: - Schemas parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/classificationIdParam' - $ref: '#/components/parameters/localeQueryParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetClassificationResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' delete: operationId: DeleteClassification description: Delete Classification summary: Delete Classification tags: - Schemas parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/classificationIdParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' put: operationId: SetClassification description: Sets Classification summary: Set Classification tags: - Schemas parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/classificationIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetClassificationRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/classifications/{classificationId}/attributes/{key}/allowedValues: get: operationId: GetClassificationAttributeAllowedValues tags: - Schemas description: Returns an attribute's allowed values that spans for a specific classifications and site schema summary: Get Classification's Attribute Allowed Values parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/classificationIdParam' - $ref: '#/components/parameters/keyParam' - $ref: '#/components/parameters/localeQueryParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetAttributeAllowedValuesResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/configuration: get: operationId: GetConfiguration description: Returns the list of sites that the user has access to summary: Get site configuration tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetConfigurationResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' patch: operationId: UpdateConfiguration description: Update the System Management configuration summary: Update site configuration tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateConfigurationRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/UpdateConfigurationResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/numberingSequences: get: operationId: GetNumberingSequences description: Returns the numbering sequences configured for a site summary: Get numbering sequences tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetNumberingSequencesResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/numberingSequences/{attributeKey}: get: operationId: GetNumberingSequence description: Returns the numbering sequence configured for an attribute key summary: Get numbering sequence tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/attributeKeyParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetNumberingSequenceResponse' "404": description: Numbering sequence not found content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' put: operationId: SetNumberingSequence description: Creates or updates the numbering sequence for an attribute key summary: Set numbering sequence tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/attributeKeyParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetNumberingSequenceRequest' examples: ContractNumber: value: pattern: CONTRACT-{YEAR}-{SEQUENCE} startAt: 1 padding: 5 reset: YEARLY timezone: America/Winnipeg responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetNumberingSequenceResponse' "400": description: Invalid numbering sequence configuration content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/configuration/notification/test: post: operationId: AddNotificationTest description: Queues a test email using the site's saved notification configuration summary: Send a test notification tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddNotificationTestRequest' responses: "202": description: Test notification queued headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddNotificationTestResponse' "400": description: Invalid request or notification configuration content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/apiKeys: get: operationId: GetApiKeys description: Returns the list of ApiKeys summary: Get API Keys tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/nextParam' - $ref: '#/components/parameters/limitParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetApiKeysResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddApiKey description: Adds a new API Key summary: Add API Key tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddApiKeyRequest' examples: AddApiKey: value: name: My API Key responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddApiKeyResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/apiKeys/{apiKey}: delete: operationId: DeleteApiKey description: Adds a new API Key summary: Delete API Key tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/apiKeyParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DeleteApiKeyResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/opa/accessPolicies: get: operationId: GetOpaAccessPolicies description: Returns a list of OPA Access Policies, can only be requested with ADMIN privileges summary: Get OPAs Access Policies tags: - Access Control responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetOpaAccessPoliciesResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/opa/accessPolicy: get: operationId: GetOpaAccessPolicy description: Returns OPA Access Policy, can only be requested with ADMIN privileges summary: Get OPA Access Policy tags: - Access Control parameters: - $ref: '#/components/parameters/siteIdPathParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetOpaAccessPolicyResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/opa/accessPolicy/policyItems: get: operationId: GetOpaAccessPolicyItems description: Returns OPA Access Policy Items, can only be requested with ADMIN privileges summary: Get OPA Access Policy Items tags: - Access Control parameters: - $ref: '#/components/parameters/siteIdPathParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetOpaAccessPolicyItemsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' put: operationId: SetOpaAccessPolicyItems description: Sets opa access policy items summary: Set opa access policy items, can only be requested with ADMIN privileges tags: - Access Control parameters: - $ref: '#/components/parameters/siteIdPathParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetOpaAccessPolicyItemsRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' delete: operationId: DeleteOpaAccessPolicyItems summary: Delete OPA Access Policy Items description: Delete OPA Access Policy Items tags: - Access Control parameters: - $ref: '#/components/parameters/siteIdPathParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/locales: get: operationId: GetLocales description: Returns a list of locale(s) in a specified site summary: Get Locales tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/nextParam' - $ref: '#/components/parameters/limitParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetLocalesResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddLocale description: Adds a new locale to the specified site summary: Add Locale tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddLocaleRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/locales/{locale}: delete: operationId: DeleteLocale summary: Delete Locale description: Delete Locale tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/localeParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/locales/{locale}/resourceItems: get: operationId: GetLocaleResourceItems description: Returns the list resource items summary: Get Resource Items by Locale tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/localeParam' - $ref: '#/components/parameters/nextParam' - $ref: '#/components/parameters/limitParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetLocaleResourceItemsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddLocaleResourceItem description: Adds a new localized resource item for a given locale summary: Add Locale Resource Item tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/localeParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddLocaleResourceItemRequest' examples: interfaceResourceItem: summary: Interface Resource Item Example value: resourceItem: itemType: INTERFACE interfaceKey: mainMenuTitle localizedValue: Main Menu schemaResourceItem: summary: Schema Resource Item Example value: resourceItem: itemType: SCHEMA attributeKey: documentCategory allowedValue: invoice localizedValue: Facture classificationResourceItem: summary: Classification Resource Item Example value: resourceItem: itemType: CLASSIFICATION attributeKey: usageRegistrariat allowedValue: ID localizedValue: Gestion identitaire classificationId: 219a7dd6-5fb2-4556-ad71-0ab4312fe577 responses: "200": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddLocaleResourceItemResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/locales/{locale}/resourceItems/{itemKey}: get: operationId: GetLocaleResourceItem description: Returns the resource item summary: Get Resource Item by Locale tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/localeParam' - $ref: '#/components/parameters/itemKeyParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetLocaleResourceItemResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' put: operationId: SetLocaleResourceItem description: Set a new Locale Resource Item summary: Set Locale Resource Item tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/localeParam' - $ref: '#/components/parameters/itemKeyParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetLocaleResourceItemRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' delete: operationId: DeleteLocaleResourceItem summary: Delete Local Resource Item description: Delete Local Resource Item tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' - $ref: '#/components/parameters/localeParam' - $ref: '#/components/parameters/itemKeyParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /sites/{siteId}/delegationTokens: post: operationId: GenerateDelegationToken description: |- Creates a KMS-signed delegation token for a site. This endpoint requires ADMIN permission for the requested siteId. The returned token is sent on later API requests in the x-formkiq-delegation-token header and reduces the caller's effective permissions to the requested subset for that site. It cannot grant ADMIN, add permissions the caller does not already have, or add access to other sites. When onBehalfOf is supplied, activity created while using the token is attributed to that username while the signed token still records the ADMIN principal that issued it. The reason is signed into the token for audit and support traceability. summary: Generate a delegation token tags: - System Management parameters: - $ref: '#/components/parameters/siteIdPathParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddDelegationTokenRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddDelegationTokenResponse' "400": description: 400 Bad Request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /system/configuration: get: operationId: GetSystemConfiguration description: Returns the system configuration summary: Get system configuration tags: - System Management responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetSystemConfigurationResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' patch: operationId: UpdateSystemConfiguration description: Update the system configuration summary: Update system configuration tags: - System Management requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateSystemConfigurationRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/UpdateResponse' "400": description: 400 OK content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /system/inferenceModels: get: operationId: GetSystemInferenceModels description: Returns the system inference models summary: Get system inference models tags: - System Management responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetSystemInferenceModelsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/dataClassificationLambdaApi200' /system/inferenceModels/agreement: post: operationId: AddSystemInferenceModelAgreement description: Agree to the Bedrock model usage agreement for a system inference model summary: Agree to a system inference model tags: - System Management requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddSystemInferenceModelAgreementRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddResponse' "400": description: 400 Bad Request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/dataClassificationLambdaApi200' /userNotifications: get: operationId: GetUserNotifications summary: Get user notifications description: Retrieve notifications where the authenticated user's email is a CC or BCC recipient tags: - Document Notifications parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetUserNotificationsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /version: get: operationId: GetVersion summary: Get FormKiQ version description: Return the version of FormKiQ tags: - System Management responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetVersionResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /public/webhooks/{webhooks+}: post: operationId: PublicAddWebhook summary: Public add webhook description: Receive an incoming public post to a specified webhook and creates a document based on the data sent; must be enabled during installation (disabled by default) tags: - Public parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/webhooksParam' requestBody: required: true content: application/json: schema: type: object responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DocumentId' x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /private/webhooks/{webhooks+}: post: operationId: AddWebhookDocument summary: Add webhook description: Receive an incoming private webhook and creates a document based on the webhook's body; requires authentication tags: - Webhooks parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/webhooksParam' requestBody: required: true content: application/json: schema: type: object responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DocumentId' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /webhooks: get: operationId: GetWebhooks summary: Get webhooks tags: - Webhooks description: Return a list of webhooks; each webhook's id can be provided to an external service, allowing data to be sent, received, and processed via that webhook parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/nextParam' - $ref: '#/components/parameters/limitParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetWebhooksResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddWebhook summary: Add webhook description: Create a new webhook; once created, a webhook's id can be provided to an external service, allowing data to be sent, received, and processed via that webhook tags: - Webhooks parameters: - $ref: '#/components/parameters/siteIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddWebhookRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddWebhookResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /webhooks/{webhookId}: get: operationId: GetWebhook summary: Get webhook tags: - Webhooks description: Return a webhook's details, i.e., its metadata parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/webhookIdParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetWebhookResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' delete: operationId: DeleteWebhook summary: Delete webhook description: Delete a webhook; this will disable sending, receiving, or processing of data from external services to this webhook tags: - Webhooks parameters: - $ref: '#/components/parameters/webhookIdParam' - $ref: '#/components/parameters/siteIdParam' responses: "200": $ref: '#/components/responses/200CorsDeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' patch: operationId: UpdateWebhook summary: Update webhook description: Updates a webhook's details, i.e., its metadata tags: - Webhooks parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/webhookIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddWebhookRequest' responses: "200": $ref: '#/components/responses/200CorsUpdateResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /webhooks/{webhookId}/tags: get: operationId: GetWebhookTags summary: Get webhook tags description: Get a webhook's tags tags: - Webhooks parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/webhookIdParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetWebhookTagsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddWebhookTag summary: Add webhook tag description: Add a tag to a webhook tags: - Webhooks parameters: - $ref: '#/components/parameters/webhookIdParam' - $ref: '#/components/parameters/siteIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddWebhookTagRequest' examples: Add_Key_Only_Tag: value: key: category Add_Key_and_Value_Tag: value: key: category value: person responses: "201": $ref: '#/components/responses/200Cors' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /workflows: get: operationId: GetWorkflows summary: Get workflows description: Get a listing of workflows; available as an Add-On Module parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/nextParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/statusParam' tags: - Document Workflows responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetWorkflowsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' post: operationId: AddWorkflow summary: Add workflow description: Creates a new Workflow; available as an Add-On Module tags: - Document Workflows parameters: - $ref: '#/components/parameters/siteIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddWorkflowRequest' responses: "201": description: 201 CREATED headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddWorkflowResponse' "400": description: 400 BAD REQUEST headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201' /workflows/{workflowId}: get: operationId: GetWorkflow summary: Get workflow description: Get a workflow; available as an Add-On Module parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/workflowIdParam' tags: - Document Workflows responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetWorkflowResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' delete: operationId: DeleteWorkflow summary: Delete workflow description: Delete a Workflow; available as an Add-On Module tags: - Document Workflows parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/workflowIdParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DeleteResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' put: operationId: SetWorkflow summary: Set workflow description: Set a Workflow details; available as an Add-On Module tags: - Document Workflows parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/workflowIdParam' - $ref: '#/components/parameters/createIfMissingParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetWorkflowRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetResponse' "400": description: 400 BAD REQUEST headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' patch: operationId: UpdateWorkflow summary: Update workflow description: Update a Workflow details; available as an Add-On Module tags: - Document Workflows parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/workflowIdParam' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateWorkflowRequest' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/UpdateResponse' "400": description: 400 BAD REQUEST headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/ErrorsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200' /workflows/{workflowId}/documents: get: operationId: GetWorkflowDocuments summary: Get list of documents in workflow description: List documents in Workflow; available as an Add-On Module tags: - Document Workflows parameters: - $ref: '#/components/parameters/siteIdParam' - $ref: '#/components/parameters/workflowIdParam' - $ref: '#/components/parameters/limitParam' - $ref: '#/components/parameters/nextParam' responses: "200": description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/GetWorkflowDocumentsResponse' security: - ApiAuthorization: [] x-amazon-apigateway-integration: $ref: '#/components/x-amazon-apigateway-integrations/searchLambdaApi200' components: headers: AccessControlAllowOrigin: schema: type: string AccessControlAllowMethods: schema: type: string AccessControlAllowHeaders: schema: type: string Location: schema: type: string responses: 201CorsAddResponse: description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/AddResponse' 200CorsSetResponse: description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/SetResponse' 200CorsDeleteResponse: description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/DeleteResponse' 200CorsUpdateResponse: description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: application/json: schema: $ref: '#/components/schemas/UpdateResponse' 200Cors: description: 200 OK headers: Access-Control-Allow-Origin: $ref: '#/components/headers/AccessControlAllowOrigin' Access-Control-Allow-Methods: $ref: '#/components/headers/AccessControlAllowMethods' Access-Control-Allow-Headers: $ref: '#/components/headers/AccessControlAllowHeaders' content: {} parameters: usernamePath: name: username in: path description: Username required: true schema: type: string usernameOperationPath: name: userOperation in: path description: Username Operation required: true schema: type: string enum: - DISABLE - ENABLE - RESET_PASSWORD groupNamePath: name: groupName in: path description: Group Name required: true schema: type: string versionKeyPath: name: versionKey in: path description: Version Key (version key required URL encoding) required: true schema: type: string versionParam: name: version in: query description: Version required: false schema: type: string versionKeyParam: name: versionKey in: query description: Version Key (version key required URL encoding) required: false schema: type: string webhooksParam: name: webhooks+ in: path required: true description: Web Hook Param schema: type: string webhookIdParam: name: webhookId in: path required: true description: Web Hook Param schema: type: string keyParam: name: key in: path description: Key Identifier required: true schema: type: string entityIdParam: name: entityId in: path description: Entity Identifier required: true schema: type: string entityIdQuery: name: entityId in: query description: Entity Identifier required: false schema: type: string rulesetIdQuery: name: rulesetId in: query description: RulesetId Identifier required: false schema: type: string ruleIdQuery: name: ruleId in: query description: RuleId Identifier required: false schema: type: string workflowIdQuery: name: workflowId in: query description: Workflow Identifier required: false schema: type: string queueIdQuery: name: queueId in: query description: Queue Identifier required: false schema: type: string webhookIdQuery: name: webhookId in: query description: Webhook Identifier required: false schema: type: string attributeKeyQuery: name: attributeKey in: query description: Attribute Key required: false schema: type: string schemaQuery: name: schema in: query description: Schema Type required: false schema: type: string enum: - document controlPolicyQuery: name: controlPolicy in: query description: Control Policy required: false schema: type: string enum: - opa classificationIdQuery: name: classificationId in: query description: Classification Id required: false schema: type: string mappingIdQuery: name: mappingId in: query description: Mapping Id required: false schema: type: string apiKeyQuery: name: apiKey in: query description: Api Key required: false schema: type: string entityTypeIdParam: name: entityTypeId in: path description: EntityType Identifier required: true schema: type: string entityTypeIdQuery: name: entityTypeId in: query description: EntityType Identifier required: false schema: type: string shareKey: name: shareKey in: path description: Share Identifier required: true schema: type: string shareKeyParam: name: shareKey in: query description: Share Identifier required: false schema: type: string siteIdParam: name: siteId in: query description: Site Identifier required: false schema: type: string indexNamePath: name: indexName in: path description: IndexName to path required: true schema: type: string indexNameQuery: name: indexName in: query description: IndexName to query required: false schema: type: string namespaceParam: name: namespace in: query description: Namespace Identifier required: false schema: type: string enum: - PRESET - CUSTOM policyItemIdPathParam: name: policyItemId in: path description: Policy Item Identifier required: true schema: type: string siteIdPathParam: name: siteId in: path description: Site Identifier required: true schema: type: string snapshotRepositoryNamePath: name: repositoryName in: path description: Snapshot Repository Name required: true schema: type: string snapshotNamePath: name: snapshotName in: path description: Snapshot Name required: true schema: type: string localeParam: name: locale in: path description: Site Locale (ISO 639 / ISO 3166) required: true schema: type: string localeQueryParam: name: locale in: query description: Site Locale (ISO 639 / ISO 3166) required: false schema: type: string itemKeyParam: name: itemKey in: path description: Item Key (MUST be URL‑encoded) required: true schema: type: string idParam: name: id in: path description: Identifier required: true schema: type: string documentSearchDeleted: name: deleted in: query description: 'Deprecated: use softDeleted. Fetch soft deleted documents' deprecated: true schema: type: boolean documentSearchSoftDeleted: name: softDeleted in: query description: Fetch soft deleted documents schema: type: boolean groupParam: name: group in: query description: Group Identifier required: false schema: type: string providerParam: name: provider in: query description: Provider Identifier required: true schema: type: string statusParam: name: status in: query description: Filters Status required: false schema: type: string enum: - ACTIVE - INACTIVE ocrOutputTypeParam: name: outputType in: query description: Output Format Type required: false schema: type: string enum: - TEXT - KEY_VALUE - CONTENT_URL - TABLES limitParam: name: limit in: query description: Limit Results required: false schema: type: string default: "10" nextParam: name: next in: query description: Next page of results token required: false schema: type: string startParam: name: start in: query description: Start of date-time range (UTC) schema: type: string format: date-time endParam: name: end in: query description: End of date-time range (UTC) schema: type: string format: date-time sortParam: name: sort in: query description: Sort order (default DESC) required: false schema: type: string enum: - ASC - DESC apiKeyParam: name: apiKey in: path description: API Key required: true schema: type: string folderIdParam: name: folderId in: path description: Folder Identifier required: true schema: type: string checksumParam: name: checksum in: query description: Checksum value required: false schema: type: string checksumTypeParam: name: checksumType in: query description: Checksum Type required: false schema: type: string enum: - SHA1 - SHA256 - SHA512 classificationIdParam: name: classificationId in: path description: Classification Identifier required: true schema: type: string documentIdParam: name: documentId in: path description: Document Identifier required: true schema: type: string artifactIdParam: name: artifactId in: query description: Artifact Document Identifier required: false schema: type: string analysisCategoryParam: name: analysisCategory in: query description: Analysis Category required: false schema: type: string llmPromptEntityNameParam: name: llmPromptEntityName in: path description: LlmPrompt Entity Name required: true schema: type: string documentIdQuery: name: documentId in: query description: Document Identifier required: false schema: type: string docusignEnvelopeIdParam: name: envelopeId in: path description: Docusign Envelope Id required: true schema: type: string mappingIdParam: name: mappingId in: path description: Mapping Identifier required: true schema: type: string rulesetIdParam: name: rulesetId in: path description: Ruleset Identifier required: true schema: type: string ruleIdParam: name: ruleId in: path description: Rule Identifier required: true schema: type: string permissionKeyParam: name: permissionKey in: path description: Permission Identifier required: true schema: type: string queueIdParam: name: queueId in: path description: Queue Id required: true schema: type: string workflowIdParam: name: workflowId in: path description: Workflow Identifier required: true schema: type: string attributeKeyParam: name: attributeKey in: path description: Attribute Key required: true schema: type: string attributeValueParam: name: attributeValue in: path description: Attribute Value required: true schema: type: string tagkeyParam: name: tagKey in: path description: Tag Key required: true schema: type: string tagvalueParam: name: tagValue in: path description: Tag Key Value required: true schema: type: string contentLengthParam: name: contentLength in: query description: Indicates the size of the entity-body required: false schema: type: integer durationParam: name: duration in: query description: Indicates the number of hours request is valid for schema: type: integer contentUrlParam: name: contentUrl in: query description: Whether to return a "contentUrl", set value to 'true' (deprecated) required: false schema: type: string textParam: name: text in: query description: Returns raw 'text' of OCR content. e.g. AWS Textract returns JSON, setting parameter to 'true' converts JSON to Text (deprecated) required: false schema: type: string indexKeyQueryParam: name: indexKey in: query description: Index Key Identifier required: false schema: type: string pathQueryParam: name: path in: query description: Path query parameter (must be URL Encoded) required: false schema: type: string indexKeyParam: name: indexKey in: path description: Index Key Identifier required: true schema: type: string indexTypeParam: name: indexType in: path description: Index Type required: true schema: type: string reviewIdParam: name: reviewId in: path description: Review Identifier required: true schema: type: string createIfMissingParam: name: createIfMissing in: query description: When true, skip checking whether the resource exists before setting it required: false schema: type: boolean default: false schemas: DocumentResourceType: type: string description: Document resource type enum: - DOCUMENT - DOSSIER - DEEP_LINK ValidationErrorsResponse: type: object properties: errors: type: array description: List of errors items: $ref: '#/components/schemas/ValidationError' ValidationError: type: object properties: key: type: string description: Error Key error: type: string description: Error Message AddResponse: type: object properties: message: type: string description: Result message UpdateResponse: type: object properties: message: type: string description: Result message SetResponse: type: object properties: message: type: string description: Result message DeleteResponse: type: object properties: message: type: string description: Result message ErrorsResponse: type: object properties: errors: type: array description: List of errors items: $ref: '#/components/schemas/Error' Error: type: object properties: key: type: string description: Error Key error: type: string description: Error Message GetActivitesResponse: type: object properties: next: type: string description: Next page of results token activities: type: array description: List of Entity Type activities items: $ref: '#/components/schemas/Activity' GetUserActivitesResponse: type: object properties: next: type: string description: Next page of results token userActivities: type: array description: List of user activities items: $ref: '#/components/schemas/UserActivity' UserActivityType: type: string description: The type of the activity enum: - VIEW - DOWNLOAD - CREATE - UPDATE - DELETE - SOFT_DELETE - RESTORE - NEW_VERSION - UPDATE_VERSION - SSO_TOKEN_GRANT UserActivity: type: object properties: type: $ref: '#/components/schemas/UserActivityType' insertedDate: type: string description: Inserted Timestamp userId: type: string description: User who added document document: $ref: '#/components/schemas/Document' changes: type: object additionalProperties: $ref: '#/components/schemas/UserActivityChanges' UserActivityChanges: type: object properties: oldValue: type: object description: Previous key value newValue: type: object description: New key value ActivityStatus: type: string description: The status of the activity enum: - COMPLETE - FAILED - UNAUTHORIZED Activity: type: object properties: resource: type: string description: Resource of Activity type: type: string description: Type of Activity source: type: string description: The Source of the activity sourceIpAddress: type: string description: The Source IP address of the user message: type: string description: The activity message status: $ref: '#/components/schemas/ActivityStatus' insertedDate: type: string description: Inserted Timestamp userId: type: string description: User who added document delegation: $ref: '#/components/schemas/ActivityDelegation' documentId: description: Document Identifier artifactId: description: Document Artifact Identifier attributeKey: description: Document Attribute Key entityTypeId: type: string description: Entity Type Identifier entityId: type: string description: Entity Identifier apiKey: type: string description: API Key rulesetId: type: string description: Ruleset Identifier schema: type: string description: Schema Identifier mappingId: type: string description: Mapping Identifier classificationId: type: string description: Classification Identifier ruleId: type: string description: Ruleset Rule Identifier workflowId: type: string description: Workflow Identifier queueId: type: string description: Queue Identifier webhookId: type: string description: Webhook Identifier locale: type: string description: Locale Identifier controlPolicy: type: string description: Control Policy Type changes: type: object additionalProperties: $ref: '#/components/schemas/UserActivityChanges' ActivityDelegation: type: object properties: usedByUserId: type: string description: User who used the delegation token for the activity reason: type: string description: Reason supplied when the delegation token was generated GetAttributesResponse: type: object properties: next: type: string description: Next page of results token attributes: type: array description: List of attributes items: $ref: '#/components/schemas/Attribute' Attribute: type: object required: - key properties: type: $ref: '#/components/schemas/AttributeType' key: type: string description: Attribute Key dataType: $ref: '#/components/schemas/AttributeDataType' validationRegex: type: string description: Attribute Value Regex Validation watermark: $ref: '#/components/schemas/Watermark' Watermark: type: object properties: fontSize: type: number description: Watermark Font Size text: type: string description: Watermark text rotation: type: number description: Watermark Rotation imageDocumentId: type: string description: Watermark Image Document Id scale: $ref: '#/components/schemas/WatermarkScale' position: $ref: '#/components/schemas/WatermarkPosition' WatermarkPosition: type: object properties: xAnchor: $ref: '#/components/schemas/WatermarkPositionXAnchor' yAnchor: $ref: '#/components/schemas/WatermarkPositionYAnchor' xOffset: type: number description: X offset yOffset: type: number description: Y offset WatermarkScale: type: string description: Watermark Scale enum: - FIT_BEST - ORIGINAL WatermarkPositionXAnchor: type: string description: Watermark X Position Anchor enum: - LEFT - RIGHT - CENTER WatermarkPositionYAnchor: type: string description: Watermark Y Position Anchor enum: - TOP - BOTTOM - CENTER AttributeType: type: string description: Type of Attribute default: STANDARD enum: - STANDARD - OPA - GOVERNANCE AttributeDataType: type: string description: Data Type of Attribute default: STRING enum: - STRING - NUMBER - BOOLEAN - DATE - KEY_ONLY - PUBLICATION - WATERMARK - ENTITY AddAttributeRequest: required: - attribute type: object properties: attribute: $ref: '#/components/schemas/AddAttribute' AddAttribute: required: - key type: object properties: key: type: string description: Attribute Key dataType: $ref: '#/components/schemas/AttributeDataType' validationRegex: type: string description: Attribute Value Regex Validation type: $ref: '#/components/schemas/AttributeType' watermark: $ref: '#/components/schemas/Watermark' GetAttributeResponse: type: object properties: attribute: $ref: '#/components/schemas/Attribute' UpdateAttributeRequest: required: - attribute type: object properties: attribute: $ref: '#/components/schemas/UpdateAttribute' UpdateAttribute: type: object properties: type: $ref: '#/components/schemas/AttributeType' validationRegex: type: string description: Attribute Value Regex Validation watermark: $ref: '#/components/schemas/Watermark' GetAttributeAllowedValuesResponse: type: object properties: allowedValues: type: array description: Attribute's allowed values items: type: string localizedAllowedValues: type: object additionalProperties: type: string AddDocumentGenerateRequest: type: object properties: locale: $ref: '#/components/schemas/LocaleInfo' insertDocuments: type: array description: List of documents to insert items: $ref: '#/components/schemas/DocumentGenerateInsertDocument' datasources: type: array description: List of data sources items: $ref: '#/components/schemas/DocumentGenerateDataSource' outputType: $ref: '#/components/schemas/DocumentGenerateOutputType' saveAsDocumentId: type: string description: Save the generated document with a specific documentId saveAsArtifact: type: boolean default: false description: Create the output as a new artifact of saveAsDocumentId saveAsArtifactId: type: string description: Save the output as a new version of an existing artifact artifactCategory: type: string description: Optional caller-defined category for artifact output path: type: string description: The path of the generated document DocumentGenerateInsertDocumentPosition: type: string description: Position of document enum: - APPEND DocumentGenerateInsertDocument: type: object required: - documentId - position properties: position: $ref: '#/components/schemas/DocumentGenerateInsertDocumentPosition' documentId: type: string description: Document Identifier of the data source document artifactId: type: string description: Document Artifact Identifier of the data source document DocumentGenerateDataSource: type: object required: - documentId properties: name: type: string description: The data source name documentId: type: string description: Document Identifier of the data source document artifactId: type: string description: Document Artifact Identifier of the data source document dataRoot: type: string description: The default JSON object path for the data object default: data DocumentGenerateOutputType: type: string description: Document Generate Output Type enum: - DOCX - PDF AddDocumentGenerateResponse: type: object properties: documentId: type: string description: Generated document identifier artifactId: type: string description: Artifact Identifier AddDocumentResponse: type: object properties: documentId: type: string description: Document Identifier artifactId: type: string description: Artifact Identifier siteId: type: string description: Site Identifier uploadUrl: type: string description: Url to upload document to headers: type: object additionalProperties: type: object documents: type: array description: List of child documents items: $ref: '#/components/schemas/AddChildDocumentResponse' AddChildDocumentResponse: type: object properties: documentId: type: string description: Document Identifier uploadUrl: type: string description: Url to upload document to headers: type: object additionalProperties: type: object GetDocumentsResponse: type: object properties: next: type: string description: Next page of results token previous: type: string description: Previous page of results token documents: type: array description: List of documents items: $ref: '#/components/schemas/Document' Document: type: object properties: siteId: type: string description: Site Identifier path: type: string description: Path or Name of document width: type: string description: Document Content Width property height: type: string description: Document Content Height property deepLinkPath: type: string description: Path or Name of deep link resourceType: $ref: '#/components/schemas/DocumentResourceType' insertedDate: type: string description: Inserted Timestamp lastModifiedDate: type: string description: Last Modified Timestamp deletedDate: type: string description: Soft Deleted Timestamp checksum: type: string description: Document checksum, changes when document file changes checksumType: $ref: '#/components/schemas/ChecksumType' documentId: type: string description: Document Identifier artifactId: type: string description: Artifact Identifier promotedArtifactId: type: string description: Promoted Artifact Identifier artifactCategory: type: string description: Artifact Category hasArtifacts: type: boolean description: Whether the document has artifact documents contentType: type: string description: Document Content-Type userId: type: string description: User who added document contentLength: type: integer description: Document size version: type: string description: Document version versionKey: type: string description: Document Version Identifier s3version: type: string description: Document storage version belongsToDocumentId: type: string description: Parent Document Identifier metadata: type: array description: List of document Metadata items: $ref: '#/components/schemas/DocumentMetadata' ChecksumType: type: string description: The type of checksum to use for file validation enum: - SHA1 - SHA256 - SHA512 DocumentMetadata: type: object description: Document Metadata (use either 'value' or 'values' not both) properties: key: type: string description: Metadata key value: type: string description: Metadata value values: type: array description: Metadata values items: type: string description: Metadata value AddDocumentRequest: required: - content type: object properties: documentId: type: string description: optional Document Identifier (Version 4 UUID), if skipped one will be assigned artifacts: type: boolean description: Whether the document supports artifact documents artifactCategory: type: string description: Artifact Category path: type: string description: Path or Name of document checksumType: $ref: '#/components/schemas/ChecksumType' checksum: type: string description: The checksum value to validate the file against width: type: string description: Document Content Width property height: type: string description: Document Content Height property deepLinkPath: type: string description: Path or Name of deep link resourceType: $ref: '#/components/schemas/DocumentResourceType' contentType: type: string description: Document media type isBase64: type: boolean description: Is the content Base64-encoded? content: type: string description: Document content tags: type: array description: List of document tags items: $ref: '#/components/schemas/AddDocumentTag' metadata: type: array description: List of document Metadata items: $ref: '#/components/schemas/AddDocumentMetadata' actions: type: array description: List of Actions items: $ref: '#/components/schemas/AddAction' attributes: type: array description: List of Attributes to add to document items: $ref: '#/components/schemas/AddDocumentAttribute' documents: type: array description: List of child documents items: $ref: '#/components/schemas/AddChildDocument' AddChildDocument: required: - content type: object description: List of related documents properties: path: type: string description: Path or Name of document width: type: string description: Document Content Width property height: type: string description: Document Content Height property deepLinkPath: type: string description: Path or Name of deep link resourceType: $ref: '#/components/schemas/DocumentResourceType' contentType: type: string description: Document Content-Type checksumType: $ref: '#/components/schemas/ChecksumType' checksum: type: string description: The checksum value to validate the file against isBase64: type: boolean description: Is the content Base64-encoded? content: type: string description: Document content tags: type: array description: List of document tags items: $ref: '#/components/schemas/AddDocumentTag' metadata: type: array description: List of document Metadata items: $ref: '#/components/schemas/AddDocumentMetadata' attributes: type: array description: List of Attributes to add to document items: $ref: '#/components/schemas/AddDocumentAttribute' ReindexTarget: type: string description: Reindex object target enum: - ATTRIBUTES AddReindexDocumentRequest: type: object properties: target: $ref: '#/components/schemas/ReindexTarget' DocumentsCompressRequest: type: object anyOf: - required: - documentIds - required: - documents properties: documentIds: type: array description: Documents to compress items: type: string documents: type: array description: Documents to compress with optional artifact identifiers items: $ref: '#/components/schemas/DocumentsCompressDocument' DocumentsCompressDocument: type: object required: - documentId properties: documentId: type: string description: Document Identifier artifactId: type: string description: Artifact Identifier DocumentsCompressResponse: type: object properties: downloadUrl: type: string description: Archive download URL GetDocumentResponse: required: - documentId type: object properties: artifactId: type: string description: Artifact Identifier promotedArtifactId: type: string description: Promoted Artifact Identifier artifactCategory: type: string description: Artifact Category hasArtifacts: type: boolean description: Whether the document has artifact documents siteId: type: string description: Site Identifier path: type: string description: Path or Name of document width: type: string description: Document Content Width property height: type: string description: Document Content Height property deepLinkPath: type: string description: Path or Name of deep link resourceType: $ref: '#/components/schemas/DocumentResourceType' insertedDate: type: string description: Inserted Timestamp lastModifiedDate: type: string description: Last Modified Timestamp checksum: type: string description: Document checksum, changes when document file changes checksumType: $ref: '#/components/schemas/ChecksumType' documentId: type: string description: Document Identifier contentType: type: string description: Document Content-Type userId: type: string description: User who added document contentLength: type: integer description: Document size versionId: type: string description: Document version documents: type: array description: List of child documents items: $ref: '#/components/schemas/ChildDocument' belongsToDocumentId: type: string description: Parent Document Identifier metadata: type: array description: List of document Metadata items: $ref: '#/components/schemas/DocumentMetadata' ChildDocument: required: - documentId type: object properties: path: type: string description: Path or Name of document width: type: string description: Document Content Width property height: type: string description: Document Content Height property deepLinkPath: type: string description: Path or Name of deep link resourceType: $ref: '#/components/schemas/DocumentResourceType' insertedDate: type: string description: Inserted Timestamp lastModifiedDate: type: string description: Last Modified Timestamp checksum: type: string description: Document checksum, changes when document file changes documentId: type: string description: Document Identifier hasArtifacts: type: boolean description: Whether the document has artifact documents contentType: type: string description: Document Content-Type userId: type: string description: User who added document contentLength: type: integer description: Document size versionId: type: string description: Document version belongsToDocumentId: type: string description: Parent Document Identifier attributes: type: array description: List of document attributes items: $ref: '#/components/schemas/DocumentAttribute' UpdateDocumentRequest: type: object properties: artifactCategory: type: string description: Artifact Category path: type: string description: Path or Name of document width: type: string description: Document Content Width property height: type: string description: Document Content Height property deepLinkPath: type: string description: Path or Name of deep link contentType: type: string description: Document media type isBase64: type: boolean description: Is the content Base64-encoded? content: type: string description: Document content checksum: type: string description: Document checksum, changes when document file changes checksumType: $ref: '#/components/schemas/ChecksumType' tags: type: array description: List of document tags items: $ref: '#/components/schemas/AddDocumentTag' metadata: type: array description: List of document Metadata items: $ref: '#/components/schemas/AddDocumentMetadata' attributes: type: array description: List of document attributes items: $ref: '#/components/schemas/AddDocumentAttribute' actions: type: array description: List of Actions items: $ref: '#/components/schemas/AddAction' documents: type: array description: List of child documents items: $ref: '#/components/schemas/AddChildDocument' GetDocumentActionsResponse: type: object properties: next: type: string description: Next page of results token actions: type: array description: List of document actions items: $ref: '#/components/schemas/DocumentAction' DocumentActionStatus: type: string description: Status of the Document Action enum: - COMPLETE - ASYNC_COMPLETE - FAILED - IN_QUEUE - PENDING - RUNNING - SKIPPED - FAILED_RETRY - MAX_RETRIES_REACHED - WAITING_FOR_RETRY DocumentActionType: type: string description: Type of the Document Action enum: - ANTIVIRUS - DOCUMENTTAGGING - FULLTEXT - MOVE - DELETE - CHECKSUM - NOTIFICATION - OCR - QUEUE - WEBHOOK - IDP - PUBLISH - PDFEXPORT - EVENTBRIDGE - RESIZE - LLMPROMPT - DATA_CLASSIFICATION - MALWARE_SCAN DeleteType: type: string description: 'DELETE: Type of delete to perform' enum: - SOFT_DELETE - HARD_DELETE - PURGE DocumentAction: type: object properties: status: $ref: '#/components/schemas/DocumentActionStatus' type: $ref: '#/components/schemas/DocumentActionType' retryCount: type: number description: The number of times this action has already been attempted maxRetries: type: number description: The maximum number of retry attempts allowed for this action queueId: type: string description: Queue Id workflowId: type: string description: Workflow Id workflowStepId: type: string description: Workflow Step Id message: type: string description: Action message information userId: type: string description: User who requested the Action insertedDate: type: string description: Inserted Timestamp startDate: type: string description: Started Timestamp completedDate: type: string description: Completed Timestamp parameters: type: object description: Action parameters additionalProperties: type: object metadata: type: object description: Action metadata additionalProperties: type: string AddDocumentActionsRequest: type: object properties: actions: type: array description: List of Actions items: $ref: '#/components/schemas/AddAction' AddAction: type: object required: - type properties: type: $ref: '#/components/schemas/DocumentActionType' parameters: $ref: '#/components/schemas/AddActionParameters' queueId: description: Id of Queue type: string AddActionParameters: type: object properties: ocrTextractQueries: type: array items: $ref: '#/components/schemas/TextractQuery' ocrParseTypes: type: string description: 'OCR: Parse types - TEXT, FORMS, TABLES, QUERIES (must include ocrTextractQueries)' ocrEngine: $ref: '#/components/schemas/OcrEngine' ocrOutputType: $ref: '#/components/schemas/OcrOutputType' ocrNumberOfPages: type: string description: Number of pages to OCR (from start) (-1 all) addPdfDetectedCharactersAsText: type: string description: 'OCR: For the rewriting of the PDF document, converting any image text to searchable text' llmPromptEntityName: type: string description: 'LLMPROMPT, DATA_CLASSIFICATION, METADATA_EXTRACTION: Set the LLM Prompt Entity Name' modelId: type: string description: 'LLMPROMPT: Override the LLM Prompt Entity model id' url: type: string description: 'Webhook: Callback URL' characterMax: type: string description: 'Fulltext: Maximum number of characters (-1 unlimited, Typesense defaults to 2048 characters)' engine: type: string description: 'DocumentTagging: Engine to use for document tagging generation' enum: - chatgpt notificationType: type: string description: Notification Type enum: - email notificationToCc: description: Who to carbon copy on the notification to (comma-delimited list) type: string notificationToBcc: description: Who to blind carbon copy on the notification to (comma-delimited list) type: string notificationSubject: description: Subject of the notification type: string notificationText: description: Text of the notification type: string notificationHtml: description: Html of the notification type: string tags: description: 'DocumentTagging: Comma-deliminted list of keywords to generate tags for' type: string mappingId: description: Id of Mapping type: string eventBusName: type: string description: The name or ARN of the event bus to receive the event checksumType: $ref: '#/components/schemas/ChecksumType' width: type: string description: The width of the image to resize (or 'auto') height: type: string description: The height of the image to resize (or 'auto') path: type: string description: 'MOVE: Destination folder path, must end with ''/''; RESIZE: Path to use when creating resized document (optional)' deleteType: $ref: '#/components/schemas/DeleteType' outputType: type: string description: The output type of the image PromoteDocumentArtifactRequest: type: object properties: artifactId: type: string description: Artifact Document Identifier. Omit to clear the promoted artifact. AddDocumentAttributeValue: type: object description: Document Attribute Value properties: stringValue: type: string description: Attribute with string value stringValues: type: array description: Attribute with string values items: type: string numberValue: type: number description: Attribute with number value numberValues: type: array description: Attribute with number values items: type: number booleanValue: type: boolean description: Attribute with boolean value dateValue: type: string description: Attribute with date value dateValues: type: array description: Attribute with date values items: type: string SetDocumentAttributeRequest: type: object description: Set List of document attributes properties: attribute: $ref: '#/components/schemas/AddDocumentAttributeValue' SetDocumentAttributesRequest: type: object description: Set List of document attributes properties: attributes: type: array description: List of document attributes items: $ref: '#/components/schemas/AddDocumentAttribute' GetDocumentAttributesResponse: type: object properties: next: type: string description: Next page of results token attributes: type: array description: List of attributes items: $ref: '#/components/schemas/DocumentAttribute' GetDocumentAttributeResponse: type: object properties: attribute: $ref: '#/components/schemas/DocumentAttribute' GenerateDocumentAttributeValueResponse: type: object required: - attribute - sequence - period properties: attribute: $ref: '#/components/schemas/DocumentAttribute' sequence: type: integer format: int64 description: Allocated sequence number example: 1 period: type: string description: Sequence period used for the allocation example: "2026" DocumentAttribute: type: object properties: key: type: string description: Attribute key stringValue: type: string description: Attribute with string value stringValues: type: array description: Attribute with string values items: type: string numberValue: type: number description: Attribute with number value numberValues: type: array description: Attribute with number values items: type: number booleanValue: type: boolean description: Attribute with boolean value dateValue: type: string description: Attribute with date value dateValues: type: array description: Attribute with date values items: type: string insertedDate: type: string description: Inserted Timestamp userId: type: string description: User who added attribute valueType: $ref: '#/components/schemas/AttributeValueType' entity: $ref: '#/components/schemas/Entity' entities: type: array description: Attribute with entity values items: $ref: '#/components/schemas/Entity' AttributeValueType: type: string description: Attribute Value Type enum: - BOOLEAN - DATE - KEY_ONLY - NUMBER - STRING - PUBLICATION - CLASSIFICATION - COMPOSITE_STRING - RELATIONSHIPS - WATERMARK - ENTITY AddDocumentAttributesRequest: type: object description: Add List of document attributes properties: attributes: type: array description: List of document attributes items: $ref: '#/components/schemas/AddDocumentAttribute' AddDocumentAttribute: oneOf: - $ref: '#/components/schemas/AddDocumentAttributeStandard' - $ref: '#/components/schemas/AddDocumentAttributeClassification' - $ref: '#/components/schemas/AddDocumentAttributeRelationship' - $ref: '#/components/schemas/AddDocumentAttributeEntity' - $ref: '#/components/schemas/AddDocumentAttributeEntities' AddDocumentAttributeStandard: required: - key type: object description: Document Attribute properties: key: type: string description: Attribute key stringValue: type: string description: Attribute with string value stringValues: type: array description: Attribute with string values items: type: string numberValue: type: number description: Attribute with number value numberValues: type: array description: Attribute with number values items: type: number booleanValue: type: boolean description: Attribute with boolean value dateValue: type: string description: Attribute with date value dateValues: type: array description: Attribute with date values items: type: string AddDocumentAttributeClassification: required: - classificationId type: object description: Document Classification properties: classificationId: type: string description: Classification Identifier AddDocumentAttributeRelationship: required: - documentId - relationship type: object description: Document Relationship properties: documentId: type: string description: Relationship To Document Identifier relationship: $ref: '#/components/schemas/DocumentRelationshipType' inverseRelationship: $ref: '#/components/schemas/DocumentRelationshipType' AddDocumentAttributeEntity: required: - key - entityTypeId - entityId type: object description: Document Entity Attribute properties: key: type: string description: Attribute key entityTypeId: type: string description: EntityType Identifier or Entity Type Name entityId: type: string description: Entity Identifier namespace: $ref: '#/components/schemas/EntityTypeNamespace' AddDocumentAttributeEntities: required: - key - entities type: object description: Document Entity Attribute with multiple values properties: key: type: string description: Attribute key entities: type: array description: Attribute with entity values items: $ref: '#/components/schemas/AddDocumentAttributeEntityValue' AddDocumentAttributeEntityValue: required: - entityTypeId - entityId type: object description: Document Entity Attribute Value properties: entityTypeId: type: string description: EntityType Identifier or Entity Type Name entityId: type: string description: Entity Identifier namespace: $ref: '#/components/schemas/EntityTypeNamespace' DocumentRelationshipType: type: string description: Document Relationship Type enum: - PRIMARY - ATTACHMENT - APPENDIX - SUPPLEMENT - ASSOCIATED - RENDITION AddDocumentCertificationRequest: type: object required: - target - certificates properties: target: $ref: '#/components/schemas/DocumentCertificationTarget' certificates: type: array minItems: 1 description: One or more certificates used to certify/sign the document (in order). items: $ref: '#/components/schemas/DocumentCertification' DocumentCertificationTarget: type: string description: Type of supported certificate targets enum: - DOWNLOAD DocumentCertification: type: object required: - alias - type properties: alias: type: string description: Certificate alias. sourceType: $ref: '#/components/schemas/DocumentCertificationType' awsSecretsManager: $ref: '#/components/schemas/DocumentCertificationAwsSecretsManager' DocumentCertificationType: type: string description: Type of supported certificate datastores enum: - AWS_SECRETS_MANAGER DocumentCertificationAwsSecretsManager: type: object required: - certificateArn - passwordArn properties: certificateArn: type: string description: Aws Secrets Manager Certificate ARN passwordArn: type: string description: Aws Secrets Manager Password ARN AddDocumentCertificationResponse: type: object properties: documentId: type: string description: Document identifier (NEW_VERSION / NEW_DOCUMENT). url: type: string description: Presigned download URL (DOWNLOAD). GetDocumentContentResponse: type: object properties: content: type: string description: Document content contentUrl: type: string description: URL to retrieve document content contentType: type: string description: Document Content-Type isBase64: type: boolean description: Is the content Base64-encoded? SetDocumentDataClassificationRequest: type: object required: - llmPromptEntityName properties: llmPromptEntityName: type: string description: Name of the LLM Prompt Entity SetDocumentDataClassificationResponse: type: object properties: content: type: string description: Result content attributes: description: Attributes extracted from result content type: array items: $ref: '#/components/schemas/DataClassificationAttribute' GetDocumentDataClassificationResponse: type: object properties: next: type: string description: Next page of results token dataClassifications: type: array description: List of Data Classifications items: $ref: '#/components/schemas/DataClassification' DataClassification: type: object properties: llmPromptEntityName: type: string description: Name of the LLM Prompt Entity insertedDate: type: string description: Inserted Timestamp content: type: string description: Result content userId: type: string description: UserId that created Result attributes: description: Attributes extracted from result content type: array items: $ref: '#/components/schemas/DataClassificationAttribute' DataClassificationAttribute: type: object properties: key: type: string description: Data Classification Attribute Key value: type: string description: Data Classification Attribute Value MetadataExtractionAttribute: type: object properties: key: type: string description: Data Classification Attribute Key value: type: string description: Data Classification Attribute Value MetadataExtraction: type: object properties: llmPromptEntityName: type: string description: Name of the LLM Prompt Entity insertedDate: type: string description: Inserted Timestamp content: type: string description: Result content userId: type: string description: UserId that created Result attributes: description: Attributes extracted from result content type: array items: $ref: '#/components/schemas/MetadataExtractionAttribute' GetDocumentMetadataExtractionResponse: type: object properties: next: type: string description: Next page of results token metadataExtractions: type: array description: List of Metadata Extractions items: $ref: '#/components/schemas/MetadataExtraction' AddDocumentMetadataExtractionResponse: type: object properties: content: type: string description: Result content attributes: description: Attributes extracted from result content type: array items: $ref: '#/components/schemas/DataClassificationAttribute' AddDocumentAiPromptRequest: type: object properties: modelId: type: string description: Override the LLM Prompt Entity model id AddDocumentAiResponse: type: object properties: systemPrompt: type: string description: System Prompt aiPromptResult: $ref: '#/components/schemas/DocumentAiPromptResult' GetDocumentAiPromptResultsResponse: type: object properties: next: type: string description: Next page of results token aiPromptResults: type: array description: List of document AI prompt result records items: $ref: '#/components/schemas/DocumentAiPromptResult' GetDocumentAiPromptsResultsResponse: type: object properties: next: type: string description: Next page of results token aiPromptResults: type: array description: List of document AI prompt result records items: $ref: '#/components/schemas/DocumentAiPromptNamedResult' DocumentAiPromptNamedResult: type: object required: - llmPromptEntityName properties: llmPromptEntityName: type: string description: Name of the LLM Prompt Entity analysisCategory: type: string description: Analysis Category insertedDate: type: string description: Inserted Timestamp content: type: string description: Result content userId: type: string description: UserId that created Result values: type: array description: Document AI prompt values items: $ref: '#/components/schemas/DocumentAiPromptValue' DocumentAiPromptResult: type: object properties: analysisCategory: type: string description: Analysis Category insertedDate: type: string description: Inserted Timestamp content: type: string description: Result content userId: type: string description: UserId that created Result values: type: array description: Document AI prompt values items: $ref: '#/components/schemas/DocumentAiPromptValue' DocumentAiPromptValue: type: object required: - resultType - attributes properties: resultType: $ref: '#/components/schemas/DocumentAiPromptResultType' entityType: type: string description: Entity type when resultType is ENTITY entityNamespace: $ref: '#/components/schemas/EntityTypeNamespace' attributes: type: array description: Attributes extracted from result content items: $ref: '#/components/schemas/DocumentAiPromptResultAttribute' DocumentAiPromptResultAttribute: type: object required: - key - stringValues properties: key: type: string description: Document AI prompt result attribute key stringValues: type: array description: Document AI prompt result attribute string values items: type: string DocumentAiPromptResultType: type: string description: Document AI prompt result type enum: - KEY_VALUE - ENTITY UpdateDocumentFulltextResponse: type: object properties: message: type: string description: Full text processing message SetDocumentFulltextResponse: type: object properties: message: type: string description: Full text processing message GetDocumentFulltextResponse: type: object properties: siteId: type: string description: Site Identifier content: type: string description: Content of document contentType: type: string description: Document Content-Type path: type: string description: Path or Name of document width: type: string description: Document Content Width property height: type: string description: Document Content Height property deepLinkPath: type: string description: Path or Name of deep link resourceType: $ref: '#/components/schemas/DocumentResourceType' insertedDate: type: string description: Inserted Timestamp lastModifiedDate: type: string description: Last Modified Timestamp documentId: type: string description: Document Identifier createdBy: type: string description: User who added document contentLength: type: integer description: Document size checksum: type: string description: Document checksum, changes when document file changes checksumType: $ref: '#/components/schemas/ChecksumType' tags: type: object additionalProperties: type: object metadata: type: object additionalProperties: type: object attributes: type: object additionalProperties: $ref: '#/components/schemas/FulltextAttribute' DeleteFulltextResponse: type: object properties: message: type: string description: Result message SetDocumentFulltextRequest: type: object properties: contentType: type: string description: Document Content-Type content: type: string description: Document content contentUrls: type: array items: type: string description: URL(s) which contain document content path: type: string description: Path or Name of document width: type: string description: Document Content Width property height: type: string description: Document Content Height property deepLinkPath: type: string description: Path or Name of deep link resourceType: $ref: '#/components/schemas/DocumentResourceType' checksum: type: string description: Document checksum, changes when document file changes checksumType: $ref: '#/components/schemas/ChecksumType' tags: type: array description: List of document tags items: $ref: '#/components/schemas/AddDocumentTag' metadata: type: array description: List of document Metadata items: $ref: '#/components/schemas/AddDocumentMetadata' attributes: type: object additionalProperties: $ref: '#/components/schemas/FulltextAttribute' AddDocumentFulltextRequest: type: object properties: contentType: type: string description: Document Content-Type content: type: string description: Document content contentUrls: type: array items: type: string description: URL(s) which contain document content path: type: string description: Path or Name of document width: type: string description: Document Content Width property height: type: string description: Document Content Height property deepLinkPath: type: string description: Path or Name of deep link resourceType: $ref: '#/components/schemas/DocumentResourceType' checksum: type: string description: Document checksum, changes when document file changes checksumType: $ref: '#/components/schemas/ChecksumType' tags: type: array description: List of document tags items: $ref: '#/components/schemas/AddDocumentTag' metadata: type: array description: List of document Metadata items: $ref: '#/components/schemas/AddDocumentMetadata' attributes: type: object additionalProperties: $ref: '#/components/schemas/FulltextAttribute' AddDocumentFulltextResponse: type: object properties: message: type: string description: Full text processing message UpdateDocumentFulltextRequest: type: object properties: contentType: type: string description: Document Content-Type content: type: string description: Document content contentUrls: type: array items: type: string description: URL(s) which contain document content path: type: string description: Path or Name of document width: type: string description: Document Content Width property height: type: string description: Document Content Height property deepLinkPath: type: string description: Path or Name of deep link resourceType: $ref: '#/components/schemas/DocumentResourceType' checksum: type: string description: Document checksum, changes when document file changes checksumType: $ref: '#/components/schemas/ChecksumType' tags: type: array description: List of document tags items: $ref: '#/components/schemas/AddDocumentTag' metadata: type: array description: List of document Metadata items: $ref: '#/components/schemas/AddDocumentMetadata' attributes: type: object additionalProperties: $ref: '#/components/schemas/FulltextAttribute' AddDocumentMetadata: required: - key type: object description: Document Metadata (use either 'value' or 'values' not both) properties: key: type: string description: Metadata key value: type: string description: Metadata value values: type: array description: Metadata values items: type: string description: Metadata value SetAntivirusRequest: type: object SetMalwareScanRequest: type: object GetMalwareScanResponse: type: object properties: next: type: string description: Next page of results token malwareScanResults: type: array description: List of Malware Scan Results items: $ref: '#/components/schemas/MalwareScanResult' MalwareScanResult: type: object properties: scanStatus: $ref: '#/components/schemas/MalwareScanStatus' scanEngine: $ref: '#/components/schemas/MalwareEngine' s3version: type: string description: Document storage version scanMessage: type: string description: Document Malware scan message scannedDate: type: string description: Scanned Timestamp MalwareEngine: type: string description: Type of Malware Engine used enum: - CLAM_AV MalwareScanStatus: type: string description: Document Malware scan result enum: - MALICIOUS - ERROR - CLEAN GetDocumentNotificationsResponse: type: object properties: next: type: string description: Next page of results token notifications: type: array description: List of document notifications items: $ref: '#/components/schemas/DocumentNotification' AddDocumentNotificationRequest: type: object description: At least one CC or BCC recipient is required required: - notificationType - subject - body properties: notificationType: $ref: '#/components/schemas/DocumentNotificationType' cc: type: array description: CC recipient email addresses minItems: 1 uniqueItems: true items: type: string format: email bcc: type: array description: BCC recipient email addresses minItems: 1 uniqueItems: true items: type: string format: email subject: type: string minLength: 1 description: Notification subject body: type: string minLength: 1 description: Notification body AddDocumentNotificationResponse: type: object required: - message properties: message: type: string description: Notification queueing result DocumentNotification: type: object properties: entityTypeId: type: string description: Reminder Policy entity type identifier entityId: type: string description: Reminder Policy entity identifier cc: type: array description: Normalized CC recipient email addresses items: type: string bcc: type: array description: Normalized BCC recipient email addresses items: type: string notificationType: $ref: '#/components/schemas/DocumentNotificationType' notificationDate: type: string description: Scheduled notification occurrence date status: $ref: '#/components/schemas/DocumentNotificationStatus' action: $ref: '#/components/schemas/DocumentAction' insertedDate: type: string description: Inserted timestamp DocumentNotificationType: type: string description: Type of document notification enum: - EMAIL - IN_APP DocumentNotificationStatus: type: string description: Status of the document notification. WAITING awaits an external trigger and is not eligible for processing. PENDING is ready for processing. ACTION_CREATED indicates that a Document Action has been created. enum: - WAITING - PENDING - ACTION_CREATED OcrTableData: type: object properties: value: type: string description: Table Value OcrTable: type: object properties: headers: type: array items: type: string data: type: array items: type: array items: $ref: '#/components/schemas/OcrTableData' OcrKeyValues: type: object properties: key: type: string description: Ocr Key values: type: array items: type: string GetDocumentOcrResponse: type: object properties: contentUrls: type: array description: Presigned S3 Urls for the OCR content items: type: string keyValues: type: array description: List of ocr key / values items: $ref: '#/components/schemas/OcrKeyValues' tables: type: array items: $ref: '#/components/schemas/OcrTable' data: type: string description: OCR text result ocrEngine: type: string description: The OCR technique used ocrStatus: type: string description: The status of the OCR request contentType: type: string description: Document Content-Type isBase64: type: boolean description: Is the content Base64-encoded? userId: type: string description: User who requested the OCR documentId: type: string description: Document Identifier insertedDate: type: string description: Inserted Timestamp AddDocumentOcrResponse: type: object properties: message: type: string description: OCR processing message AddDocumentOcrRequest: type: object example: parseTypes: - TEXT - FORMS - TABLES - QUERIES properties: textractQueries: type: array items: $ref: '#/components/schemas/TextractQuery' parseTypes: type: array description: OCR Parse types - TEXT, FORMS, TABLES, QUERIES items: type: string addPdfDetectedCharactersAsText: type: boolean description: Rewrite PDF document, converting any Image text to searchable text ocrEngine: $ref: '#/components/schemas/OcrEngine' ocrNumberOfPages: type: string description: Number of pages to OCR (from start) (-1 all) ocrOutputType: $ref: '#/components/schemas/OcrOutputType' TextractQuery: type: object description: A question to ask Textract properties: text: type: string description: Natural-language question alias: type: string description: Label to identify this query in the result pages: type: array items: type: string description: Page selection OcrEngine: type: string description: Type of OCR Engine to use enum: - TESSERACT - TEXTRACT OcrOutputType: type: string description: OCR Engine output format (textract table only) enum: - CSV SetDocumentOcrRequest: required: - content type: object properties: contentType: type: string description: Document Content-Type isBase64: type: boolean description: Is the content Base64-encoded? content: type: string description: Document content SetDocumentRestoreResponse: type: object properties: message: type: string description: Document Document restore message DocumentReviewStatus: type: string description: |- Status of Document Review: - PENDING: Review has been created and is waiting for one or more decisions. - IN_PROGRESS: Review has been claimed or at least one decision has been submitted, but completion requirements are not yet satisfied. - COMPLETED: Completion requirements are satisfied. - CANCELLED: Review was cancelled before completion. - SUPERSEDED: Review was replaced by another review, usually because the artifact/document changed. enum: - PENDING - IN_PROGRESS - COMPLETED - CANCELLED - SUPERSEDED ReviewDecisionType: type: string enum: - APPROVAL - RECOMMENDATION - ACKNOWLEDGMENT - COMMENT AddDocumentReviewRequest: type: object properties: review: $ref: '#/components/schemas/AddDocumentReview' AddDocumentReviewResponse: type: object required: - reviewId properties: reviewId: type: string description: Review Identifier AddDocumentReview: type: object required: - reviewCategory - requiredDecisions properties: reviewCategory: type: string description: Review category reviewStatus: $ref: '#/components/schemas/DocumentReviewStatus' approvalGroups: type: array description: Optional approval groups used for additional credential verification when submitting a decision to POST /documents/{documentId}/reviews/{reviewId}/decisions. The caller must belong to at least one of the listed groups, in addition to satisfying the existing authorization requirements. items: type: string requiredDecisions: type: integer format: int64 minimum: 1 description: Number of decisions required to complete the review notifications: type: array description: Optional notifications to queue for delivery when the review is created. An empty list sends no notifications. items: $ref: '#/components/schemas/AddDocumentNotificationRequest' comments: type: string description: Review comments UpdateDocumentReviewRequest: type: object properties: review: $ref: '#/components/schemas/UpdateDocumentReview' UpdateDocumentReview: type: object properties: reviewStatus: $ref: '#/components/schemas/DocumentReviewStatus' requiredDecisions: type: integer format: int64 minimum: 1 description: Number of decisions required to complete the review comments: type: string description: Review comments GetDocumentReviewsResponse: type: object properties: next: type: string description: Next page of results token reviews: type: array description: List of document reviews items: $ref: '#/components/schemas/DocumentReview' GetDocumentReviewResponse: type: object properties: review: $ref: '#/components/schemas/DocumentReview' DocumentReview: type: object properties: documentId: type: string description: Document Identifier artifactId: type: string description: Artifact Identifier reviewId: type: string description: Review Identifier reviewCategory: type: string description: Review category reviewStatus: $ref: '#/components/schemas/DocumentReviewStatus' approvalGroups: type: array description: Optional approval groups used for additional credential verification when submitting a decision to POST /documents/{documentId}/reviews/{reviewId}/decisions. The caller must belong to at least one of the listed groups, in addition to satisfying the existing authorization requirements. items: type: string requiredDecisions: type: integer format: int64 description: Number of decisions required to complete the review userId: type: string description: User who added review comments: type: string description: Review comments insertedDate: type: string description: Inserted Timestamp lastModifiedDate: type: string description: Last Modified Timestamp AddDocumentReviewDecisionRequest: type: object required: - decision properties: decision: $ref: '#/components/schemas/AddDocumentReviewDecision' review: $ref: '#/components/schemas/AddDocumentReview' AddDocumentReviewDecisionResponse: type: object required: - decisionId properties: decisionId: type: string description: Decision Identifier AddDocumentReviewDecision: type: object required: - type properties: type: $ref: '#/components/schemas/ReviewDecisionType' decision: type: string description: Review decision comment: type: string description: Review decision comment GetDocumentReviewDecisionsResponse: type: object properties: next: type: string description: Next page of results token decisions: type: array description: List of document review decisions items: $ref: '#/components/schemas/DocumentReviewDecision' DocumentReviewDecision: type: object properties: documentId: type: string description: Document Identifier artifactId: type: string description: Artifact Identifier reviewId: type: string description: Review Identifier decisionId: type: string description: Decision Identifier type: $ref: '#/components/schemas/ReviewDecisionType' decision: type: string description: Review decision comment: type: string description: Review decision comment userId: type: string description: User who added decision insertedDate: type: string description: Inserted Timestamp AddDocumentSyncService: type: string description: Add Document Sync Service enum: - FULLTEXT DocumentSyncService: type: string description: Service of Document Sync enum: - TYPESENSE - OPENSEARCH DocumentSyncStatus: type: string description: Status of Document Sync enum: - COMPLETE - FAILED - FAILED_RETRY - PENDING DocumentSyncType: type: string description: Type of Document Sync enum: - METADATA - CONTENT - SOFT_DELETE - DELETE GetDocumentSyncResponse: type: object properties: next: type: string description: Next page of results token syncs: type: array description: List of document syncs items: $ref: '#/components/schemas/DocumentSync' AddDocumentSyncRequest: type: object properties: sync: $ref: '#/components/schemas/AddDocumentSync' AddDocumentSync: type: object properties: service: $ref: '#/components/schemas/AddDocumentSyncService' type: $ref: '#/components/schemas/DocumentSyncType' DocumentSync: type: object properties: service: $ref: '#/components/schemas/DocumentSyncService' status: $ref: '#/components/schemas/DocumentSyncStatus' type: $ref: '#/components/schemas/DocumentSyncType' insertedDate: type: string description: Inserted Timestamp syncDate: type: string description: Timestamp of synchronization userId: type: string description: User who added document message: type: string description: Document sync message GetDocumentTagsResponse: type: object properties: next: type: string description: Next page of results token previous: type: string description: Previous page of results token tags: type: array description: List of tags items: $ref: '#/components/schemas/DocumentTag' DocumentTag: type: object properties: insertedDate: type: string description: Inserted Timestamp documentId: type: string description: Document Identifier type: type: string description: Tag type userId: type: string description: User who added document value: type: string description: Tag value values: type: array description: Tag values items: type: string description: Tag value key: type: string description: Tag key AddDocumentTagsRequest: type: object description: Add List of document tags properties: tags: type: array description: List of document tags items: $ref: '#/components/schemas/AddDocumentTag' AddDocumentTag: required: - key type: object description: List of Document Tags (use either 'value' or 'values' not both) properties: key: type: string description: Tag key value: type: string description: Tag value values: type: array description: Tag values items: type: string description: Tag value GetDocumentTagResponse: type: object properties: insertedDate: type: string description: Inserted Timestamp documentId: type: string description: Document Identifier type: type: string description: Tag type userId: type: string description: User who added document value: type: string description: Tag value values: type: array description: Tag values items: type: string description: Tag value key: type: string description: Tag key SetDocumentTagKeyRequest: type: object properties: value: type: string description: Tag value values: type: array description: Tag values items: type: string UpdateMatchingDocumentTagsResponse: type: object properties: message: type: string description: response message UpdateMatchingDocumentTagsRequest: type: object description: Add/Update of multiple document tag(s) based on document(s) that have the matching tag. required: - match - update properties: match: type: object properties: tag: $ref: '#/components/schemas/MatchDocumentTag' update: type: object description: Data to update properties: tags: type: array description: List of document tags items: $ref: '#/components/schemas/AddDocumentTag' MatchDocumentTag: type: object description: Match Document Tag required: - key properties: key: type: string description: Tag key beginsWith: type: string description: Searches for strings that begin with eq: type: string description: Searches for strings that eq AddDocumentUploadRequest: type: object properties: documentId: type: string description: optional Document Identifier, if skipped one will be assigned artifacts: type: boolean description: Whether the document supports artifact documents path: type: string description: Path or Name of document contentType: type: string description: Document media type width: type: string description: Document Content Width property height: type: string description: Document Content Height property deepLinkPath: type: string description: Path or Name of deep link checksumType: $ref: '#/components/schemas/ChecksumType' checksum: type: string description: The checksum value to validate the file against attributes: type: array description: List of Attributes to add to document items: $ref: '#/components/schemas/AddDocumentAttribute' tags: type: array description: List of document tags items: $ref: '#/components/schemas/AddDocumentTag' actions: type: array description: List of Actions items: $ref: '#/components/schemas/AddAction' GetDocumentUrlResponse: type: object properties: documentId: type: string description: Document Identifier artifactId: type: string description: Artifact Identifier url: type: string description: Document content url headers: type: object additionalProperties: type: object GetDocumentVersionsResponse: type: object properties: next: type: string description: Next page of results token documents: type: array description: List of document versions items: $ref: '#/components/schemas/DocumentVersion' DocumentVersion: type: object properties: insertedDate: type: string description: Inserted Timestamp checksum: type: string description: Document checksum, changes when document file changes checksumType: $ref: '#/components/schemas/ChecksumType' contentType: type: string description: Document Content-Type userId: type: string description: User who added document contentLength: type: integer description: Document size versionKey: type: string description: Document Version Identifier s3version: type: string description: Document storage version SetDocumentVersionRequest: type: object properties: versionKey: type: string description: VersionKey returned by the GET /documents/{documentId}/versions to revert to SetDocumentVersionResponse: type: object properties: message: type: string description: Response Message GetDocumentWorkflowsResponse: type: object properties: workflows: type: array description: List of Document Workflows items: $ref: '#/components/schemas/DocumentWorkflow' next: type: string DocumentWorkflow: type: object properties: workflowId: type: string description: Workflow identifier name: type: string description: Workflow name description: type: string description: Workflow description currentStepId: type: string description: The current step workflow is on actionCount: type: integer description: Number of actions added for the current workflow step completedActionCount: type: integer description: Number of completed actions for the current workflow step status: $ref: '#/components/schemas/DocumentWorkflowStatus' insertedDate: type: string description: Inserted Timestamp DocumentWorkflowStatus: type: string description: Status of the Workflow Document enum: - COMPLETE - IN_PROGRESS - FAILED AddDocumentWorkflowRequest: type: object required: - workflowId properties: workflowId: type: string description: Workflow Identifier AddDocumentWorkflowResponse: type: object properties: message: type: string description: Result message GetDocumentWorkflowResponse: type: object properties: workflow: $ref: '#/components/schemas/DocumentWorkflow' AddDocumentWorkflowDecisionsRequest: type: object properties: comments: type: string description: Workflow decision comments decision: $ref: '#/components/schemas/WorkflowDecision' WorkflowDecision: type: string description: Workflow Decisions enum: - APPROVE - REJECT AddDocumentWorkflowDecisionsResponse: type: object properties: message: type: string description: Result message AddEntityResponse: type: object properties: entityId: type: string description: Entity Identifier AddEntityTypeResponse: type: object properties: entityTypeId: type: string description: Entity Type Identifier GetEntitiesResponse: type: object properties: next: type: string description: Next page of results token entities: type: array description: List of Entities items: $ref: '#/components/schemas/Entity' GetEntityResponse: type: object properties: entity: $ref: '#/components/schemas/Entity' GetEntityTypeResponse: type: object properties: entityType: $ref: '#/components/schemas/EntityType' Entity: type: object properties: entityId: type: string description: Entity identifier entityTypeId: type: string description: Entity Type identifier name: type: string description: Entity Name insertedDate: type: string description: Inserted Timestamp attributes: type: array description: List of Entity Attributes items: $ref: '#/components/schemas/EntityAttribute' AddEntityRequest: type: object properties: entity: $ref: '#/components/schemas/AddEntity' SetEntityRequest: type: object properties: entity: $ref: '#/components/schemas/AddEntity' UpdateEntityRequest: type: object properties: entity: $ref: '#/components/schemas/AddEntity' AddEntity: type: object properties: name: type: string description: Entity Name attributes: type: array description: List of Entity Attributes items: $ref: '#/components/schemas/AddEntityAttribute' AddEntityAttribute: type: object properties: key: type: string description: Attribute key stringValue: type: string description: Attribute with string value stringValues: type: array description: Attribute with string values items: type: string numberValue: type: number description: Attribute with number value numberValues: type: array description: Attribute with number values items: type: number booleanValue: type: boolean description: Attribute with boolean value EntityAttribute: type: object properties: key: type: string description: Attribute key stringValue: type: string description: Attribute with string value stringValues: type: array description: Attribute with string values items: type: string numberValue: type: number description: Attribute with number value numberValues: type: array description: Attribute with number values items: type: number booleanValue: type: boolean description: Attribute with boolean value dateValue: type: string description: Attribute with date value dateValues: type: array description: Attribute with date values items: type: string valueType: $ref: '#/components/schemas/AttributeValueType' GetEntityTypesResponse: type: object properties: next: type: string description: Next page of results token entityTypes: type: array description: List of Entity Types items: $ref: '#/components/schemas/EntityType' EntityType: type: object properties: entityTypeId: type: string description: Entity Type identifier namespace: $ref: '#/components/schemas/EntityTypeNamespace' name: type: string description: Entity Type Name insertedDate: type: string description: Inserted Timestamp AddEntityTypeRequest: type: object properties: entityType: $ref: '#/components/schemas/AddEntityType' SetEntityTypeRequest: type: object properties: entityType: $ref: '#/components/schemas/AddEntityType' AddEntityType: type: object properties: namespace: $ref: '#/components/schemas/EntityTypeNamespace' name: type: string description: Entity Type Name EntityTypeNamespace: type: string description: Entity Type namespace enum: - PRESET - CUSTOM DocusignEnvironment: type: string description: Docusign environment. When omitted from an E-Signature request, defaults to docusignEnvironment in the site configuration. enum: - PRODUCTION - DEVELOPMENT DocusignEnvelopeStatus: type: string description: |- Controls how the envelope is created: * `created` saves the envelope as a draft without notifying recipients. * `sent` immediately sends the envelope to recipients. enum: - created - sent default: sent DocusignRecipientView: type: object properties: returnUrl: type: string description: Identifies the return point after sending the envelope recipientId: type: string description: A reference used to map recipients to other objects, such as specific document tabs. userName: type: string description: The username of the recipient. You can use either email and userName. clientUserId: type: string description: Specifies unique identifier for signer email: type: string description: Specifies the email of the recipient frameAncestors: type: array description: An array of ancestors that can embed the frame. Include the domain where the envelope will be embedded and the same URL as messageOrigins. items: type: string messageOrigins: type: array description: The originating domain for the signature request message items: type: string AddDocusignEnvelopesRequest: type: object properties: emailSubject: type: string description: The subject line of the email message that is sent to all recipients environment: $ref: '#/components/schemas/DocusignEnvironment' status: $ref: '#/components/schemas/DocusignEnvelopeStatus' signers: type: array description: List of DocuSign Signers items: $ref: '#/components/schemas/DocusignSigner' inpersonSigners: type: array description: List of DocuSign Inperson Signers items: $ref: '#/components/schemas/DocusignInpersonSigner' notification: $ref: '#/components/schemas/DocusignNotification' DocusignNotification: properties: useAccountDefaults: type: string description: When true, the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When false, the reminders and expirations settings specified in this request are used. The default value is false. expirations: $ref: '#/components/schemas/DocusignNotificationExpirations' reminders: $ref: '#/components/schemas/DocusignNotificationReminders' DocusignNotificationExpirations: properties: expireAfter: type: string description: An integer that sets the number of days the envelope is active. For this value to be used, expireEnabled must be explicitly set to true. expireEnabled: type: string description: When true, the envelope expires in the number of days set by expireAfter. expireWarn: type: string description: An integer that specifying the number of days before the envelope expires that an expiration warning email is sent to the recipient. DocusignNotificationReminders: properties: reminderDelay: type: string description: An integer specifying the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. reminderEnabled: type: string description: When true, reminders are enabled. The default value is false. reminderFrequency: type: string description: An integer specifying the interval in days between reminder emails. DocusignSigner: required: - name type: object properties: name: type: string description: Name of Signer email: type: string description: Email of Signer clientUserId: type: string description: Specifies unique identifier for signer embeddedRecipientStartUrl: type: string enum: - SIGN_AT_DOCUSIGN description: Enables a Docusign signing invitation while retaining embedded signing through clientUserId. Requires clientUserId. When omitted, the existing signing behavior is unchanged. Hybrid recipients do not receive automated reminders or expiration notifications. recipientId: type: string description: A reference used to map recipients to other objects, such as specific document tabs. routingOrder: type: string description: Specifies the routing order of the recipient in the envelope. suppressEmails: type: string description: When true, email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. readyToSignNotification: $ref: '#/components/schemas/DocusignSignerReadyToSignNotification' tabs: $ref: '#/components/schemas/DocusignSigningTabs' DocusignSignerReadyToSignNotification: type: object description: Configuration for a FormKiQ-managed notification stored with status WAITING when the envelope is created. The Docusign recipient-completed callback for the immediately preceding signer in routing order releases it to PENDING. The callback updates the existing document notification without creating a separate user notification record. The notification is addressed to this signer's email address and does not require suppressEmails to be enabled. Requires a configured connectUrl, unique recipient IDs and unique positive integer routing orders for all signers, and at least one preceding signer. Only sequential signing is supported when readyToSignNotification is configured; parallel routing orders are rejected. required: - notificationType - subject - body properties: notificationType: $ref: '#/components/schemas/DocumentNotificationType' subject: type: string minLength: 1 description: Notification subject body: type: string minLength: 1 description: Notification body DocusignSigningTabs: type: object properties: signHereTabs: type: array description: A list of Sign Here tabs items: $ref: '#/components/schemas/DocusignSignHereTabs' DocusignSignHereTabs: type: object properties: anchorString: type: string description: Specifies the string to find in the document and use as the basis for tab placement. anchorXOffset: type: string description: Specifies the X axis location of the tab in anchorUnits relative to the anchorString. anchorYOffset: type: string description: Specifies the Y axis location of the tab in anchorUnits relative to the anchorString. anchorIgnoreIfNotPresent: type: string description: When true, this tab is ignored if the anchorString is not found in the document. anchorUnits: type: string description: Specifies units of the anchorXOffset and anchorYOffset xPosition: type: string description: This property indicates the horizontal offset of the object on the page yPosition: type: string description: This property indicates the vertical offset of the object on the page pageNumber: type: string description: Specifies the page number on which the tab is located DocusignInpersonSigner: required: - hostEmail - hostName - signerName type: object properties: hostEmail: type: string description: The email of the signing host hostName: type: string description: The name of the signing host signerName: type: string description: The full legal name of a signer signerEmail: type: string description: The in-person signer's email address recipientId: type: string description: A reference used to map recipients to other objects, such as specific document tabs. routingOrder: type: string description: Specifies the routing order of the recipient in the envelope. suppressEmails: type: string description: When true, email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. tabs: $ref: '#/components/schemas/DocusignSigningTabs' GetDocusignEnvelopeResponse: type: object additionalProperties: true description: The DocuSign Get Envelope response with include=recipients, returned without enrichment. Additional DocuSign fields are preserved. Optional fields are returned only when supplied by DocuSign. A completed envelope does not confirm that FormKiQ has stored the signed PDF. properties: envelopeId: type: string description: DocuSign envelope identifier status: type: string description: Envelope status reported by DocuSign, such as created, sent, delivered, signed, completed, declined, or voided. statusChangedDateTime: type: string format: date-time description: Time DocuSign reports the envelope status changed sentDateTime: type: string format: date-time deliveredDateTime: type: string format: date-time completedDateTime: type: string format: date-time declinedDateTime: type: string format: date-time voidedDateTime: type: string format: date-time recipients: $ref: '#/components/schemas/DocusignEnvelopeRecipients' DocusignEnvelopeRecipients: type: object additionalProperties: true description: Recipient information returned by DocuSign properties: recipientCount: type: string description: Number of recipients, represented as a DocuSign string currentRoutingOrder: type: string description: Current routing step. Match this to recipient routingOrder and inspect recipient status to identify outstanding actions. Multiple recipients can share a routing order. Also check envelope status before treating a recipient as awaiting action. signers: type: array items: $ref: '#/components/schemas/DocusignEnvelopeRecipient' inPersonSigners: type: array items: $ref: '#/components/schemas/DocusignEnvelopeRecipient' agents: type: array items: $ref: '#/components/schemas/DocusignEnvelopeRecipient' editors: type: array items: $ref: '#/components/schemas/DocusignEnvelopeRecipient' intermediaries: type: array items: $ref: '#/components/schemas/DocusignEnvelopeRecipient' carbonCopies: type: array items: $ref: '#/components/schemas/DocusignEnvelopeRecipient' certifiedDeliveries: type: array items: $ref: '#/components/schemas/DocusignEnvelopeRecipient' witnesses: type: array items: $ref: '#/components/schemas/DocusignEnvelopeRecipient' seals: type: array items: $ref: '#/components/schemas/DocusignEnvelopeRecipient' notaries: type: array items: $ref: '#/components/schemas/DocusignEnvelopeRecipient' DocusignEnvelopeRecipient: type: object additionalProperties: true description: Recipient fields returned by DocuSign. Fields depend on the recipient type; additional type-specific fields are preserved. This response schema is separate from FormKiQ's envelope creation request schemas. properties: recipientId: type: string recipientIdGuid: type: string recipientType: type: string name: type: string email: type: string signerName: type: string signerEmail: type: string hostName: type: string hostEmail: type: string routingOrder: type: string status: type: string description: Recipient status reported by DocuSign sentDateTime: type: string format: date-time deliveredDateTime: type: string format: date-time signedDateTime: type: string format: date-time declinedDateTime: type: string format: date-time AddDocusignEnvelopeRemindersRequest: type: object additionalProperties: false description: Optional selection of one or more signers. Omit the body or send an empty object to remind all eligible recipients at the current routing step. The singular recipientId field, signer names, and email addresses are not accepted. Invalid selections never trigger an envelope-level reminder. properties: recipientIds: type: array minItems: 1 uniqueItems: true description: Existing DocuSign signer IDs from recipients.signers[].recipientId in GET /esignature/docusign/{documentId}/envelopes/{envelopeId} for this same envelope. Every selected signer must be notification-eligible and awaiting action at the current routing step. Validate the entire selection before issuing a resend. Null or empty arrays, duplicate IDs, and null, empty, whitespace-only, or non-string entries are invalid. Omit this property for an envelope-level reminder. items: type: string minLength: 1 pattern: \S example: - "2" - "3" AddDocusignEnvelopeRemindersResponse: type: object additionalProperties: false description: For targeted reminders, recipients contains exactly one outcome for each requested recipient ID. HTTP 200 can include accepted and failed outcomes, including when every recipient failed at the provider after validation. Invalid selections detected before the resend return 400 instead. Envelope-wide acceptance returns an empty object; do not infer individual outcomes. There is no overall status field. Authentication, validation, rate-limit, upstream, and timeout errors use the documented 4xx/5xx responses. properties: recipients: type: array minItems: 1 description: Outcomes for the selected recipients, present for targeted requests and omitted for envelope-wide reminders. A timeout or missing provider outcome must not be represented as confirmed acceptance or failure. items: $ref: '#/components/schemas/DocusignReminderRecipient' DocusignReminderRecipient: type: object additionalProperties: false required: - recipientId - status properties: recipientId: type: string description: Selected DocuSign signer ID from the request example: "1" status: type: string description: accepted means DocuSign accepted the reminder request for this recipient, not confirmed delivery. failed means DocuSign returned a definitive recipient-level failure. example: accepted message: type: string description: Explanation of a recipient-level failure, when available example: Recipient is no longer eligible for a reminder. VoidDocusignEnvelopeRequest: type: object required: - voidedReason properties: voidedReason: type: string minLength: 1 pattern: \S maxLength: 200 description: Non-blank, recipient-facing explanation for voiding the DocuSign envelope. At most 200 characters, including spaces and line breaks; longer reasons are rejected without truncation. example: Document has been replaced. VoidDocusignEnvelopeResponse: type: object required: - envelopeId - status properties: envelopeId: type: string description: Identifier of the DocuSign envelope that was voided example: a1111111-b222-c333-d444-e55555555555 status: type: string description: Envelope status after the successful operation, voided example: voided AddDocusignEnvelopesResponse: type: object properties: envelopeId: type: string description: Docusign Envelope Identifier AddDocusignRecipientViewRequest: type: object required: - recipientView properties: environment: $ref: '#/components/schemas/DocusignEnvironment' recipientView: $ref: '#/components/schemas/DocusignRecipientView' AddDocusignRecipientViewResponse: type: object properties: viewUrl: type: string description: The view URL to be navigated to complete DocuSign signing AddDocusignSenderViewRequest: type: object required: - returnUrl properties: environment: $ref: '#/components/schemas/DocusignEnvironment' returnUrl: type: string description: The URL to which the sender is redirected after exiting the sender view AddDocusignSenderViewResponse: type: object properties: viewUrl: type: string description: The URL for the embedded DocuSign sender view GetFoldersResponse: type: object properties: next: type: string description: Next page of results token previous: type: string description: Previous page of results token documents: type: array description: List of search result documents items: $ref: '#/components/schemas/SearchResultDocument' AddFolderRequest: type: object properties: path: type: string description: Path of Folder to create AddFolderResponse: type: object properties: message: type: string description: Response Message indexKey: type: string description: Folder Index Key MoveFolderRequest: type: object required: - path properties: path: type: string description: Target folder path MoveFolderResponse: type: object properties: message: type: string description: Folder move request status message DeleteFolderResponse: type: object properties: message: type: string description: API Response message GetFolderPermissionsResponse: type: object properties: roles: type: array items: $ref: '#/components/schemas/FolderPermission' FolderPermissionType: type: string description: Folder Permission Type enum: - READ - WRITE - DELETE FolderPermission: type: object properties: roleName: type: string description: Name of Role permissions: type: array items: $ref: '#/components/schemas/FolderPermissionType' SetFolderPermissionsRequest: type: object properties: path: type: string description: Path of Folder roles: type: array items: $ref: '#/components/schemas/AddFolderPermission' AddFolderPermission: type: object properties: roleName: type: string description: Name of Role permissions: type: array description: List of permissions items: $ref: '#/components/schemas/FolderPermissionType' GoogleExportOutputType: type: string description: Google Export Output Type enum: - PDF AddGoogleDocumentExportRequest: type: object properties: path: type: string description: Path of exported file outputType: $ref: '#/components/schemas/GoogleExportOutputType' AddGoogleDocumentExportResponse: type: object properties: documentId: type: string description: Exported document identifier GetGroupsResponse: type: object properties: next: type: string description: Next page of results token groups: type: array description: List of groups items: $ref: '#/components/schemas/Group' GetGroupResponse: type: object properties: group: $ref: '#/components/schemas/Group' GetUserResponse: type: object properties: user: $ref: '#/components/schemas/User' GetUserGroupsResponse: type: object properties: next: type: string description: Next page of results token groups: type: array description: List of groups items: $ref: '#/components/schemas/Group' GetUsersResponse: type: object properties: next: type: string description: Next page of results token users: type: array description: List of users items: $ref: '#/components/schemas/User' Group: type: object properties: name: type: string description: Name of group description: type: string description: Description of group insertedDate: type: string description: Inserted timestamp of group lastModifiedDate: type: string description: Last nodified timestamp of group SetGroupPermissionsRequest: type: object properties: permissions: type: array items: $ref: '#/components/schemas/SiteGroupPermissions' GetUsersInGroupResponse: type: object properties: next: type: string description: Next page of results token users: type: array description: List of users items: $ref: '#/components/schemas/User' AddGroupRequest: required: - group type: object properties: group: $ref: '#/components/schemas/AddGroup' AddGroup: type: object properties: name: type: string description: Name of Group description: type: string description: Description of Group AddUserRequest: required: - user type: object properties: user: $ref: '#/components/schemas/AddUser' AddUser: type: object properties: username: type: string description: Email address of user attributes: $ref: '#/components/schemas/UserAttributes' User: type: object properties: username: type: string description: Username of user email: type: string description: Email of user enabled: type: boolean description: whether the user is enabled userStatus: type: string description: Status of user insertedDate: type: string description: Inserted timestamp of user lastModifiedDate: type: string description: Last nodified timestamp of user attributes: $ref: '#/components/schemas/UserAttributes' UserAttributes: type: object properties: address: type: string description: Address of user birthdate: type: string description: Birthdate of user familyName: type: string description: Family name of user gender: type: string description: Gender of user givenName: type: string description: Given name of user locale: type: string description: Locale of user middleName: type: string description: Middle name of user name: type: string description: Name of user nickname: type: string description: Nickname of user phoneNumber: type: string description: Phone number of user picture: type: string description: Picture of user preferredUsername: type: string description: Preferred username of user profile: type: string description: Profile of user zoneinfo: type: string description: Zoneinfo of user updatedAt: type: string description: Updated at date of user website: type: string description: Website of user IndexFolderMoveRequest: type: object properties: source: type: string description: Source path target: type: string description: Target path DeleteIndicesResponse: type: object properties: message: type: string description: response message IndexFolderMoveResponse: type: object properties: message: type: string description: Folder move message IndexSearchRequest: type: object properties: indexType: type: string description: The name of the index to search IndexSearchResponse: type: object properties: next: type: string description: Next page of results token previous: type: string description: Previous page of results token values: type: array description: List of search results items: $ref: '#/components/schemas/IndexSearch' IndexSearch: type: object properties: value: type: string description: value of index AddMappingResponse: type: object properties: mappingId: type: string description: Mapping Identifier SetMappingRequest: type: object properties: mapping: $ref: '#/components/schemas/AddMapping' AddMappingRequest: type: object properties: mapping: $ref: '#/components/schemas/AddMapping' AddMapping: type: object properties: name: type: string description: Name of Mapping description: type: string description: Description of Mapping attributes: type: array description: List of attributes items: $ref: '#/components/schemas/MappingAttribute' classifications: type: array description: List of classifications items: $ref: '#/components/schemas/MappingClassification' GetMappingsResponse: type: object properties: mappings: type: array items: $ref: '#/components/schemas/Mapping' next: type: string description: Next page of results token GetMappingResponse: type: object properties: mapping: $ref: '#/components/schemas/Mapping' Mapping: type: object required: - mappingId properties: mappingId: type: string description: Mapping Identifier name: type: string description: Name of Mapping description: type: string description: Description of Mapping attributes: type: array description: List of attributes items: $ref: '#/components/schemas/MappingAttribute' classifications: type: array description: List of classifications items: $ref: '#/components/schemas/MappingClassification' MappingClassification: required: - classificationId type: object description: Mapping Classification properties: classificationId: type: string description: Classification Identifier conditions: type: array description: List of classification conditions items: $ref: '#/components/schemas/MappingClassificationCondition' MappingClassificationCondition: oneOf: - $ref: '#/components/schemas/MappingClassificationConditionContent' - $ref: '#/components/schemas/MappingClassificationConditionDataClassification' - $ref: '#/components/schemas/MappingClassificationConditionMetadataExtractionResult' - $ref: '#/components/schemas/MappingClassificationConditionAiPromptResult' discriminator: propertyName: sourceType mapping: CONTENT: '#/components/schemas/MappingClassificationConditionContent' DATA_CLASSIFICATION: '#/components/schemas/MappingClassificationConditionDataClassification' METADATA_EXTRACTION_RESULT: '#/components/schemas/MappingClassificationConditionMetadataExtractionResult' AI_PROMPT_RESULT: '#/components/schemas/MappingClassificationConditionAiPromptResult' MappingClassificationConditionContent: required: - sourceType - matchingType - text type: object description: Mapping Classification Condition properties: sourceType: $ref: '#/components/schemas/MappingClassificationConditionSourceType' matchingType: $ref: '#/components/schemas/MappingClassificationConditionMatchingType' text: type: string description: Text to match against the document content MappingClassificationConditionDataClassification: required: - sourceType - resultKey - resultValue - matchingType type: object description: Mapping Classification Condition properties: sourceType: $ref: '#/components/schemas/MappingClassificationConditionSourceType' resultKey: type: string description: Result key resultValue: type: string description: Result value matchingType: $ref: '#/components/schemas/MappingClassificationConditionMatchingType' MappingClassificationConditionMetadataExtractionResult: required: - sourceType - resultKey - resultValue - matchingType - llmPromptEntityName type: object description: Mapping Classification Condition properties: sourceType: $ref: '#/components/schemas/MappingClassificationConditionSourceType' llmPromptEntityName: type: string description: LLM prompt entity name resultKey: type: string description: Result key resultValue: type: string description: Result value matchingType: $ref: '#/components/schemas/MappingClassificationConditionMatchingType' MappingClassificationConditionAiPromptResult: required: - sourceType - resultKey - resultValue - matchingType - llmPromptEntityName type: object description: Mapping Classification Condition properties: sourceType: $ref: '#/components/schemas/MappingClassificationConditionSourceType' llmPromptEntityName: type: string description: LLM prompt entity name resultKey: type: string description: Result key resultValue: type: string description: Result value matchingType: $ref: '#/components/schemas/MappingClassificationConditionMatchingType' MappingAttribute: oneOf: - $ref: '#/components/schemas/MappingAttributeContent' - $ref: '#/components/schemas/MappingAttributeMetadata' - $ref: '#/components/schemas/MappingAttributeManual' - $ref: '#/components/schemas/MappingAttributeDataClassification' - $ref: '#/components/schemas/MappingAttributeMetadataExtractionResult' - $ref: '#/components/schemas/MappingAttributeAiPromptResult' - $ref: '#/components/schemas/MappingAttributeMalwareScan' discriminator: propertyName: sourceType mapping: CONTENT: '#/components/schemas/MappingAttributeContent' CONTENT_KEY_VALUE: '#/components/schemas/MappingAttributeContent' METADATA: '#/components/schemas/MappingAttributeMetadata' MANUAL: '#/components/schemas/MappingAttributeManual' DATA_CLASSIFICATION: '#/components/schemas/MappingAttributeDataClassification' METADATA_EXTRACTION_RESULT: '#/components/schemas/MappingAttributeMetadataExtractionResult' AI_PROMPT_RESULT: '#/components/schemas/MappingAttributeAiPromptResult' MALWARE_SCAN: '#/components/schemas/MappingAttributeMalwareScan' MappingAttributeContent: required: - attributeKey - sourceType - labelTexts - labelMatchingType type: object description: Mapping Attribute from document content or content key-value data properties: attributeKey: type: string description: Attribute Key sourceType: $ref: '#/components/schemas/MappingAttributeSourceType' defaultValue: type: string description: Default value used when no matching value is found defaultValues: type: array description: Default values used when no matching value is found items: type: string labelTexts: type: array description: Label Texts items: type: string description: Label Text labelMatchingType: $ref: '#/components/schemas/MappingAttributeLabelMatchingType' validationRegex: type: string description: Attribute Value Regex Validation MappingAttributeMetadata: required: - attributeKey - sourceType - labelTexts - labelMatchingType - metadataField type: object description: Mapping Attribute from document metadata properties: attributeKey: type: string description: Attribute Key sourceType: $ref: '#/components/schemas/MappingAttributeSourceType' defaultValue: type: string description: Default value used when no matching value is found defaultValues: type: array description: Default values used when no matching value is found items: type: string labelTexts: type: array description: Label Texts items: type: string description: Label Text labelMatchingType: $ref: '#/components/schemas/MappingAttributeLabelMatchingType' metadataField: $ref: '#/components/schemas/MappingAttributeMetadataField' MappingAttributeManual: required: - attributeKey - sourceType type: object description: Mapping Attribute with manually configured default values properties: attributeKey: type: string description: Attribute Key sourceType: $ref: '#/components/schemas/MappingAttributeSourceType' defaultValue: type: string description: Default value defaultValues: type: array description: Default values items: type: string MappingAttributeDataClassification: required: - attributeKey - sourceType type: object description: Mapping Attribute from document data classification results properties: attributeKey: type: string description: Attribute Key sourceType: $ref: '#/components/schemas/MappingAttributeSourceType' MappingAttributeMetadataExtractionResult: required: - attributeKey - sourceType - llmPromptEntityName type: object description: Mapping Attribute from document metadata extraction results properties: attributeKey: type: string description: Attribute Key sourceType: $ref: '#/components/schemas/MappingAttributeSourceType' llmPromptEntityName: type: string description: LLM prompt entity name MappingAttributeAiPromptResult: required: - attributeKey - sourceType - llmPromptEntityName type: object description: Mapping Attribute from document AI Prompt result properties: attributeKey: type: string description: Attribute Key sourceType: $ref: '#/components/schemas/MappingAttributeSourceType' llmPromptEntityName: type: string description: LLM prompt entity name MappingAttributeMalwareScan: required: - attributeKey - sourceType type: object description: Mapping Attribute from document malware scan results properties: attributeKey: type: string description: Attribute Key sourceType: $ref: '#/components/schemas/MappingAttributeSourceType' MappingAttributeMetadataField: type: string description: Attribute Metadata Field enum: - USERNAME - PATH - CONTENT_TYPE MappingAttributeLabelMatchingType: type: string description: Attribute Label Matching Type enum: - FUZZY - EXACT - BEGINS_WITH - CONTAINS MappingClassificationConditionMatchingType: type: string description: Classification Condition Result Matching Type enum: - EXACT - BEGINS_WITH - CONTAINS MappingAttributeSourceType: type: string description: Attribute Source Type enum: - CONTENT - CONTENT_KEY_VALUE - METADATA - MANUAL - DATA_CLASSIFICATION - METADATA_EXTRACTION_RESULT - AI_PROMPT_RESULT - MALWARE_SCAN MappingClassificationConditionSourceType: type: string description: Classification Condition Source Type enum: - CONTENT - DATA_CLASSIFICATION - METADATA_EXTRACTION_RESULT - AI_PROMPT_RESULT GetExaminePdfUrlResponse: type: object properties: id: type: string description: Uploaded document identifier uploadUrl: type: string description: Url to upload document to GetExaminePdfResponse: type: object properties: fileinfo: $ref: '#/components/schemas/PdfDocument' PdfDocument: type: object properties: fields: type: array description: List of document fields items: $ref: '#/components/schemas/PdfDocumentField' PdfDocumentField: type: object properties: field: type: string description: Name of Field value: type: string description: Value of Field WorkflowDocument: type: object properties: workflow: $ref: '#/components/schemas/WorkflowSummary' document: $ref: '#/components/schemas/Document' DeleteQueueResponse: type: object properties: message: type: string description: Result message AddQueueRequest: type: object required: - name properties: name: description: Queue name type: string AddQueueResponse: type: object properties: queueId: type: string description: Queue Identifier GetQueuesResponse: type: object properties: next: type: string description: Next page of results token queues: type: array description: List of queues items: $ref: '#/components/schemas/Queue' Queue: type: object properties: name: type: string description: Name of Queue queueId: type: string description: Queue identifier GetQueueResponse: type: object properties: name: description: Queue name type: string GetWorkflowQueueDocumentsResponse: type: object properties: next: type: string description: Next page of results token documents: type: array description: List of search result documents items: $ref: '#/components/schemas/WorkflowDocument' DeleteRulesetResponse: type: object properties: message: type: string description: Result message DeleteRuleResponse: type: object properties: message: type: string description: Result message RulesetStatus: type: string description: Status of the Ruleset enum: - ACTIVE - INACTIVE AddRulesetResponse: type: object properties: rulesetId: type: string description: Ruleset Identifier UpdateRulesetResponse: type: object properties: message: type: string description: Ruleset update message UpdateRuleResponse: type: object properties: message: type: string description: Rule update message AddRuleResponse: type: object properties: ruleId: type: string description: Rule Identifier AddRuleRequest: required: - case type: object properties: rule: $ref: '#/components/schemas/AddRule' UpdateRuleRequest: required: - case type: object properties: rule: $ref: '#/components/schemas/UpdateRule' AddRule: type: object properties: priority: type: number description: Rule priority description: type: string description: Rule description workflowId: type: string description: Workflow to start on matching of conditions status: $ref: '#/components/schemas/RulesetStatus' conditions: $ref: '#/components/schemas/RuleCondition' UpdateRule: type: object properties: priority: type: number description: Rule priority description: type: string description: Rule description status: $ref: '#/components/schemas/RulesetStatus' workflowId: type: string description: Workflow to start on matching of conditions conditions: $ref: '#/components/schemas/RuleCondition' AddRulesetRequest: required: - ruleset type: object properties: ruleset: $ref: '#/components/schemas/AddRuleset' UpdateRulesetRequest: required: - ruleset type: object properties: ruleset: $ref: '#/components/schemas/UpdateRuleset' AddRuleset: type: object properties: description: type: string description: Ruleset description priority: type: number description: Ruleset priority version: type: number description: Ruleset version status: $ref: '#/components/schemas/RulesetStatus' UpdateRuleset: type: object properties: description: type: string description: Ruleset description priority: type: number description: Ruleset priority version: type: number description: Ruleset version status: $ref: '#/components/schemas/RulesetStatus' GetRulesResponse: type: object properties: next: type: string description: Next page of results token rules: type: array description: List of rules items: $ref: '#/components/schemas/Rule' GetRuleResponse: type: object properties: rule: $ref: '#/components/schemas/Rule' GetRulesetsResponse: type: object properties: next: type: string description: Next page of results token rulesets: type: array description: List of rulesets items: $ref: '#/components/schemas/Ruleset' GetRulesetResponse: type: object properties: ruleset: $ref: '#/components/schemas/Ruleset' Ruleset: type: object required: - rulesetId properties: rulesetId: type: string description: Ruleset identifier description: type: string description: Ruleset description priority: type: number description: Ruleset priority version: type: number description: Ruleset version insertedDate: type: string description: Inserted Timestamp status: $ref: '#/components/schemas/RulesetStatus' Rule: type: object properties: ruleId: type: string description: Workflow to start on matching of conditions priority: type: number description: Rule priority description: type: string description: Ruleset description workflowId: type: string description: Workflow to start on matching of conditions status: $ref: '#/components/schemas/RulesetStatus' conditions: $ref: '#/components/schemas/RuleCondition' RuleCondition: type: object properties: must: type: array description: List of rule conditions items: $ref: '#/components/schemas/RuleConditionMust' RuleConditionCriterion: type: string description: Rule condition attribute enum: - TEXT - CONTENT_TYPE - BARCODE - FIELD - ATTRIBUTE RuleConditionAttribute: type: string description: Rule condition attribute (deprecated, use Criterion) enum: - TEXT - CONTENT_TYPE - BARCODE - FIELD - ATTRIBUTE RuleConditionOperation: type: string description: Rule condition attribute enum: - EQ - CONTAINS RuleConditionMust: type: object properties: attribute: $ref: '#/components/schemas/RuleConditionAttribute' criterion: $ref: '#/components/schemas/RuleConditionCriterion' attributeKey: type: string description: Rule attribute key (only required for ATTRIBUTE criterion) fieldName: type: string description: Rule field name (only required for FIELD criterion) value: type: string description: Rule condition value operation: $ref: '#/components/schemas/RuleConditionOperation' DocumentFulltextAttributeEq: properties: stringValue: type: string description: Search for string value numberValue: type: number description: Search for number value booleanValue: type: boolean description: Search for boolean value dateValue: type: string description: Search for date value SearchRangeDataType: type: string description: Search Range Data Type enum: - STRING - NUMBER - DATE default: STRING DocumentFulltextAttribute: required: - key type: object properties: eq: $ref: '#/components/schemas/DocumentFulltextAttributeEq' eqOr: type: array description: Searches for ANY strings that eq items: $ref: '#/components/schemas/DocumentFulltextAttributeEq' key: type: string description: Tag key to search DocumentFulltextTag: required: - key type: object properties: eq: type: string description: Searches for strings that eq eqOr: type: array description: Searches for ANY strings that eq items: type: string key: type: string description: Tag key to search DocumentSearchRange: required: - start - end type: object properties: start: type: string description: Start of range query end: type: string description: End of range query type: $ref: '#/components/schemas/SearchRangeDataType' DocumentFulltextSearch: type: object description: Document full text search criteria properties: page: type: integer description: Result page to return (starting at 1) text: type: string description: Full text search tags: type: array description: List of search tags items: $ref: '#/components/schemas/DocumentFulltextTag' attributes: type: array description: List of search attributes items: $ref: '#/components/schemas/DocumentFulltextAttribute' DocumentSearchFilename: type: object properties: beginsWith: type: string description: Searches for a filename DocumentSearchFolder: type: object properties: beginsWith: type: string description: Searches for a folder DocumentSearchMeta: type: object properties: folder: type: string description: Searches for a folder path: type: string description: Searches for a Path of document eq: type: string description: Searches for strings that eq indexType: type: string description: Searches in an index enum: - folder indexFilterBeginsWith: type: string description: Returns index records that begins with a particular substring DocumentSearchTag: required: - key type: object properties: beginsWith: type: string description: Searches for strings that begin with eq: type: string description: Searches for strings that eq eqOr: type: array description: Searches for ANY strings that eq items: type: string range: $ref: '#/components/schemas/DocumentSearchRange' key: type: string description: Tag key to search DocumentSearchTags: required: - key type: object properties: eq: type: string description: Searches for strings that eq beginsWith: type: string description: Searches for strings that begin with range: $ref: '#/components/schemas/DocumentSearchRange' key: type: string description: Tag key to search DocumentSearchAttribute: required: - key type: object properties: eq: type: string description: Searches for strings that eq eqOr: type: array description: Searches for ANY strings that eq items: type: string beginsWith: type: string description: Searches for strings that begin with range: $ref: '#/components/schemas/DocumentSearchRange' key: type: string description: Attribute key to search DocumentSearchRequest: required: - query type: object description: Document search tag criteria properties: query: $ref: '#/components/schemas/DocumentSearch' responseFields: $ref: '#/components/schemas/SearchResponseFields' DocumentSearch: type: object description: Document tag search criteria properties: text: type: string description: Full text search meta: $ref: '#/components/schemas/DocumentSearchMeta' filename: $ref: '#/components/schemas/DocumentSearchFilename' folder: $ref: '#/components/schemas/DocumentSearchFolder' attribute: $ref: '#/components/schemas/DocumentSearchAttribute' attributes: type: array description: List of Composite Key attributes to filter search results on items: $ref: '#/components/schemas/DocumentSearchAttribute' tag: $ref: '#/components/schemas/DocumentSearchTag' tags: type: array description: List of Composite Key tags to filter search results on items: $ref: '#/components/schemas/DocumentSearchTags' documentIds: type: array description: List of DocumentIds to filter search results on items: type: string SearchResponseFields: properties: attributes: type: array items: type: string tags: type: array items: type: string DocumentSearchResponse: type: object properties: next: type: string description: Next page of results token previous: type: string description: Previous page of results token documents: type: array description: List of search result documents items: $ref: '#/components/schemas/SearchResultDocument' SearchResultDocument: type: object properties: siteId: type: string description: Site Identifier path: type: string description: Path or Name of document width: type: string description: Document Content Width property height: type: string description: Document Content Height property deepLinkPath: type: string description: Path or Name of deep link resourceType: $ref: '#/components/schemas/DocumentResourceType' insertedDate: type: string description: Inserted Timestamp lastModifiedDate: type: string description: Last Modified Timestamp folder: type: boolean description: Is Result a Document Folder indexKey: type: string description: populated if search result are from an index checksum: type: string description: Document checksum, changes when document file changes checksumType: $ref: '#/components/schemas/ChecksumType' documentId: type: string description: Document Identifier artifactId: type: string description: Document Artifact Identifier promotedArtifactId: type: string description: Promoted Artifact Identifier artifactCategory: type: string description: Document Artifact Category hasArtifacts: type: boolean description: Whether the document has artifact documents contentType: type: string description: Document Content-Type userId: type: string description: User who added document contentLength: type: integer description: Document size versionId: type: string description: Document version belongsToDocumentId: type: string description: Parent Document Identifier matchedAttribute: $ref: '#/components/schemas/DocumentSearchMatchAttribute' matchedTag: $ref: '#/components/schemas/DocumentSearchMatchTag' matchedTags: items: $ref: '#/components/schemas/DocumentSearchMatchTag' tags: type: object additionalProperties: true attributes: type: object additionalProperties: $ref: '#/components/schemas/SearchResultDocumentAttribute' metadata: type: array description: List of document Metadata items: $ref: '#/components/schemas/DocumentMetadata' SearchResultDocumentAttribute: properties: stringValues: type: array description: Attribute with string values items: type: string numberValues: type: array description: Attribute with number values items: type: number booleanValue: type: boolean description: Attribute with boolean value dateValues: type: array description: Attribute with date values items: type: string valueType: $ref: '#/components/schemas/AttributeValueType' DocumentSearchMatchTag: type: object properties: key: type: string description: Tag key value: type: string description: Tag value type: type: string description: Tag type DocumentSearchMatchAttribute: type: object properties: key: type: string description: Tag key stringValue: type: string description: Attribute with string value numberValue: type: number description: Attribute with number value booleanValue: type: boolean description: Attribute with boolean value dateValue: type: string description: Attribute with date value DocumentFulltextRequest: required: - query type: object description: Document full text search properties: query: $ref: '#/components/schemas/DocumentFulltextSearch' responseFields: $ref: '#/components/schemas/SearchResponseFields' DocumentFulltextResponse: type: object properties: totalCount: type: integer description: | Total number of documents that matched the search query. When the number of matches exceeds 10,000, this value will be reported as 10,000+ unless the search request explicitly enables exact total hit tracking. documents: type: array description: List of search result documents items: $ref: '#/components/schemas/FulltextSearchItem' FulltextSearchItem: type: object properties: siteId: type: string description: Site Identifier path: type: string description: Path or Name of document contentType: type: string description: Document Content-Type width: type: string description: Document Content Width property height: type: string description: Document Content Height property deepLinkPath: type: string description: Path or Name of deep link resourceType: $ref: '#/components/schemas/DocumentResourceType' insertedDate: type: string description: Inserted Timestamp lastModifiedDate: type: string description: Last Modified Timestamp checksum: type: string description: Document checksum, changes when document file changes checksumType: $ref: '#/components/schemas/ChecksumType' documentId: type: string description: Document Identifier contentLength: type: integer description: Document size createdBy: type: string description: User who added document tags: type: object additionalProperties: type: object metadata: type: object additionalProperties: type: object attributes: type: object additionalProperties: $ref: '#/components/schemas/FulltextAttribute' FulltextAttribute: type: object properties: insertedDate: type: string description: Inserted Timestamp stringValues: type: array description: Attribute with string values items: type: string numberValues: type: array description: Attribute with number values items: type: number booleanValue: type: boolean description: Attribute with boolean value dateValues: type: array description: Attribute with date values items: type: string valueType: $ref: '#/components/schemas/AttributeValueType' QueryFulltextRequest: description: OpenSearch search API request (https://opensearch.org/docs/latest/opensearch/rest-api/search/) type: object example: query: match: title: Wind QueryFulltextResponse: type: object properties: result: type: object example: result: hits: hits: - _index: "" _id: "" _source: documentId: "" content: "" GetUserSharesResponse: type: object properties: next: type: string description: Next page of results token shares: type: array description: List of user's shares items: $ref: '#/components/schemas/UserShare' UserSharePermission: type: string description: User Share Permission enum: - READ - WRITE - DELETE UserSharePermissionType: type: string description: User Share Permission Type enum: - GROUP UserShare: type: object properties: group: type: string description: Name of Share Group shareKey: type: string description: Share Identifier type: type: string enum: - FOLDER description: Type of Document permissions: type: array description: List of share permissions items: $ref: '#/components/schemas/UserSharePermission' siteId: type: string description: Site Identifier path: type: string description: Path or Name of document userId: type: string description: User who created share permissionType: $ref: '#/components/schemas/UserSharePermissionType' AddFolderShareResponse: type: object properties: message: type: string description: API Response message shareKey: type: string description: Share Identifier DeleteShareResponse: type: object properties: message: type: string description: API Response message AddFolderShareRequest: type: object properties: share: $ref: '#/components/schemas/AddShare' AddShare: type: object properties: group: type: string description: Share with Group permissions: type: array description: List of share permissions items: $ref: '#/components/schemas/UserSharePermission' AddShortlinkRequest: type: object required: - targetUrl - slug properties: targetUrl: type: string description: Target URL for the shortlink slug: type: string description: Shortlink slug AddShortlinkResponse: type: object properties: url: type: string description: Shortlink URL OpaPolicyAttributeEq: type: object description: Attribute EQ criteria properties: stringValue: type: string description: The value to compare the Attribute Key value to numberValue: type: number description: The value to compare the Attribute Key value to booleanValue: type: boolean description: The value to compare the Attribute Key value to input: $ref: '#/components/schemas/OpaPolicyAttributeInput' OpaPolicyAttributeGt: type: object description: Attribute greater than criteria properties: numberValue: type: number description: The value to compare the Attribute Key value to OpaPolicyAttributeGte: type: object description: Attribute greater than and equals to criteria properties: numberValue: type: number description: The value to compare the Attribute Key value to OpaPolicyAttributeLt: type: object description: Attribute less than criteria properties: numberValue: type: number description: The value to compare the Attribute Key value to OpaPolicyAttributeLte: type: object description: Attribute less than and equals to criteria properties: numberValue: type: number description: The value to compare the Attribute Key value to OpaPolicyAttributeNeq: type: object description: Attribute not equal to criteria properties: stringValue: type: string description: The value to compare the Attribute Key value to OpaPolicyAttributeIn: type: object description: Attribute In to criteria properties: stringValues: type: array items: type: string description: The value to compare the Attribute Key value to OpaPolicyAttributeNotIn: type: object description: Attribute Not In to criteria properties: stringValues: type: array items: type: string description: The value to compare the Attribute Key value to OpaPolicyAttributeInput: type: object properties: matchUsername: type: boolean description: Match Input Username matchUserClaim: type: string description: Matches user claim name to match against the Attribute Key value OpaPolicyInputMethod: type: object properties: in: type: array description: List of HTTP Methods items: type: string notIn: type: array description: List of HTTP Methods items: type: string OpaPolicyInputResource: type: object properties: in: type: array description: List of Resources items: type: string notIn: type: array description: List of Resources items: type: string AttributeSchemaCompositeKey: type: object properties: attributeKeys: type: array items: type: string AddAttributeSchemaRequired: type: object properties: defaultEntityTypeId: type: string defaultEntityId: type: string minNumberOfValues: type: number description: The minimum number of attribute values maxNumberOfValues: type: number description: The maximum number of attribute values attributeKey: type: string defaultValue: type: string description: Default value defaultValues: type: array description: Default values items: type: string allowedValues: type: array description: Only valid string values items: type: string AttributeSchemaRequired: type: object properties: attributeKey: type: string defaultEntityTypeId: type: string defaultEntityId: type: string minNumberOfValues: type: number description: The minimum number of attribute values maxNumberOfValues: type: number description: The maximum number of attribute values defaultValue: type: string description: Default value defaultValues: type: array description: Default values items: type: string allowedValues: type: array description: Only valid string values items: type: string localizedAllowedValues: type: object additionalProperties: type: string AddAttributeSchemaOptional: type: object properties: defaultEntityTypeId: type: string defaultEntityId: type: string minNumberOfValues: type: number description: The minimum number of attribute values maxNumberOfValues: type: number description: The maximum number of attribute values attributeKey: type: string allowedValues: type: array description: Only valid string values items: type: string AttributeSchemaOptional: type: object properties: defaultEntityTypeId: type: string defaultEntityId: type: string minNumberOfValues: type: number description: The minimum number of attribute values maxNumberOfValues: type: number description: The maximum number of attribute values attributeKey: type: string allowedValues: type: array description: Only valid string values items: type: string localizedAllowedValues: type: object additionalProperties: type: string LocaleResourceType: type: string description: Type of Locale Resource enum: - INTERFACE - SCHEMA - CLASSIFICATION AddLocaleResourceInterfaceItem: type: object required: - itemType - interfaceKey - localizedValue properties: itemType: $ref: '#/components/schemas/LocaleResourceType' localizedValue: type: string description: Localized Value interfaceKey: type: string description: Interface Key AddLocaleResourceSchemaItem: type: object required: - itemType - attributeKey - allowedValue - localizedValue properties: itemType: $ref: '#/components/schemas/LocaleResourceType' attributeKey: type: string description: Attribute Key allowedValue: type: string description: Resource value localizedValue: type: string description: Localized Value AddLocaleResourceClassificationItem: type: object required: - itemType - attributeKey - allowedValue - localizedValue - classificationId properties: itemType: $ref: '#/components/schemas/LocaleResourceType' classificationId: type: string description: Classification Id attributeKey: type: string description: Attribute Key allowedValue: type: string description: Resource value localizedValue: type: string description: Localized Value OpaPolicyAttribute: type: object properties: key: type: string description: Attribute Key eq: $ref: '#/components/schemas/OpaPolicyAttributeEq' gt: $ref: '#/components/schemas/OpaPolicyAttributeGt' gte: $ref: '#/components/schemas/OpaPolicyAttributeGte' lt: $ref: '#/components/schemas/OpaPolicyAttributeLt' lte: $ref: '#/components/schemas/OpaPolicyAttributeLte' neq: $ref: '#/components/schemas/OpaPolicyAttributeNeq' in: $ref: '#/components/schemas/OpaPolicyAttributeIn' notIn: $ref: '#/components/schemas/OpaPolicyAttributeNotIn' OpaPolicyInput: type: object properties: httpMethod: $ref: '#/components/schemas/OpaPolicyInputMethod' resource: $ref: '#/components/schemas/OpaPolicyInputResource' OpenSearchSnapshotFailure: type: object description: Details about a failure for a specific shard in a snapshot. properties: index: type: string description: The index name. index_uuid: type: string description: UUID of the index. shard_id: type: integer format: int32 description: Shard identifier. reason: type: string description: Full exception/message explaining why the failure occurred. node_id: type: string description: ID of the node handling that shard. status: type: string description: Status of the failure (e.g., INTERNAL_SERVER_ERROR). OpenSearchSnapshotShard: type: object properties: total: type: number description: Total number of shards failed: type: number description: Failed number of shards successful: type: number description: Successful number of shards OpenSearchAlias: type: object properties: name: type: string description: Name of Alias AddResourceItem: oneOf: - $ref: '#/components/schemas/AddLocaleResourceInterfaceItem' - $ref: '#/components/schemas/AddLocaleResourceSchemaItem' - $ref: '#/components/schemas/AddLocaleResourceClassificationItem' ResourceItem: properties: itemType: $ref: '#/components/schemas/LocaleResourceType' localizedValue: type: string description: Localized Value interfaceKey: type: string description: Interface Key itemKey: type: string description: Item Key attributeKey: type: string description: Attribute Key allowedValue: type: string description: Resource value classificationId: type: string description: Classification Id ApiKeyPermission: type: string description: List of API permissions (defaults to READ / WRITE / DELETE) enum: - READ - WRITE - DELETE - GOVERN OpaPolicy: type: object properties: siteId: type: string description: SiteId to apply OPA Policy to policy: type: string description: OPA Policy in REGO format OpaPolicyItem: type: object properties: policy: type: string description: OPA Policy in REGO format allRoles: items: type: string description: User must match all roles anyRoles: items: type: string description: User must match any role excludedRoles: items: type: string description: User must NOT have these roles attributes: items: $ref: '#/components/schemas/OpaPolicyAttribute' input: $ref: '#/components/schemas/OpaPolicyInput' ApiKey: type: object properties: name: type: string description: Name of API Key apiKey: type: string description: API Key value userId: type: string siteId: type: string insertedDate: type: string description: Inserted Timestamp permissions: type: array description: List of permissions items: type: string enum: - READ - WRITE - DELETE - GOVERN groups: type: array description: List of groups to add as custom claims to API Key items: type: string OpenSearchSnapshot: type: object properties: snapshot: type: string description: Snapshot name uuid: type: string description: Snapshot’s universally unique identifier (UUID) version: type: string description: Open Search version that created the snapshot indices: type: array description: Indices in the snapshot items: type: string shards: $ref: '#/components/schemas/OpenSearchSnapshotShard' failures: type: array items: $ref: '#/components/schemas/OpenSearchSnapshotFailure' state: type: string description: 'Snapshot status. Possible values: IN_PROGRESS, SUCCESS, FAILED, PARTIAL' start_time: type: string description: Date/time when the snapshot creation process began start_time_in_millis: type: number description: Time (in milliseconds) when the snapshot creation process began end_time: type: string description: Date/time when the snapshot creation process ended end_time_in_millis: type: number description: Time (in milliseconds) when the snapshot creation process ended duration_in_millis: type: number description: Total time (in milliseconds) that the snapshot creation process lasted OpenSearchS3Repository: type: object properties: repository: type: string description: Name of the Repository bucket: type: string description: Name of the S3 bucket SiteGroup: type: object properties: permissions: type: array items: $ref: '#/components/schemas/SiteGroupPermissions' LocaleInfo: type: object required: - locale properties: locale: type: string description: Name of Locale OpenSearchIndex: type: object properties: numberOfReplicas: type: string description: The number of replicas per shard numberOfShards: type: string description: The number of shards in index documentCount: type: string description: The number of documents in index storeSize: type: string description: The store size of the index name: type: string description: Name of Index aliases: type: array items: $ref: '#/components/schemas/OpenSearchAlias' ClassificationSummary: type: object required: - classificationId properties: classificationId: type: string description: Classification Identifier name: description: Name of Classification type: string userId: type: string insertedDate: type: string description: Inserted Timestamp Classification: type: object properties: name: description: Name of Classification type: string userId: type: string insertedDate: type: string description: Inserted Timestamp attributes: $ref: '#/components/schemas/SchemaAttributes' AddClassification: type: object properties: name: description: Name of Classification type: string attributes: $ref: '#/components/schemas/SetSchemaAttributes' OpenSearchIndexSetting: type: object properties: numberOfReplicas: type: string description: The number of replicas per shard numberOfShards: type: string description: The number of shards in index UpdateSite: type: object properties: title: description: Title of Site type: string status: $ref: '#/components/schemas/SiteStatus' SetSchemaAttributes: type: object properties: compositeKeys: type: array description: List of Composite Keys items: $ref: '#/components/schemas/AttributeSchemaCompositeKey' required: type: array description: List of Required Attributes items: $ref: '#/components/schemas/AddAttributeSchemaRequired' optional: type: array description: List of Optional Attribute items: $ref: '#/components/schemas/AddAttributeSchemaOptional' allowAdditionalAttributes: type: boolean default: true SchemaAttributes: type: object properties: compositeKeys: type: array description: List of Composite Keys items: $ref: '#/components/schemas/AttributeSchemaCompositeKey' required: type: array description: List of Required Attributes items: $ref: '#/components/schemas/AttributeSchemaRequired' optional: type: array description: List of Optional Attribute items: $ref: '#/components/schemas/AttributeSchemaOptional' allowAdditionalAttributes: type: boolean default: true SetLocaleResourceItemRequest: type: object properties: resourceItem: $ref: '#/components/schemas/AddResourceItem' AddLocaleResourceItemRequest: type: object properties: resourceItem: $ref: '#/components/schemas/AddResourceItem' AddLocaleResourceItemResponse: type: object properties: itemKey: type: string description: Item Key of resource AddLocaleRequest: type: object properties: locale: type: string description: Name of Locale GetLocalesResponse: type: object properties: next: type: string description: Next page of results token locales: type: array description: List of Locale items: $ref: '#/components/schemas/LocaleInfo' GetLocaleResourceItemsResponse: type: object properties: next: type: string description: Next page of results token resourceItems: type: array description: List of permissions items: $ref: '#/components/schemas/ResourceItem' GetLocaleResourceItemResponse: type: object properties: resourceItem: $ref: '#/components/schemas/ResourceItem' AddApiKeyRequest: type: object properties: name: type: string description: Name of API Key groups: type: array description: Optional list of groups to add as custom claims to API Key items: type: string permissions: type: array items: $ref: '#/components/schemas/ApiKeyPermission' AddApiKeyResponse: type: object properties: apiKey: type: string description: API Key Identifier DeleteApiKeyResponse: type: object properties: message: type: string description: Result message GetOpaAccessPoliciesResponse: type: object properties: next: type: string description: Next page of results token opaPolicies: type: array description: List of OPA policies items: $ref: '#/components/schemas/OpaPolicy' SetOpaAccessPolicyItemsRequest: type: object required: - policyItems properties: policyItems: type: array description: List of OPA policy items items: $ref: '#/components/schemas/OpaPolicyItem' GetOpaAccessPolicyResponse: type: object properties: opaPolicy: type: string description: OPA Policy in REGO format GetOpaAccessPolicyItemsResponse: type: object properties: policyItems: items: $ref: '#/components/schemas/OpaPolicyItem' GetApiKeysResponse: type: object properties: next: type: string description: Next page of results token apiKeys: type: array description: List of ApiKeys items: $ref: '#/components/schemas/ApiKey' GetOpenSearchSnapshotResponse: type: object properties: snapshots: type: array items: $ref: '#/components/schemas/OpenSearchSnapshot' GetOpenSearchSnapshotRepositoryResponse: type: object properties: s3Repositories: type: array items: $ref: '#/components/schemas/OpenSearchS3Repository' CleanupOpenSearchSnapshotRepositoryResponse: type: object properties: message: type: string description: The OpenSearch cleanup snapshot repository response. SetOpenSearchIndiceRequest: type: object properties: indexName: type: string description: The name of the index to set for SiteId SetOpenSearchIndexRequest: type: object properties: indexSettings: $ref: '#/components/schemas/OpenSearchIndexSetting' SetOpenSearchIndexResponse: type: object properties: message: type: string description: Result message GetSiteGroupsResponse: type: object properties: groupNames: type: array items: type: string GetSiteGroupResponse: type: object properties: group: $ref: '#/components/schemas/SiteGroup' GetOpenSearchIndiceResponse: type: object properties: indices: type: array description: OpenSearch Indices items: $ref: '#/components/schemas/OpenSearchIndex' GetOpenSearchIndexResponse: type: object properties: indexSettings: $ref: '#/components/schemas/OpenSearchIndexSetting' AddClassificationResponse: type: object properties: classificationId: type: string description: Classification Identifier GetSitesSchemaResponse: type: object properties: name: description: Name of schema type: string attributes: $ref: '#/components/schemas/SchemaAttributes' GetClassificationResponse: type: object properties: classification: $ref: '#/components/schemas/Classification' GetClassificationsResponse: type: object properties: next: type: string description: Next page of results token classifications: type: array description: List of classifications items: $ref: '#/components/schemas/ClassificationSummary' SetClassificationRequest: type: object properties: classification: $ref: '#/components/schemas/AddClassification' UpdateSiteRequest: type: object properties: site: $ref: '#/components/schemas/UpdateSite' AddClassificationRequest: type: object properties: classification: $ref: '#/components/schemas/AddClassification' SetSitesSchemaRequest: type: object properties: name: description: Name of schema type: string attributes: $ref: '#/components/schemas/SetSchemaAttributes' AddSiteRequest: type: object properties: site: $ref: '#/components/schemas/AddSite' AddSite: type: object properties: id: description: Site Id type: string title: description: Title of Site type: string status: $ref: '#/components/schemas/SiteStatus' GetSitesResponse: type: object properties: username: type: string description: Username of request caller roles: type: array items: type: string samlGroups: type: array description: List of User Saml Groups items: type: string userClaims: type: object description: Map of custom JWT claims additionalProperties: type: object sites: type: array description: List of sites items: $ref: '#/components/schemas/Site' Site: type: object properties: siteId: type: string description: Site Identifier title: type: string description: Site Title status: $ref: '#/components/schemas/SiteStatus' permission: deprecated: true description: 'Deprecated: use permissions' $ref: '#/components/schemas/SitePermission' roles: type: array description: List of roles used to get permissions items: type: string permissions: type: array items: $ref: '#/components/schemas/SiteGroupPermissions' uploadEmail: type: string description: SiteId document upload email address config: $ref: '#/components/schemas/SiteConfig' usage: $ref: '#/components/schemas/SiteUsage' SiteStatus: type: string description: Site status enum: - ACTIVE - INACTIVE SitePermission: type: string deprecated: true description: 'Deprecated: use permissions' enum: - READ_WRITE - READ_ONLY SiteGroupPermissions: type: string description: Site Group Permissions enum: - ADMIN - DELETE - READ - WRITE - GOVERN SiteConfig: type: object properties: branding: $ref: '#/components/schemas/BrandingConfig' maxContentLengthBytes: type: string description: Set Maximum Document Content Length in Bytes maxDocuments: type: string description: Set Maximum number of Documents allowed maxWebhooks: type: string description: Set Maximum number of Webhooks allowed ocr: $ref: '#/components/schemas/OcrConfig' SiteUsage: type: object properties: documentCount: type: number description: The number of documents in the site (only tracked when using MaxDocuments) ocrTransactionCount: type: number description: The number of ocr tx requests in the site (only tracked when using OCR MaxTransactions) OcrConfig: type: object properties: maxPagesPerTransaction: type: number description: Max number of OCR pages (-1 for unlimited) maxTransactions: type: number description: Max number of OCR actions that can be created (-1 for unlimited) NumberingSequenceReset: type: string description: Frequency at which the sequence restarts at startAt enum: - NONE - YEARLY NumberingSequence: type: object required: - attributeKey - pattern - startAt - padding - reset properties: attributeKey: type: string description: Attribute key where generated values are stored pattern: type: string description: Number format using supported tokens such as {YEAR} and {SEQUENCE} example: CONTRACT-{YEAR}-{SEQUENCE} startAt: type: integer format: int64 minimum: 1 description: First sequence number allocated for a new period example: 1 padding: type: integer minimum: 1 description: Minimum width of the generated sequence number, padded with leading zeroes example: 5 reset: $ref: '#/components/schemas/NumberingSequenceReset' timezone: type: string description: IANA timezone used to determine the active period; defaults to UTC default: UTC example: America/Winnipeg currentPeriod: type: string nullable: true readOnly: true description: Active sequence period, or null if no number has been allocated example: "2026" currentSequence: type: integer format: int64 nullable: true readOnly: true description: Most recently allocated sequence number, or null if none has been allocated example: 2 lastValue: type: string nullable: true readOnly: true description: Most recently generated attribute value, or null if none has been allocated example: CONTRACT-2026-00002 SetNumberingSequenceRequest: type: object required: - pattern - startAt - padding - reset properties: pattern: type: string description: Number format using supported tokens such as {YEAR} and {SEQUENCE} example: CONTRACT-{YEAR}-{SEQUENCE} startAt: type: integer format: int64 minimum: 1 description: First sequence number allocated for a new period example: 1 padding: type: integer minimum: 1 description: Minimum width of the generated sequence number, padded with leading zeroes example: 5 reset: $ref: '#/components/schemas/NumberingSequenceReset' timezone: type: string description: IANA timezone used to determine the active period; defaults to UTC default: UTC example: America/Winnipeg GetNumberingSequencesResponse: type: object required: - numberingSequences properties: next: type: string description: Next page of results token numberingSequences: type: array description: List of numbering sequences items: $ref: '#/components/schemas/NumberingSequence' GetNumberingSequenceResponse: type: object required: - numberingSequence properties: numberingSequence: $ref: '#/components/schemas/NumberingSequence' UpdateConfigurationRequest: type: object properties: branding: $ref: '#/components/schemas/BrandingConfig' chatGptApiKey: type: string description: ChatGPT Api Key maxContentLengthBytes: type: string description: Set Maximum Document Content Length in Bytes maxDocuments: type: string description: Set Maximum number of Documents allowed maxWebhooks: type: string description: Set Maximum number of Webhooks allowed notificationEmail: type: string format: email deprecated: true description: Deprecated. Use notification.email instead. Email address to use for SES notifications. notification: $ref: '#/components/schemas/NotificationConfig' document: $ref: '#/components/schemas/DocumentConfig' ocr: $ref: '#/components/schemas/OcrConfig' google: $ref: '#/components/schemas/GoogleConfig' docusign: $ref: '#/components/schemas/DocusignConfig' UpdateConfigurationResponse: type: object properties: message: type: string description: Result message NotificationConfig: type: object properties: email: type: string format: email description: Email address to use as the From address for notifications provider: $ref: '#/components/schemas/NotificationEmailProvider' smtp: $ref: '#/components/schemas/NotificationEmailSmtpConfig' NotificationEmailProvider: type: string default: SES enum: - SES - SMTP NotificationEmailSmtpConfig: required: - host - port - connectionSecurity - credentialsSecretArn type: object properties: host: type: string description: SMTP server hostname port: type: integer format: int32 minimum: 1 maximum: 65535 description: SMTP server port connectionSecurity: $ref: '#/components/schemas/NotificationEmailSmtpConnectionSecurity' credentialsSecretArn: type: string description: 'AWS Secrets Manager ARN for a secret whose value is a JSON object containing non-empty string properties named "username" and "password", for example: {"username":"smtp-user@example.com","password":"smtp-password"}.' NotificationEmailSmtpConnectionSecurity: type: string enum: - STARTTLS - IMPLICIT_TLS AddNotificationTestRequest: type: object required: - to properties: to: type: string format: email description: Recipient of the test email AddNotificationTestResponse: type: object required: - message properties: message: type: string description: Queueing result DocumentConfig: type: object properties: contentTypes: $ref: '#/components/schemas/DocumentConfigContentTypes' retentionAndDisposition: $ref: '#/components/schemas/DocumentConfigRetentionAndDisposition' DocumentConfigContentTypes: type: object properties: allowlist: type: array items: type: string description: Allowed MIME types example: - application/pdf - image/png - image/jpeg denylist: type: array items: type: string description: Disallowed MIME types example: - application/x-msdownload - application/x-sh DocumentConfigRetentionAndDisposition: type: object properties: dispositionAction: $ref: '#/components/schemas/DocumentConfigDispositionAction' softDeleteRetentionInDays: type: integer format: int32 default: -1 minimum: -1 description: Number of days to retain soft deleted documents before permanent deletion. Use -1 to retain soft deleted documents until trash is cleared manually. DocumentConfigDispositionAction: type: string default: SOFT_DELETE enum: - SOFT_DELETE - DELETE GetConfigurationResponse: type: object properties: branding: $ref: '#/components/schemas/BrandingConfig' chatGptApiKey: type: string description: ChatGPT API Key maxContentLengthBytes: type: string description: Set Maximum Document Content Length in Bytes maxDocuments: type: string description: Set Maximum number of Documents allowed maxWebhooks: type: string description: Set Maximum number of Webhooks allowed notificationEmail: type: string format: email deprecated: true description: Deprecated. Use notification.email instead. Email address to use for SES notifications. notification: $ref: '#/components/schemas/NotificationConfig' document: $ref: '#/components/schemas/DocumentConfig' ocr: $ref: '#/components/schemas/OcrConfig' google: $ref: '#/components/schemas/GoogleConfig' docusign: $ref: '#/components/schemas/DocusignConfig' GoogleConfig: type: object properties: workloadIdentityAudience: type: string description: Workload Identity Audience workloadIdentityServiceAccount: type: string description: Workload Service Account DocusignConfig: type: object properties: environment: $ref: '#/components/schemas/DocusignEnvironment' userId: type: string description: Docusign UserId integrationKey: type: string description: Docusign Integration Key or ClientId rsaPrivateKey: type: string description: Docusign Rsa Private Key hmacSignature: type: string description: Optional HMAC secret used to validate Docusign Connect event notifications. When configured, callbacks must include a matching Docusign HMAC signature. When omitted or empty, callbacks are processed without HMAC validation, including when connectUrl is configured. connectUrl: type: string format: uri description: Public HTTPS URL that receives Docusign Connect event notifications. May be configured with or without hmacSignature. AddDelegationTokenRequest: type: object required: - permissions - reason properties: permissions: type: array description: Permissions to keep while the delegation token is applied. These must be a subset of the caller's current permissions for the site and cannot include ADMIN. items: $ref: '#/components/schemas/DelegationTokenPermission' onBehalfOf: $ref: '#/components/schemas/DelegationTokenPrincipal' reason: type: string description: Reason the delegation token is being generated. Stored in the signed token for audit/support traceability. minLength: 1 maxLength: 1024 DelegationTokenPermission: type: string enum: - READ - WRITE - DELETE - GOVERN DelegationTokenPrincipal: type: object description: User identity to store in the signed delegation token. required: - username properties: username: type: string description: Username to use for activity/audit attribution when the delegation token is applied. minLength: 1 maxLength: 256 AddDelegationTokenResponse: type: object properties: headerName: type: string example: x-formkiq-delegation-token delegationToken: type: string description: Signed token to send in the x-formkiq-delegation-token request header. SystemConfigurationWebUi: type: object required: - ssoLoginRedirectEnabled properties: ssoAutomaticSignIn: type: boolean description: Enable SSO automatic sign in BrandingConfig: type: object description: Branding configuration that can be set globally or for an individual site. properties: theme: type: string description: Branding theme identifier. GetSystemConfigurationResponse: type: object properties: branding: $ref: '#/components/schemas/BrandingConfig' webui: $ref: '#/components/schemas/SystemConfigurationWebUi' UpdateSystemConfigurationRequest: type: object properties: branding: $ref: '#/components/schemas/BrandingConfig' webui: $ref: '#/components/schemas/SystemConfigurationWebUi' AddSystemInferenceModelAgreementRequest: type: object required: - modelId properties: modelId: type: string description: Bedrock model identifier example: amazon.nova-2-lite-v1:0 GetSystemInferenceModelsResponse: type: object properties: inferenceModels: type: array description: List of system inference models items: $ref: '#/components/schemas/SystemInferenceModel' SystemInferenceModel: type: object properties: name: type: string example: Amazon Nova 2 Lite defaultModelId: type: string example: amazon.nova-2-lite-v1:0 modelLifecycleStatus: type: string description: Bedrock foundation model lifecycle status. ACTIVE means the model version is available; LEGACY means the model version is deprecated. nullable: true agreementAvailability: type: string example: AVAILABLE authorizationStatus: type: string example: AUTHORIZED entitlementAvailability: type: string example: AVAILABLE regionAvailability: type: string example: AVAILABLE modelInvocations: type: array items: $ref: '#/components/schemas/SystemInferenceModelInvocation' SystemInferenceModelInvocation: type: object required: - modelId - invocationType properties: modelId: type: string example: amazon.nova-2-lite-v1:0 invocationType: type: string example: DIRECT inferenceProfileType: type: string example: GEO geo: type: string example: US GetUserNotificationsResponse: type: object properties: next: type: string description: Next page of results token notifications: type: array description: List of notifications where the authenticated user's email is a CC or BCC recipient items: $ref: '#/components/schemas/UserNotification' UserNotification: description: A document notification associated with the authenticated user's email address type: object properties: documentId: type: string description: Document identifier artifactId: type: string description: Document artifact identifier notification: $ref: '#/components/schemas/DocumentNotification' GetVersionResponse: type: object properties: version: type: string description: FormKiQ version type: type: string description: FormKiQ type appEnvironment: type: string description: FormKiQ App Environment modules: type: array description: List of installed modules items: type: string AddWebhookRequest: required: - name type: object properties: name: type: string description: Name of webhook ttl: type: string description: Webhook time to live (expiry in seconds) enabled: type: string description: Is webhook enabled tags: type: array description: List of document tags items: $ref: '#/components/schemas/AddDocumentTag' AddWebhookTagRequest: type: object properties: value: type: string description: Tag value values: type: array description: Tag values items: type: string description: Tag value key: type: string description: Tag key DocumentId: required: - documentId type: object properties: documentId: type: string description: Document Identifier siteId: type: string description: Site Identifier AddWebhookResponse: type: object properties: webhookId: type: string siteId: type: string description: Site Identifier GetWebhooksResponse: type: object properties: next: type: string description: Next page of results token webhooks: type: array description: List of webhooks items: $ref: '#/components/schemas/GetWebhookResponse' GetWebhookResponse: type: object properties: siteId: type: string description: Site Identifier name: type: string description: Webhook name url: type: string description: Webhook url insertedDate: type: string description: Inserted Timestamp webhookId: type: string description: Webhook Identifier userId: type: string description: User who added document enabled: type: string description: Is webhook enabled ttl: type: string description: Webhook time to live (expiry in seconds) GetWebhookTagsResponse: type: object properties: next: type: string description: Next page of results token previous: type: string description: Previous page of results token tags: type: array description: List of webhook tags items: $ref: '#/components/schemas/WebhookTag' WebhookTag: required: - key - value type: object properties: insertedDate: type: string description: Inserted Timestamp webhookId: type: string description: Webhook Identifier type: type: string description: Tag type userId: type: string description: User who added document value: type: string description: Tag value key: type: string description: Tag key GetWorkflowsResponse: type: object properties: next: type: string description: Next page of results token workflows: type: array description: List of workflows items: $ref: '#/components/schemas/WorkflowSummary' WorkflowSummary: type: object required: - workflowId properties: name: type: string description: Name of Workflow workflowId: type: string description: Workflow identifier description: type: string description: Description of Workflow insertedDate: type: string description: Inserted Timestamp userId: type: string description: User who created workflow inUse: type: boolean description: Whether the Workflow is in use status: $ref: '#/components/schemas/WorkflowStatus' WorkflowStatus: type: string description: Status of the Workflow enum: - ACTIVE - INACTIVE AddWorkflowRequest: type: object required: - name - status - steps properties: name: description: Workflow name type: string description: description: Workflow description type: string status: $ref: '#/components/schemas/WorkflowStatus' steps: type: array description: Workflow Steps items: $ref: '#/components/schemas/AddWorkflowStep' AddWorkflowStep: type: object properties: stepId: description: Workflow Step Identifier type: string description: description: Workflow Step description type: string action: $ref: '#/components/schemas/AddAction' queue: $ref: '#/components/schemas/AddWorkflowStepQueue' mappings: type: array items: $ref: '#/components/schemas/WorkflowStepMapping' decision: $ref: '#/components/schemas/WorkflowStepDecision' decisions: type: array deprecated: true description: Deprecated; use 'decision' instead items: $ref: '#/components/schemas/AddWorkflowStepDecision' WorkflowStepMapping: type: object required: - mappingId properties: mappingId: type: string description: Mapping Identifier AddWorkflowStepQueue: type: object required: - queueId properties: queueId: type: string description: Queue Identifier approvalGroups: items: type: string WorkflowStepDecision: type: object properties: conditions: type: array description: Workflow Step Conditions items: $ref: '#/components/schemas/WorkflowStepCondition' defaultTransition: $ref: '#/components/schemas/WorkflowStepTransition' WorkflowStepCondition: required: - transition type: object properties: all: type: array description: Workflow Step Condition Criteria items: $ref: '#/components/schemas/WorkflowStepConditionCriterion' any: type: array description: Workflow Step Condition Criteria items: $ref: '#/components/schemas/WorkflowStepConditionCriterion' transition: $ref: '#/components/schemas/WorkflowStepTransition' AddWorkflowStepDecision: required: - type - nextStepId type: object properties: type: $ref: '#/components/schemas/WorkflowStepDecisionType' nextStepId: type: string description: Workflow Step to move to WorkflowStepConditionOperator: type: string description: | Comparison operator used to evaluate a workflow condition criterion. Values: - `EQ` - Equals - `NEQ` - Not equals - `CONTAINS` - Contains substring or matching value - `NOT_CONTAINS` - Does not contain substring or matching value - `STARTS_WITH` - Starts with value - `ENDS_WITH` - Ends with value - `GT` - Greater than - `GTE` - Greater than or equal - `LT` - Less than - `LTE` - Less than or equal - `EXISTS` - Field exists - `NOT_EXISTS` - Field does not exist - `IN` - Matches one of the provided values - `NOT_IN` - Does not match any of the provided values - `IS_EMPTY` - Source value is empty - `IS_NOT_EMPTY` - Source value is not empty enum: - EQ - NEQ - CONTAINS - NOT_CONTAINS - STARTS_WITH - ENDS_WITH - GT - GTE - LT - LTE - EXISTS - NOT_EXISTS - IN - NOT_IN - IS_EMPTY - IS_NOT_EMPTY WorkflowStepConditionCriterion: type: object required: - source - operator description: | A single criterion used to evaluate whether a workflow condition matches. A criterion compares a document-derived source value against one or more provided values using the specified operator. Supported sources include: - document attributes - document attribute value comparisons - document content type - document path Typical examples: - attribute `status` equals `approved` - attribute `amount` greater than `1000` - attribute `invoiceTotal` equals attribute `approvedTotal` - attribute `invoiceTotal` equals the sum of attribute `lineItemAmount` - content type equals `application/pdf` - path contains `/invoices/` Use the appropriate typed value field for the comparison: - `stringValue` for string comparisons - `numberValue` for numeric comparisons - `booleanValue` for boolean comparisons - `stringValues` for multi-value comparisons such as `IN` and `NOT_IN` Literal value fields should be omitted when `source` is an attribute value comparison. properties: source: $ref: '#/components/schemas/WorkflowStepConditionSource' operator: $ref: '#/components/schemas/WorkflowStepConditionOperator' stringValue: type: string description: String comparison value numberValue: type: number description: Numeric comparison value booleanValue: type: boolean description: Boolean comparison value stringValues: type: array description: String values used for IN or NOT_IN comparisons items: type: string WorkflowStepConditionSource: description: | Defines the document-derived source value to evaluate for a workflow condition criterion. The source identifies where the value comes from before applying the operator. Supported sources include: - a document attribute identified by `attributeKey` - a comparison between a document attribute value and another attribute-derived value - the document content type - the document path oneOf: - $ref: '#/components/schemas/WorkflowStepConditionDocumentAttribute' - $ref: '#/components/schemas/WorkflowStepConditionAttributeValueComparison' - $ref: '#/components/schemas/WorkflowStepConditionDocumentStandardMetadata' WorkflowStepConditionDocumentAttribute: type: object required: - attributeKey description: | Uses a document attribute as the source value for a workflow condition criterion. The attribute is selected using `attributeKey`. properties: attributeKey: type: string description: Document attribute key WorkflowStepConditionAttributeValueComparison: type: object required: - sourceType - valueAttributeKey - comparison description: | Compares the value of one document attribute to another attribute-derived value on the same document. The criterion operator is evaluated as: document.attribute[valueAttributeKey] OP comparison Literal comparison value fields are not used with this source. properties: sourceType: $ref: '#/components/schemas/WorkflowStepConditionAttributeValueComparisonSourceType' valueAttributeKey: type: string description: Document attribute key containing the value to compare. comparison: $ref: '#/components/schemas/WorkflowStepConditionAttributeValueComparisonTarget' WorkflowStepConditionAttributeValueComparisonSourceType: type: string description: Identifies this source as an attribute-value comparison. enum: - DOCUMENT_ATTRIBUTE_VALUE_COMPARISON WorkflowStepConditionAttributeValueComparisonTarget: description: | Defines the right-side comparison value for an attribute value comparison. oneOf: - $ref: '#/components/schemas/WorkflowStepConditionAttributeValueComparisonAttribute' - $ref: '#/components/schemas/WorkflowStepConditionAttributeValueComparisonAggregate' WorkflowStepConditionAttributeValueComparisonAttribute: type: object additionalProperties: false required: - attributeKey description: | Uses another document attribute value as the right-side comparison value. properties: attributeKey: type: string description: Document attribute key containing the comparison value. WorkflowStepConditionAttributeValueComparisonAggregate: type: object additionalProperties: false required: - attributeKey - aggregateType description: | Uses an aggregate over another document attribute's values as the right-side comparison value. properties: attributeKey: type: string description: Document attribute key whose values are aggregated for comparison. aggregateType: $ref: '#/components/schemas/WorkflowStepConditionAttributeAggregateType' WorkflowStepConditionAttributeAggregateType: type: string description: | Aggregate operation applied to document attribute values. Values: - `FIRST` - First value for the attribute - `LAST` - Last value for the attribute - `SUM` - Sum of numeric values for the attribute - `MIN` - Minimum numeric value for the attribute - `MAX` - Maximum numeric value for the attribute - `COUNT` - Count of values for the attribute enum: - FIRST - LAST - SUM - MIN - MAX - COUNT WorkflowStepConditionDocumentStandardMetadata: type: string description: | Identifies the built-in document metadata field to evaluate for a workflow condition criterion. Values: - `PATH` - Evaluate the document path - `CONTENT_TYPE` - Evaluate the document content type enum: - PATH - CONTENT_TYPE WorkflowStepTransition: type: object required: - type properties: type: $ref: '#/components/schemas/WorkflowStepTransitionType' stepId: type: string description: Target workflow step WorkflowStepTransitionType: type: string description: | Defines the outcome of a workflow step transition. A transition determines what happens after a workflow step finishes evaluating its conditions, decisions, or actions. Depending on the transition type, the workflow may: - Move to another workflow step - Complete successfully - Be rejected - Be cancelled - Remain on the current step Some transition types require additional properties. For example, when the type is `STEP`, a target step identifier must be provided in the transition object. enum: - STEP - RETRY - COMPLETE WorkflowStepDecisionType: type: string description: Type of Workflow Step Decision enum: - APPROVE - REJECT AddWorkflowResponse: type: object properties: workflowId: type: string description: Workflow Identifier GetWorkflowResponse: type: object properties: name: description: Workflow name type: string description: description: Workflow description type: string inUse: type: boolean description: Whether the Workflow is in use status: $ref: '#/components/schemas/WorkflowStatus' steps: description: Workflow steps items: $ref: '#/components/schemas/WorkflowStep' WorkflowStep: type: object properties: stepId: type: string description: Workflow Step Identifier description: type: string description: Workflow Step description action: $ref: '#/components/schemas/DocumentAction' queue: $ref: '#/components/schemas/WorkflowQueue' mappings: type: array items: $ref: '#/components/schemas/WorkflowStepMapping' decision: $ref: '#/components/schemas/WorkflowStepDecision' decisions: type: array description: Workflow Decisions items: $ref: '#/components/schemas/WorkflowStepDecisions' WorkflowQueue: type: object properties: queueId: type: string description: Queue Id approvalGroups: items: type: string WorkflowStepDecisions: type: object properties: type: $ref: '#/components/schemas/WorkflowStepDecisionType' nextStepId: type: string description: Workflow Step to move to SetWorkflowRequest: type: object required: - name - status - steps properties: name: description: Workflow name type: string description: description: Workflow description type: string status: $ref: '#/components/schemas/WorkflowStatus' steps: type: array description: Workflow Steps items: $ref: '#/components/schemas/AddWorkflowStep' UpdateWorkflowRequest: type: object properties: name: description: Workflow name type: string description: description: Workflow description type: string status: $ref: '#/components/schemas/WorkflowStatus' GetWorkflowDocumentsResponse: type: object properties: next: type: string description: Next page of results token documents: type: array description: List of workflow documents items: $ref: '#/components/schemas/Document' securitySchemes: ApiAuthorization: flows: {} type: oauth2 x-amazon-apigateway-authorizer: identitySource: $request.header.Authorization jwtConfiguration: audience: - Fn::Sub: ${CognitoUserPoolClient} issuer: Fn::Sub: https://cognito-idp.${AWS::Region}.amazonaws.com/${CognitoUserPool} type: jwt x-amazon-apigateway-integrations: lambdaApi200: uri: Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${DocumentsApiRequestsArn}/invocations responses: default: statusCode: "200" responseParameters: method.response.header.Access-Control-Allow-Methods: '''*''' method.response.header.Access-Control-Allow-Headers: '''Content-Type,X-Amz-Date,Authorization,X-Api-Key,x-formkiq-delegation-token''' method.response.header.Access-Control-Allow-Origin: '''*''' passthroughBehavior: when_no_templates httpMethod: POST type: aws_proxy payloadFormatVersion: "1.0" ocrLambdaApi200: uri: Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${DocumentsApiRequestsArn}/invocations responses: default: statusCode: "200" responseParameters: method.response.header.Access-Control-Allow-Methods: '''*''' method.response.header.Access-Control-Allow-Headers: '''Content-Type,X-Amz-Date,Authorization,X-Api-Key,x-formkiq-delegation-token''' method.response.header.Access-Control-Allow-Origin: '''*''' passthroughBehavior: when_no_templates httpMethod: POST type: aws_proxy payloadFormatVersion: "1.0" antivirusLambdaApi200: uri: Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${DocumentsApiRequestsArn}/invocations responses: default: statusCode: "200" responseParameters: method.response.header.Access-Control-Allow-Methods: '''*''' method.response.header.Access-Control-Allow-Headers: '''Content-Type,X-Amz-Date,Authorization,X-Api-Key,x-formkiq-delegation-token''' method.response.header.Access-Control-Allow-Origin: '''*''' passthroughBehavior: when_no_templates httpMethod: POST type: aws_proxy payloadFormatVersion: "1.0" searchLambdaApi200: uri: Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${DocumentsApiRequestsArn}/invocations responses: default: statusCode: "200" responseParameters: method.response.header.Access-Control-Allow-Methods: '''*''' method.response.header.Access-Control-Allow-Headers: '''Content-Type,X-Amz-Date,Authorization,X-Api-Key,x-formkiq-delegation-token''' method.response.header.Access-Control-Allow-Origin: '''*''' passthroughBehavior: when_no_templates httpMethod: POST type: aws_proxy payloadFormatVersion: "1.0" fulltextLambdaApi200: uri: Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${DocumentsApiRequestsArn}/invocations responses: default: statusCode: "200" responseParameters: method.response.header.Access-Control-Allow-Methods: '''*''' method.response.header.Access-Control-Allow-Headers: '''Content-Type,X-Amz-Date,Authorization,X-Api-Key,x-formkiq-delegation-token''' method.response.header.Access-Control-Allow-Origin: '''*''' passthroughBehavior: when_no_templates httpMethod: POST type: aws_proxy payloadFormatVersion: "1.0" ocrObjectsLambdaApi200: uri: Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${OcrApiRequestsArn}/invocations responses: default: statusCode: "200" responseParameters: method.response.header.Access-Control-Allow-Methods: '''*''' method.response.header.Access-Control-Allow-Headers: '''Content-Type,X-Amz-Date,Authorization,X-Api-Key,x-formkiq-delegation-token''' method.response.header.Access-Control-Allow-Origin: '''*''' passthroughBehavior: when_no_templates httpMethod: POST type: aws_proxy payloadFormatVersion: "1.0" esignatureLambdaApi200: uri: Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${DocumentsApiRequestsArn}/invocations responses: default: statusCode: "200" responseParameters: method.response.header.Access-Control-Allow-Methods: '''*''' method.response.header.Access-Control-Allow-Headers: '''Content-Type,X-Amz-Date,Authorization,X-Api-Key,x-formkiq-delegation-token''' method.response.header.Access-Control-Allow-Origin: '''*''' passthroughBehavior: when_no_templates httpMethod: POST type: aws_proxy payloadFormatVersion: "1.0" googleLambdaApi201: uri: Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${DocumentsApiRequestsArn}/invocations responses: default: statusCode: "201" responseParameters: method.response.header.Access-Control-Allow-Methods: '''*''' method.response.header.Access-Control-Allow-Headers: '''Content-Type,X-Amz-Date,Authorization,X-Api-Key,x-formkiq-delegation-token''' method.response.header.Access-Control-Allow-Origin: '''*''' passthroughBehavior: when_no_templates httpMethod: POST type: aws_proxy payloadFormatVersion: "1.0" documentSignatureLambdaApi: uri: Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${DocumentsApiRequestsArn}/invocations responses: default: statusCode: "201" responseParameters: method.response.header.Access-Control-Allow-Methods: '''*''' method.response.header.Access-Control-Allow-Headers: '''Content-Type,X-Amz-Date,Authorization,X-Api-Key,x-formkiq-delegation-token''' method.response.header.Access-Control-Allow-Origin: '''*''' passthroughBehavior: when_no_templates httpMethod: POST type: aws_proxy payloadFormatVersion: "1.0" documentGenerationLambdaApi201: uri: Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${DocumentsApiRequestsArn}/invocations responses: default: statusCode: "201" responseParameters: method.response.header.Access-Control-Allow-Methods: '''*''' method.response.header.Access-Control-Allow-Headers: '''Content-Type,X-Amz-Date,Authorization,X-Api-Key,x-formkiq-delegation-token''' method.response.header.Access-Control-Allow-Origin: '''*''' passthroughBehavior: when_no_templates httpMethod: POST type: aws_proxy payloadFormatVersion: "1.0" dataClassificationLambdaApi200: uri: Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${DocumentsApiRequestsArn}/invocations responses: default: statusCode: "200" responseParameters: method.response.header.Access-Control-Allow-Methods: '''*''' method.response.header.Access-Control-Allow-Headers: '''Content-Type,X-Amz-Date,Authorization,X-Api-Key,x-formkiq-delegation-token''' method.response.header.Access-Control-Allow-Origin: '''*''' passthroughBehavior: when_no_templates httpMethod: POST type: aws_proxy payloadFormatVersion: "1.0" lambdaApi201: uri: Fn::Sub: arn:${AWS::Partition}:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${DocumentsApiRequestsArn}/invocations responses: default: statusCode: "201" responseParameters: method.response.header.Access-Control-Allow-Headers: '''Content-Type,X-Amz-Date,Authorization,X-Api-Key,x-formkiq-delegation-token''' method.response.header.Access-Control-Allow-Methods: '''*''' method.response.header.Access-Control-Allow-Origin: '''*''' passthroughBehavior: WHEN_NO_TEMPLATES httpMethod: POST type: aws_proxy payloadFormatVersion: "1.0" x-amazon-apigateway-gateway-responses: UNAUTHORIZED: statusCode: 401 responseParameters: gatewayresponse.header.Access-Control-Allow-Methods: '''*''' gatewayresponse.header.Access-Control-Allow-Origin: '''*''' gatewayresponse.header.Access-Control-Allow-Headers: '''Content-Type,X-Amz-Date,Authorization,X-Api-Key,x-formkiq-delegation-token''' x-amazon-apigateway-cors: allowOrigins: - '*' maxAge: 3600 allowMethods: - '*' allowHeaders: - '*'