Jump to

• Request
• Response

Upload Process Document to Storage

post

/process/api/v1/instances/{id}/documents/files/data

Uploads a process document to storage. Additionally, you can also upload an external link to the storage. You can upload either a document or an URL at a time. You cannot upload both the document and the URL at the same time.

Request

Path Parameters

• id(required): string
  Instance ID

Header Parameters

• oci-original-url(required):
  Endpoint requested by customer

Supported Media Types

• multipart/form-data

Request Body - multipart/form-data ()

Root Schema : schema

Type: object

Show Source

• documentLinkUrl: string
  Document link URL
• json: string
  Document Metadata
• upfile: string (binary)
  Document Content InputStream

{
    "type":"object",
    "properties":{
        "upfile":{
            "type":"string",
            "description":"Document Content InputStream",
            "format":"binary"
        },
        "json":{
            "type":"string",
            "description":"Document Metadata"
        },
        "documentLinkUrl":{
            "type":"string",
            "description":"Document link URL"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : Document

Type: object

Show Source

• contentType: string
• createdBy: User
• createdDate: string (date)
• description: string
• documentId: string
• documentName: string
• fileName: string
• href: string
• lastUpdatedBy: User
• lastUpdatedDate: string (date)
• parentFolderId: string
• permissions: array permissions
• url: string

{
    "type":"object",
    "properties":{
        "documentId":{
            "type":"string"
        },
        "parentFolderId":{
            "type":"string"
        },
        "documentName":{
            "type":"string"
        },
        "fileName":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "contentType":{
            "type":"string"
        },
        "createdBy":{
            "$ref":"#/components/schemas/User"
        },
        "createdDate":{
            "type":"string",
            "format":"date"
        },
        "lastUpdatedBy":{
            "$ref":"#/components/schemas/User"
        },
        "lastUpdatedDate":{
            "type":"string",
            "format":"date"
        },
        "permissions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "url":{
            "type":"string"
        }
    }
}

Nested Schema : User

Match All

Show Source

• object IdentityCommon

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdentityCommon"
        }
    ]
}

Nested Schema : permissions

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : IdentityCommon

Type: object

Show Source

• displayName: string
• id: string
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

Examples

Select an example Unauthorized error

500 Response

Internal server error

Body ()

Root Schema : ErrorMessage

Type: object

Title: ErrorMessage

Defines ErrorMessage

Show Source

• cause: string
• details: string
• errorCode(required): string
• message(required): string
• opcRequestId(required): string
• status(required): integer

{
    "title":"ErrorMessage",
    "description":"Defines ErrorMessage",
    "additionalProperties":false,
    "type":"object",
    "required":[
        "errorCode",
        "status",
        "message",
        "opcRequestId"
    ],
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "status":{
            "type":"integer"
        },
        "message":{
            "type":"string"
        },
        "details":{
            "type":"string"
        },
        "cause":{
            "type":"string"
        },
        "opcRequestId":{
            "type":"string"
        }
    }
}

Examples

Select an example Internal error

Back to Top