Jump to

• Request
• Response
• Examples

Update Lineitem(s) Associated with a Specified Task

put

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

Updates the line item specified by the line item ID associated with the taskid. The actions which can be performed on 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
• taskid: string
  Task ID

Body ()

Action to be taken on the LineItem

Root Schema : BulkLineItemRequestPayLoad

Type: object

Show Source

• LineItems(optional): array LineItems

{
    "properties":{
        "LineItems":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BulkInstanceLineItemRequestPayLoad"
            }
        }
    }
}

Nested Schema : LineItems

Type: array

Show Source

• Array of: object BulkInstanceLineItemRequestPayLoad

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

Nested Schema : BulkInstanceLineItemRequestPayLoad

Type: object

Show Source

• action(optional): string
• comment(optional): string
• LineItemId(optional): string
• requestId(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "LineItemId":{
            "type":"string"
        },
        "action":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        }
    }
}

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 : BulkLineItemReponsePayLoad

Type: object

Show Source

• LineItems(optional): array LineItems

{
    "properties":{
        "LineItems":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BulkInstanceLineItemResponsePayLoad"
            }
        }
    }
}

Nested Schema : LineItems

Type: array

Show Source

• Array of: object BulkInstanceLineItemResponsePayLoad

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

Nested Schema : BulkInstanceLineItemResponsePayLoad

Type: object

Show Source

• action(optional): string
• LineItemId(optional): string
• requestId(optional): string
• status(optional): string

{
    "properties":{
        "requestId":{
            "type":"string"
        },
        "LineItemId":{
            "type":"string"
        },
        "action":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Back to Top

Examples

This example demonstrates the ability to update multiple task line items. 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

Example of PUT Request Body

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

{
  "lineItems": [
    {
      "requestId": "1011",
      "lineItemId": "930",
      "action": "ResetStatus",
      "comments": "test ResetStatus"
    },
    {
      "requestId": "1012",
      "lineItemId": "930",
      "action": "EditComment",
      "comments": "test EditComment"
    },
    {
      "requestId": "1013",
      "lineItemId": "930",
      "action": "UnDelegate",
      "comments": "test UnDelegate"
    }
  ]
}

Example of Response Body

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

{
    "links": [
        {
            "rel": "self",
            "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/certifications/21/tasks/e
1d5e5dd-5f9e-4747-bd5f-e00dc0b99d58/lineitems"
        }
    ],
    "lineItems": [
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/certifications/21/tasks/e
1d5e5dd-5f9e-4747-bd5f-e00dc0b99d58/lineitems/21"
                }
            ],
            "action": "ResetStatus",
            "requestId": "1011",
            "lineItemId": "21",
            "status": "SUCCESS"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/certifications/21/tasks/e
1d5e5dd-5f9e-4747-bd5f-e00dc0b99d58/lineitems/21"
                }
            ],
            "action": "EditComment",
            "requestId": "1012",
            "lineItemId": "21",
            "status": "SUCCESS"
        },
        {
            "links": [
                {
                    "rel": "self",
                    "href": "http://pseudo.com:PORT/iam/governance/selfservice/api/v1/certifications/21/tasks/e
1d5e5dd-5f9e-4747-bd5f-e00dc0b99d58/lineitems/21"
                }
            ],
            "action": "UnDelegate",
            "requestId": "1013",
            "lineItemId": "21",
            "status": "SUCCESS"
        }
    ]
}

Back to Top