Jump to

• Request
• Response
• Examples

Update Lineitems Associated with Specified Task

put

/iam/governance/selfservice/api/v1/certifications/{certid}/tasks/{taskid}/lineitems/{lineitemid}

Updates the line item specified by the line item ID associated with the taskid . The updates actions which can be done to the line items are, claim, revoke, abstain, complete, sign-off, edit comment, Reset Status.

Request

Supported Media Types

• application/json

Path Parameters

• certid: string
  Certification ID
• lineitemid: string
  LineItem ID
• taskid: string
  Task ID

Body ()

Action to be taken on the LineItem

Root Schema : SingleLineItemRequestPayLoad

Type: object

Show Source

• lineItem(optional): object LineItemRequestPayLoad
• lineItemDetails(optional): array lineItemDetails

{
    "properties":{
        "lineItem":{
            "$ref":"#/definitions/LineItemRequestPayLoad"
        },
        "lineItemDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LineItemDetailRequestPayLoad"
            }
        }
    }
}

Nested Schema : LineItemRequestPayLoad

Type: object

Show Source

• action(optional): string
• fields(optional): array fields

{
    "properties":{
        "action":{
            "type":"string"
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PutCertificationsTasksByTaskIdResponseField"
            }
        }
    }
}

Nested Schema : lineItemDetails

Type: array

Show Source

• Array of: object LineItemDetailRequestPayLoad

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

Nested Schema : fields

Type: array

Show Source

• Array of: object PutCertificationsTasksByTaskIdResponseField

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

Nested Schema : PutCertificationsTasksByTaskIdResponseField

Type: object

Show Source

• field(optional): string

{
    "properties":{
        "field":{
            "type":"string"
        }
    }
}

Nested Schema : LineItemDetailRequestPayLoad

Type: object

Show Source

• action(optional): string
• entityId(optional): string
• entityType(optional): string
• fields(optional): array fields

{
    "properties":{
        "entityId":{
            "type":"string"
        },
        "entityType":{
            "type":"string"
        },
        "action":{
            "type":"string"
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PutCertificationsTasksByTaskIdResponseField"
            }
        }
    }
}

Nested Schema : fields

Type: array

Show Source

• Array of: object PutCertificationsTasksByTaskIdResponseField

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful

Headers

• ResponseTime: string
  Captures the time in milliseconds taken for processing the request.

Body ()

Root Schema : SingleLineItemResponsePayLoad

Type: object

Show Source

• lineItem(optional): object LineItemResponsePayLoad
• lineItemDetails(optional): array lineItemDetails
• links(optional): array links
• status(optional): string

{
    "properties":{
        "status":{
            "type":"string"
        },
        "lineItem":{
            "$ref":"#/definitions/LineItemResponsePayLoad"
        },
        "lineItemDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LineItemDetailResponsePayLoad"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : LineItemResponsePayLoad

Type: object

Show Source

• action(optional): string
• lineItemId(optional): string
• status(optional): string

{
    "properties":{
        "action":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "lineItemId":{
            "type":"string"
        }
    }
}

Nested Schema : lineItemDetails

Type: array

Show Source

• Array of: object LineItemDetailResponsePayLoad

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

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

Nested Schema : LineItemDetailResponsePayLoad

Type: object

Show Source

• action(optional): string
• entityId(optional): string
• entityType(optional): string
• status(optional): string

{
    "properties":{
        "entityId":{
            "type":"string"
        },
        "entityType":{
            "type":"string"
        },
        "action":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

Nested Schema : LinkDataInstances

Type: object

Show Source

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

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

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Default Response

Unexpected error

Back to Top

Examples

This example demonstrates the ability to update a single line item associated with a certification task. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

curl  -H "Content-Type: application/json"  -H "X-Requested-By: <anyvalue>"  -X PUT  -u 
username:password  -d @put.json 
https://pseudo.com/iam/governance/selfservice/api/v1/certifications/21/tasks/e1d5e5dd-5f9e-4747
-bd5f-e00dc0b99d58/lineitems/21"

Example of PUT Request Body

The following example shows the contents of the request body in JSON format.

{
    "lineItem": {
        "action": "Claim",
        "fields": [
                    {
                      "name": "comment",
                      "value": "test Claim"
                    }
                  ]
    }
}

Example of PUT Response Body

The following example shows the contents of the response body in JSON format.

{
    "links": [
        {
            "rel": "self",
            "href": "https://pseudo.com/iam/governance/selfservice/api/v1/certifications/21/tasks/e1d5e5dd-5f9e-
4747-bd5f-e00dc0b99d58/lineitems/21"
        }
    ],
    "lineItem": {
        "action": "Claim",
        "status": "SUCCESS",
        "lineItemId": "21"
    }
}

Back to Top