Jump to

• Request
• Response

Retrieve Task History

get

/ic/api/process/v1/tasks/{id}/history

Retrieves the history of a task.

Request

Path Parameters

• id: string
  Task Number

Query Parameters

• displayStyle: string
  Style in which to display the history of given Task Number - flatList (default)

  Default Value: flatList

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : taskHistories

Type: object

Show Source

• levels(optional): integer(int32)
• links(optional): array links
• taskHistory(optional): array taskHistory
• title(optional): string

{
    "type":"object",
    "properties":{
        "levels":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "links":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"links"
                },
                "$ref":"#/definitions/Link"
            }
        },
        "title":{
            "type":"string"
        },
        "taskHistory":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TaskHistory"
            }
        }
    },
    "xml":{
        "name":"taskHistories",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "xml":{
            "name":"links"
        },
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : taskHistory

Type: array

Show Source

• Array of: object taskHistory

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TaskHistory"
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• mediaType(optional): string
• rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

Nested Schema : taskHistory

Type: object

Show Source

• actionName(optional): string
• displayName(optional): string
• pattern(optional): string
• reason(optional): string
• updatedDate(optional): string
• userId(optional): string

{
    "type":"object",
    "properties":{
        "actionName":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "userId":{
            "type":"string"
        },
        "pattern":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        }
    },
    "xml":{
        "name":"taskHistory",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

400 Response

Bad request

401 Response

Unauthorized

404 Response

Task History not found

500 Response

Internal Server Error

Back to Top