{ "openapi": "3.0.0", "info": { "title": "Project Management APIs" }, "security": [], "tags": [ { "name": "Version / Deploy", "description": "API for Version and Deploy" }, { "name": "Project", "description": "API for project" }, { "name": "Credentials", "description": "API for credentials" } ], "paths": { "/adp/designer/api/cd/v1/project/{projectId}/{branchId}/summary": { "get": { "tags": [ "Project" ], "summary": "Get project information", "description": "You can send a GET request to retrieve the summary information of current project.", "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/branchId" }, { "$ref": "#/components/parameters/Referer" } ], "responses": { "200": { "$ref": "#/components/responses/status_sucRes200" }, "400": { "$ref": "#/components/responses/status_ErrRes400" } } } }, "/adp/designer/api/cd/v1/project/{projectId}/{branchId}/bootstrap": { "post": { "tags": [ "Project" ], "summary": "Bootstrap the project", "description": "Bootstrap the project and return the info for UI project loading, the backend content analyzer project id (caProjectId) can be found in the response.", "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/branchId" }, { "$ref": "#/components/parameters/Referer" } ], "responses": { "200": { "description": "Request was successful.", "content": { "application/json": { "schema": { "type": "object", "properties": { "caProjectId": { "type": "string", "example": "6b2daab4-3642-4190-8819-8850862536db" }, "caProjectStatus": { "type": "string", "example": "ready" }, "isODEnabled": { "type": "boolean", "example": true }, "enabledFeatures": { "type": "array", "example": [ "standalone", "runtimedoc" ] }, "isNewProject": { "type": "boolean", "example": false }, "isWDUDeployed": { "type": "boolean", "example": true }, "projectTitle": { "type": "string", "example": "Test" }, "timeSinceImportInSeconds": { "type": "number", "example": 606997 } } } } } }, "400": { "$ref": "#/components/responses/status_ErrRes400" } } } }, "/adp/designer/api/cd/v1/project/{projectId}/{branchId}/config": { "get": { "tags": [ "Project" ], "summary": "Retrieve language settings", "description": "Retrieve language settings for CA extraction model and locate for display name language", "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/branchId" }, { "$ref": "#/components/parameters/Referer" } ], "responses": { "200": { "description": "Request was successful.", "content": { "application/json": { "schema": { "type": "object", "properties": { "caConfig": { "type": "object", "properties": { "language": { "type": "array", "example": [ "en" ] }, "features": { "type": "object", "properties": { "handwritingDetection": { "type": "boolean", "example": false }, "idCardDetection": { "type": "boolean", "example": false }, "gpuForAiInference": { "type": "boolean", "example": false }, "useOCREngine1": { "type": "boolean", "example": true }, "useOCREngine2": { "type": "boolean", "example": false } } } } } } } } } }, "400": { "$ref": "#/components/responses/status_ErrRes400" } } }, "put": { "tags": [ "Project" ], "summary": "Update language settings", "description": "Update language settings for CA extraction model and update display name language", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "projectConfig": { "type": "object", "properties": { "locale": { "type": "string", "example": "en" } } }, "caConfig": { "type": "object", "properties": { "language": { "type": "array", "example": [ "en" ] }, "features": { "type": "object", "properties": { "handwritingDetection": { "type": "boolean", "example": false }, "idCardDetection": { "type": "boolean", "example": false }, "gpuForAiInference": { "type": "boolean", "example": false }, "useOCREngine1": { "type": "boolean", "example": true }, "useOCREngine2": { "type": "boolean", "example": false } } } } } } } } } }, "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/branchId" }, { "$ref": "#/components/parameters/Referer" } ], "responses": { "200": { "description": "Request was successful.", "content": { "application/json": { "schema": { "type": "object", "properties": { "caConfig": { "type": "object", "properties": { "language": { "type": "array", "example": [ "en" ] }, "features": { "type": "object", "properties": { "handwritingDetection": { "type": "boolean", "example": false }, "idCardDetection": { "type": "boolean", "example": false }, "gpuForAiInference": { "type": "boolean", "example": false }, "useOCREngine1": { "type": "boolean", "example": true }, "useOCREngine2": { "type": "boolean", "example": false } } } } } } } } } }, "400": { "$ref": "#/components/responses/status_ErrRes400" } } } }, "/adp/designer/api/cd/{projectId}/{branchId}/commonDataDefinitions": { "get": { "tags": [ "Project" ], "summary": "Get the data definition", "description": "Use to retrieve all data definitions", "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/branchId" }, { "$ref": "#/components/parameters/Referer" } ], "responses": { "200": { "description": "Request was successful.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "status": { "type": "int", "example": 200 }, "data": { "type": "array", "items": { "type": "object", "properties": { "$ref": { "type": "string", "example": "DD_050adf28-c663-48dc-89ea-7dc32d68f572_AccountNumber.json" }, "title": { "type": "string", "example": "Account Number" }, "$id": { "type": "string", "example": "AccountNumber" }, "uuid": { "type": "string", "example": "050adf28-c663-48dc-89ea-7dc32d68f572" }, "namespace": { "type": "string", "example": "UIA" }, "type": { "type": "string", "example": "string" } } } } } } } } }, "400": { "$ref": "#/components/responses/status_ErrRes400" } } } }, "/adp/designer/api/cd/{projectId}/{branchId}/contentDefinitions": { "get": { "tags": [ "Project" ], "summary": "Get the content definition", "description": "Use to retrieve all content definitions", "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/branchId" }, { "$ref": "#/components/parameters/Referer" } ], "responses": { "200": { "description": "Request was successful.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "status": { "type": "int", "example": 200 }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "UtilityBill" }, "definition": { "type": "object", "properties": { "$schema": { "type": "string", "example": "http://json-schema.org/schema#" }, "$id": { "type": "string", "example": "http://www.ibm.com/dba/projects/UIA/CD_UtilityBill.json" }, "title": { "type": "string", "example": "UIA Document Type Definitions" }, "lastUpdatDate": { "type": "string", "example": null }, "lastUpdate": { "type": "string", "example": null }, "comment": { "type": "string", "example": "This is a Doc Type Definition showing some different property types" }, "baForDeployment": { "type": "boolean", "example": false }, "definitions": { "type": "object", "properties": { "UtilityBill": { "type": "object", "properties": { "$id": { "type": "string", "example": null }, "title": { "type": "string", "example": "Utility Bill" }, "allOf": { "type": "array", "items": { "type": "object", "properties": { "$ref": { "type": "string", "example": "http://www.ibm.com/dba/schemas/#systemDocument" } } } } } } } } } } } } } } } } } }, "400": { "$ref": "#/components/responses/status_ErrRes400" } } } }, "/adp/designer/api/cd/{projectId}/{branchId}/contentDefinitions/{docTypeId}": { "get": { "tags": [ "Project" ], "summary": "Get the content definition of doc type", "description": "Get the content definition of doc type", "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/branchId" }, { "$ref": "#/components/parameters/docTypeId" }, { "$ref": "#/components/parameters/Referer" } ], "responses": { "200": { "description": "Request was successful.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "status": { "type": "int", "example": 200 }, "data": { "type": "object", "properties": { "$schema": { "type": "string", "example": "http://json-schema.org/schema#" }, "$id": { "type": "string", "example": "http://www.ibm.com/dba/projects/UIA/CD_UtilityBill.json" }, "title": { "type": "string", "example": "UIA Document Type Definitions" }, "lastUpdatDate": { "type": "string", "example": null }, "lastUpdate": { "type": "string", "example": null }, "comment": { "type": "string", "example": "This is a Doc Type Definition showing some different property types" }, "baForDeployment": { "type": "boolean", "example": false }, "definitions": { "type": "object", "properties": { "UtilityBill": { "type": "object", "properties": { "$id": { "type": "string", "example": null }, "title": { "type": "string", "example": "Utility Bill" }, "allOf": { "type": "array", "items": { "type": "object", "properties": { "$ref": { "type": "string", "example": "http://www.ibm.com/dba/schemas/#systemDocument" } } } } } } } } } } } } } } }, "400": { "$ref": "#/components/responses/status_ErrRes400" } } } }, "/adp/designer/api/cd/{projectId}/{branchId}/dataDefinitions/{docTypeId}/{fieldId}?required={required}": { "post": { "tags": [ "Project" ], "summary": "Create a new data definition.", "description": "Create a new data definition for the field(specified by fieldId) of docucment type(specified docTypeId) for data standardization.", "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/branchId" }, { "$ref": "#/components/parameters/docTypeId" }, { "$ref": "#/components/parameters/fieldId" }, { "$ref": "#/components/parameters/required" }, { "$ref": "#/components/parameters/Referer" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "$schema": { "type": "string", "example": "http://json-schema.org/schema#" }, "$id": { "type": "string", "example": "http://www.ibm.com/dba/projects/UIA/DataDefinitions_AccountNumber.json" }, "description": { "type": "string", "example": "This is a data definition." }, "namespace": { "type": "string", "example": "UIA" }, "definitions": { "type": "object", "properties": { "AccountNumber": { "type": "object", "properties": { "$id": { "type": "string", "example": "#AccountNumber" }, "title": { "type": "string", "example": "Account Number" }, "type": { "type": "array", "items": { "type": "string", "example": "string" } }, "maxLength": { "type": "int", "example": 64 }, "default": { "type": "string", "example": null } } } } } } } } } }, "responses": { "201": { "description": "Request was successful.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "status": { "type": "int", "example": 201 }, "message": { "type": "string", "example": "Data Definition successfully created" }, "data": { "type": "object", "properties": { "$schema": { "type": "string", "example": "http://json-schema.org/schema#" }, "$id": { "type": "string", "example": "http://www.ibm.com/dba/projects/UIA/DD_050adf28-c663-48dc-89ea-7dc32d68f572_AccountNumber.json" }, "uuid": { "type": "string", "example": "050adf28-c663-48dc-89ea-7dc32d68f572" }, "namespace": { "type": "string", "example": "UIA" }, "version": { "type": "string", "example": 1 }, "description": { "type": "string", "example": "This is a data definition." }, "definitions": { "type": "object", "properties": { "AccountNumber": { "type": "object", "properties": { "$id": { "type": "string", "example": "#AccountNumber" }, "title": { "type": "string", "example": "Account Number" }, "type": { "type": "array", "items": { "type": "string", "example": "string" } }, "maxLength": { "type": "int", "example": 64 }, "default": { "type": "string", "example": null } } } } } } } } } } } }, "400": { "$ref": "#/components/responses/status_ErrRes400" } } } }, "/adp/designer/api/cd/{projectId}/{branchId}/dataDefinitions/{docTypeId}/{fieldId}/define?required={required}": { "put": { "tags": [ "Project" ], "summary": "Map to an existing data definition.", "description": "Map to an existing data definition for the field(specified by fieldId) of docucment type(specified docTypeId) for data standardization.", "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/branchId" }, { "$ref": "#/components/parameters/docTypeId" }, { "$ref": "#/components/parameters/fieldId" }, { "$ref": "#/components/parameters/required" }, { "$ref": "#/components/parameters/Referer" } ], "requestBody": { "required": true, "description": "Refer to the $id and uuid in the response of the Get commonDataDefinitions", "content": { "application/json": { "schema": { "type": "object", "properties": { "$schema": { "type": "string", "example": "http://json-schema.org/schema#" }, "$id": { "type": "string", "example": "http://www.ibm.com/dba/projects/UIA/DD_050adf28-c663-48dc-89ea-7dc32d68f572_AccountNumber.json" }, "uuid": { "type": "string", "example": "050adf28-c663-48dc-89ea-7dc32d68f572" }, "namespace": { "type": "string", "example": "UIA" }, "version": { "type": "string", "example": 1 }, "description": { "type": "string", "example": "This is a existing data definition." }, "definitions": { "type": "object", "properties": { "AccountNumber": { "type": "object", "properties": { "$id": { "type": "string", "example": "#AccountNumber" }, "title": { "type": "string", "example": "Account Number" }, "type": { "type": "array", "items": { "type": "string", "example": "string" } }, "maxLength": { "type": "int", "example": 64 }, "default": { "type": "string", "example": null } } } } } } } } } }, "responses": { "200": { "description": "Request was successful.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "status": { "type": "int", "example": 200 }, "message": { "type": "string", "example": "Data Definition successfully updated" } } } } } }, "400": { "$ref": "#/components/responses/status_ErrRes400" } } } }, "/adp/designer/api/cd/v1/credentials": { "get": { "tags": [ "Credentials" ], "summary": "Get the credentials", "description": "Retrieve credentials from a repository.", "parameters": [ { "$ref": "#/components/parameters/Referer" } ], "responses": { "200": { "$ref": "#/components/responses/status_sucRes200" }, "400": { "$ref": "#/components/responses/status_ErrRes400" } } } }, "/adp/designer/api/cd/v1/credentials/test": { "post": { "tags": [ "Credentials" ], "summary": "Test the credentials", "description": "Test the validity of a credential by calling the endpoint of the repository service", "parameters": [ { "$ref": "#/components/parameters/Referer" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "api_url": { "type": "string", "example": "https://github.ibm.com/api/v3" }, "org_url": { "type": "string", "example": "https://github.ibm.com/ADP-skinned" }, "provider": { "type": "string", "example": "github" }, "secret": { "type": "string", "example": "REDACTED" }, "type": { "type": "string", "example": "token" }, "user_id": { "type": "string", "example": "chenyebj@cn.ibm.com" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/status_sucRes200" }, "400": { "$ref": "#/components/responses/status_ErrRes400" } } } }, "/adp/designer/api/cd/v1/project/{projectId}/{branchId}/deploy/summary": { "put": { "tags": [ "Version / Deploy" ], "summary": "Retrieve the deployment summary.", "description": "Use to etrieve the deployment summary.", "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/branchId" }, { "$ref": "#/components/parameters/Referer" } ], "responses": { "200": { "description": "Request was successful.", "content": { "application/json": { "schema": { "type": "object", "properties": { "commitDate": { "type": "string", "example": "2024-03-21T15:13:37.000Z" }, "deployRepos": { "type": "array", "items": { "type": "string", "example": "DEVOS1" } }, "snapshots": { "type": "array", "items": { "type": "object", "properties": { "snapshot": { "type": "string", "example": "v1-2024-03-12-0639" }, "date": { "type": "string", "example": "2024-03-12T06:39:20.000Z" }, "versionNotes": { "type": "string", "example": "Snapshot created by CEAdmin" } } } }, "deployInfo": { "type": "object", "properties": { "lastSnapshotName": { "type": "string", "example": "v4-2024-03-21-1035" }, "currentSnapshotName": { "type": "string", "example": "v4-2024-03-21-1035" }, "repositoryId": { "type": "string", "example": "DEVOS1" }, "date": { "type": "string", "example": "2024-03-21T02:47:57.912Z" }, "caRuntimeProjectId": { "type": "string", "example": "800876ea-24d7-4ee3-a0d0-5f2b92b5aa7a" }, "status": { "type": "string", "example": "Success" } } }, "snapshotInProgress": { "type": "boolean", "example": false }, "precheckReport": { "type": "object", "properties": { "current": { "type": "object", "properties": { "checkFailed": { "type": "boolean", "example": false }, "updatedDateTime": { "type": "string", "example": "2024-03-25T06:45:41.110Z" }, "systemPrecheck": { "type": "object", "properties": { "checkFailed": { "type": "boolean", "example": false }, "result": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "Success" } } } }, "data": { "type": "object", "properties": { "caConnectionState": { "type": "string", "example": "Success" }, "caProjectsAvailable": { "type": "int", "example": 6 }, "caProjectsDeleteState": { "type": "int", "example": 0 }, "caProjectsUsed": { "type": "int", "example": 4 }, "canDeploy": { "type": "boolean", "example": true }, "cpeConnectionState": { "type": "string", "example": "Success" }, "gitConnectionState": { "type": "string", "example": "Success" }, "umsTeamConnectionState": { "type": "string", "example": "Success" } } }, "status": { "type": "object", "properties": { "code": { "type": "int", "example": 200 }, "message": { "type": "string", "example": "Precheck of Content Project Deployment Service is successful." }, "messageId": { "type": "string", "example": "FNRDD0019I" } } } } }, "repositoryId": { "type": "string", "example": "DEVOS1" }, "snapshot": { "type": "string", "example": "v9-2024-03-21-2313" }, "projectPrecheck": { "type": "object", "properties": { "checkFailed": { "type": "boolean", "example": false }, "result": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "Success" } } } }, "data": { "type": "object", "properties": { "alerts": { "type": "array", "items": null }, "classes": { "type": "array", "items": null }, "isFirstDeploymentAnywhere": { "type": "boolean", "example": false }, "propertyTemplates": { "type": "array", "items": null } } } } } } }, "previous": { "type": "object", "properties": { "updatedDateTime": { "type": "string", "example": "2024-03-21T15:19:37.251Z" }, "systemPrecheck": { "type": "object", "properties": { "checkFailed": { "type": "boolean", "example": false }, "result": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "Success" } } } }, "data": { "type": "object", "properties": { "caConnectionState": { "type": "string", "example": "Success" }, "caProjectsAvailable": { "type": "int", "example": 6 }, "caProjectsDeleteState": { "type": "int", "example": 0 }, "caProjectsUsed": { "type": "int", "example": 4 }, "canDeploy": { "type": "boolean", "example": true }, "cpeConnectionState": { "type": "string", "example": "Success" }, "gitConnectionState": { "type": "string", "example": "Success" }, "umsTeamConnectionState": { "type": "string", "example": "Success" } } }, "status": { "type": "object", "properties": { "code": { "type": "int", "example": 200 }, "message": { "type": "string", "example": "Precheck of Content Project Deployment Service is successful." }, "messageId": { "type": "string", "example": "FNRDD0019I" } } } } }, "repositoryId": { "type": "string", "example": "DEVOS1" }, "snapshot": { "type": "string", "example": "v1-2024-03-18-0636" }, "checkFailed": { "type": "boolean", "example": false }, "projectPrecheck": { "type": "object", "properties": { "checkFailed": { "type": "boolean", "example": false }, "result": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "example": "Success" } } } } } } } } } } } } } } }, "400": { "$ref": "#/components/responses/status_ErrRes400" } } } }, "/adp/designer/api/cd/v1/project/{projectId}/{branchId}/deploy/snapshots": { "post": { "tags": [ "Version / Deploy" ], "summary": "Create snapshot", "description": "Use to create a snapshot", "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/branchId" }, { "$ref": "#/components/parameters/Referer" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "versionNotes": { "type": "string", "example": "note" } } } } } }, "responses": { "200": { "description": "Request was successful.", "content": { "application/json": { "schema": { "type": "object", "properties": { "snapshotName": { "type": "string", "example": "v1-2024-03-18-0636" }, "baVersionId": { "type": "string", "example": "a483e7df-55fd-4cdc-9301-70e3b8e9347f" }, "date": { "type": "string", "example": "2024-03-18T06:36:32.608Z" }, "status": { "type": "string", "example": "inProgress" } } } } } }, "400": { "$ref": "#/components/responses/status_ErrRes400" } } } }, "/adp/designer/api/cd/v1/project/{projectId}/{branchId}/deploy/snapshotRecord": { "get": { "tags": [ "Version / Deploy" ], "summary": "Get snapshot record", "description": "Use to get snapshot record", "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/branchId" }, { "$ref": "#/components/parameters/Referer" } ], "responses": { "200": { "description": "Request was successful.", "content": { "application/json": { "schema": { "type": "object", "properties": { "snapshotName": { "type": "string", "example": "v1-2024-03-18-0636" }, "baVersionId": { "type": "string", "example": "a483e7df-55fd-4cdc-9301-70e3b8e9347f" }, "date": { "type": "string", "example": "2024-03-18T06:36:32.608Z" }, "status": { "type": "string", "example": "inProgress" } } } } } }, "400": { "$ref": "#/components/responses/status_ErrRes400" } } } }, "/adp/designer/api/cd/v1/project/{projectId}/{branchId}/deploy/submit": { "post": { "tags": [ "Version / Deploy" ], "summary": "Submit deploy", "description": "Submit deploy", "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/branchId" }, { "$ref": "#/components/parameters/Referer" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "repositoryId": { "type": "string", "example": "DEVOS1" }, "snapshot": { "type": "string", "example": "v1-2024-03-18-0636" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/status_sucRes200" }, "400": { "$ref": "#/components/responses/status_ErrRes400" } } } }, "/adp/designer/api/cd/v1/project/{projectId}/{branchId}/deploy/deploymentPrecheck": { "post": { "tags": [ "Version / Deploy" ], "summary": "Deployment precheck", "description": "deployment Precheck", "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/branchId" }, { "$ref": "#/components/parameters/Referer" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "repositoryId": { "type": "string", "example": "DEVOS1" }, "snapshot": { "type": "string", "example": "v1-2024-03-18-0636" } } } } } }, "responses": { "200": { "$ref": "#/components/responses/status_sucRes200" }, "400": { "$ref": "#/components/responses/status_ErrRes400" } } } }, "/adp/designer/api/ca/v1/projects/{caProjectId}?assets={assets}": { "get": { "tags": [ "Project" ], "summary": "Export a project definition.", "description": "You can send a GET request to export a project definition.", "parameters": [ { "$ref": "#/components/parameters/caProjectId" }, { "$ref": "#/components/parameters/assets" }, { "$ref": "#/components/parameters/Referer" } ], "responses": { "200": { "description": "The project definition in zip format", "content": { "application/octet-stream": {} } } } } }, "/adp/designer/api/cd/v1/project/{projectId}/{branchId}/import?overwrite={overwrite}": { "post": { "tags": [ "Project" ], "summary": "Import a project definition.", "description": "You can send a POST request to import a project definition.", "parameters": [ { "$ref": "#/components/parameters/projectId" }, { "$ref": "#/components/parameters/branchId" }, { "$ref": "#/components/parameters/overwrite" }, { "$ref": "#/components/parameters/Referer" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "format": "binary", "description": "The project file(.zip) or ontology file(.json) to be imported." } } } } } }, "responses": { "200": { "description": "Request was successful.", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "example": true }, "importResult": { "type": "object", "properties": { "status": { "type": "object", "properties": { "code": { "type": "int", "example": 200 }, "messageId": { "type": "string", "example": "CIWCA50000" }, "message": { "type": "string", "example": "Success" } } }, "result": { "type": "object", "properties": { "overwrite": { "type": "boolean", "example": true }, "doc_types": { "type": "array", "items": { "type": "string", "example": "UtilityBill" } } } } } } } } } } }, "400": { "description": "Bad request.", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "object", "properties": { "code": { "type": "int", "example": 400 }, "messageId": { "type": "string", "example": "CIWCA13533" }, "message": { "type": "string", "example": "Failed to import project." } } }, "error": { "type": "object", "properties": { "errorId": { "type": "string", "example": "CIWCA13533" }, "explanation": { "type": "string", "example": "Failed to import project." }, "action": { "type": "string", "example": "Please contact admin or try again." } } } } } } } } } } } }, "components": { "parameters": { "projectId": { "in": "path", "name": "projectId", "description": "Content designer project ID.", "required": true, "schema": { "type": "string", "example": "UIA" } }, "caProjectId": { "in": "path", "name": "caProjectId", "description": "The backend content analyzer project ID. It can be found in the bootstrap endpoint's response.", "required": true, "schema": { "type": "string", "example": "dc41b94b-a973-4833-91f6-1efbed41e5dd" } }, "assets": { "in": "path", "name": "assets", "description": "The Document types, field types and enrichments are exported by default, you can also export the following additional assets.", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "models", "files" ] } }, "style": "form", "explode": false }, "branchId": { "in": "path", "name": "branchId", "description": "Document Processing Project branch ID.", "required": true, "schema": { "type": "string", "example": "master" } }, "overwrite": { "in": "path", "name": "overwrite", "description": "whether to overwrite existing project.", "required": false, "schema": { "type": "boolean", "example": true } }, "analyzerId": { "in": "path", "name": "analyzerId", "description": "Unique identifier for each analyzer. Get from POST /analyzers response.", "required": true, "schema": { "type": "string" } }, "docTypeId": { "in": "path", "name": "docTypeId", "description": "The symbolic name of the document type.", "required": true, "schema": { "type": "string", "example": "UtilityBill" } }, "fieldId": { "in": "path", "name": "fieldId", "description": "The symbolic name of the field.", "required": true, "schema": { "type": "string", "example": "AccountNumber" } }, "required": { "in": "query", "name": "required", "description": "whether it is required.", "required": false, "schema": { "type": "boolean", "example": false } }, "Referer": { "in": "header", "name": "Referer", "description": "Please set it to: https://cpd-aria-dev.apps.skinned.cp.fyre.ibm.com/adp/designer/ to avoid Cross-Site Request Forgery (CSRF) error when using the curl command or from an external application.", "required": true, "schema": { "type": "string", "example": "https://cpd-aria-dev.apps.skinned.cp.fyre.ibm.com/adp/designer/" } } }, "schemas": { "sucRes": { "type": "object", "properties": { "success": { "type": "boolean", "format": "boolean", "example": true }, "message": { "type": "string", "example": "Success" }, "messageId": { "type": "string", "example": "CIWCA50000" } } }, "statusErrRes": { "type": "object", "properties": { "status": { "type": "object", "properties": { "code": { "type": "integer", "example": 400 }, "message": { "type": "string", "example": "Bad Request" }, "messageId": { "type": "string", "example": "CIWCA40000" } } }, "error": { "type": "object", "properties": { "errorId": { "type": "string", "example": "CIWCA40000" }, "explanation": { "type": "string", "example": "Bad Request" }, "action": { "type": "string", "example": "contact administrator" } } } } }, "StatusResult": { "type": "object", "properties": { "status": { "type": "object", "properties": { "code": { "type": "integer", "example": 200 }, "message": { "type": "string", "example": "Success" }, "messageId": { "type": "string", "example": "CIWCA50000" } } } } }, "ErrorResult": { "type": "object", "properties": { "status": { "type": "object", "properties": { "code": { "type": "int", "example": 400 }, "messageId": { "type": "string", "example": "CIWCA13001" }, "message": { "type": "string", "example": "The project id is missing or invalid." } } }, "error": { "type": "object", "properties": { "errorId": { "type": "string", "example": "CIWCA13001" }, "explanation": { "type": "string", "example": "The project id is missing or invalid." }, "action": { "type": "string", "example": "Correct your project id and try again." } } } } }, "ErrorListResult": { "type": "object", "properties": { "success": { "type": "boolean", "example": false }, "error_list": { "type": "array", "items": { "type": "object", "properties": { "error_code": { "type": "string" }, "message": { "type": "string" } } } } } } }, "responses": { "status_sucRes200": { "description": "Content accepted for processing.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sucRes" } } } }, "status_ErrRes400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/statusErrRes" } } } }, "status_ValidatorResult200": { "description": "Request was successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidatorResult" } } } }, "status_ErrorResult400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "status_ErrorListResult400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorListResult" } } } }, "status_export_ontology_success_200": { "description": "Request was successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportOntologyResult" } } } } }, "links": {}, "callbacks": {} } }