Jump to

• Request
• Response

Retrieve a Task Attachment by Name

get

/ic/api/process/v1/tasks/{id}/attachments/{attachmentName}

Retrieves an attachment by name.

NOTE:

Whether a process application uses documents or attachments depends on the application configuration.

• If Oracle Content and Experience(documents) is enabled, the application can only use documents, and API operations on attachments do not apply.
• If Oracle Content and Experience(documents) is not enabled, the application can only use attachments, and API operations on documents do not apply.

To identify whether Oracle Content and Experience(documents) is enabled in a process application, use the API /ic/api/process/v1/processes/{processId} to retrieve process instance details. Oracle Content and Experience(documents) is enabled when the parameter isDoCSEnabled=true.

Request

Path Parameters

• attachmentName: string
  Attachment name
• id: string
  Task Number

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : Attachment

Type: object

Show Source

• content(optional): object InputStream
• contentBytes(optional): array contentBytes
• contentID(optional): string
• mimeType(optional): string
• name(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "mimeType":{
            "type":"string"
        },
        "content":{
            "$ref":"#/definitions/InputStream"
        },
        "contentBytes":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"byte"
            }
        },
        "contentID":{
            "type":"string"
        }
    }
}

Nested Schema : InputStream

Type: object

Nested Schema : contentBytes

Type: array

Show Source

• Array of: string(byte)

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

400 Response

Bad Request.

401 Response

Unauthorized

404 Response

Attachment with given name not found

500 Response

Internal Server Error

Back to Top