Jump to

• Request
• Response

Retrieve a Task Attachment by Name

get

/bpm/api/4.0/tasks/{id}/attachments/{attachmentName}

Retrieves an attachment by name. If Oracle Content and Experience (documents) is enabled for this task, attachments do not apply.

Request

Path Parameters

• attachmentName(required): string
  Attachment name
• id(required): string
  Task ID

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : attachment

Type: object

Show Source

• attachmentName: string
• attachmentScope: string
• content: string
• docAttributes: array docAttributes
• href: string (uri)
• input: string
• mimeType: string
• rel: string
• uri: object link

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "format":"uri"
        },
        "rel":{
            "type":"string"
        },
        "attachmentName":{
            "type":"string"
        },
        "content":{
            "type":"string"
        },
        "mimeType":{
            "type":"string"
        },
        "attachmentScope":{
            "type":"string"
        },
        "docAttributes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/GenericMap"
            }
        },
        "input":{
            "type":"string"
        },
        "uri":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "xml":{
        "name":"attachment",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Nested Schema : docAttributes

Type: array

Show Source

• Array of: object genericMap

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/GenericMap"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string (uri)
  href of the provided link
• rel: string
  relationship with the returned resource

  Example: self

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"href of the provided link",
            "format":"uri"
        },
        "rel":{
            "type":"string",
            "description":"relationship with the returned resource",
            "example":"self"
        }
    },
    "xml":{
        "name":"link",
        "namespace":"http://xmlns.oracle.com/bpm/rest"
    }
}

Nested Schema : genericMap

Type: object

Show Source

• category: string
• dataType: string
• displayName: string
• name: string
• readOnly: string
• value: string

{
    "type":"object",
    "properties":{
        "dataType":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "readOnly":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "category":{
            "type":"string"
        }
    },
    "xml":{
        "name":"genericMap",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

400 Response

Bad Request.

401 Response

Unauthorized

404 Response

Attachment with given name not found

500 Response

Internal Server Error

Back to Top