Jump to

• Request
• Response

Update a delegate's history information

patch

/fscmRestApi/resources/11.13.18.05/publicSectorDelegates/{DelegateHeaderId}/child/DelegateHistory/{DelegateHistoryId}

Request

Path Parameters

• DelegateHeaderId(required): integer(int64)
  The unique identifier of a delegation.
• DelegateHistoryId(required): integer(int64)
  The unique identifier for a delegation history record.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• AttributeChanged: string
  Maximum Length: 30

  The attribute that was changed. The value is ORA_DSTATUS for a change in delegation status.
• ChangeAction: string
  Maximum Length: 30

  The action that created the change. Valid values are ACCEPTED and DECLINED.
• ChangeDate: string (date-time)
  The date and time when a change was made to a delegation???s status.
• DelegateDetailId: integer (int64)
  The delegation detail ID from the delegation detail table.
• DelegateHeaderId: integer (int64)
  The Delegation Header ID from the Delegation Header table.
• NewValue: string
  Maximum Length: 30

  The new value of the attribute that was changed.
• PreviousValue: string
  Maximum Length: 30

  The previous value for the attribute that was changed.
• StatusUpdatedByGuid: string
  Maximum Length: 64

  The user GUID of the user whose action changed the status.

{
    "type":"object",
    "properties":{
        "ChangeAction":{
            "maxLength":30,
            "type":"string",
            "description":"The action that created the change. Valid values are ACCEPTED and DECLINED.",
            "nullable":true
        },
        "StatusUpdatedByGuid":{
            "maxLength":64,
            "type":"string",
            "description":"The user GUID of the user whose action changed the status.",
            "nullable":false
        },
        "DelegateHeaderId":{
            "type":"integer",
            "description":"The Delegation Header ID from the Delegation Header table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ChangeDate":{
            "type":"string",
            "description":"The date and time when a change was made to a delegation???s status.",
            "format":"date-time",
            "nullable":false
        },
        "NewValue":{
            "maxLength":30,
            "type":"string",
            "description":"The new value of the attribute that was changed.",
            "nullable":true
        },
        "DelegateDetailId":{
            "type":"integer",
            "description":"The delegation detail ID from the delegation detail table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AttributeChanged":{
            "maxLength":30,
            "type":"string",
            "description":"The attribute that was changed. The value is ORA_DSTATUS for a change in delegation status.",
            "nullable":false
        },
        "PreviousValue":{
            "maxLength":30,
            "type":"string",
            "description":"The previous value for the attribute that was changed.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorDelegates-DelegateHistory-item-response

Type: object

Show Source

• AttributeChanged: string
  Maximum Length: 30

  The attribute that was changed. The value is ORA_DSTATUS for a change in delegation status.
• ChangeAction: string
  Maximum Length: 30

  The action that created the change. Valid values are ACCEPTED and DECLINED.
• ChangeDate: string (date-time)
  The date and time when a change was made to a delegation???s status.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who initiated a delegation change request.
• CreationDate: string (date-time)
  Read Only: true

  The date and time that the delegation was created.
• DelegateDetailId: integer (int64)
  The delegation detail ID from the delegation detail table.
• DelegateHeaderId: integer (int64)
  The Delegation Header ID from the Delegation Header table.
• DelegateHistoryId: integer (int64)
  The unique identifier for a delegation history record.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time that the delegation was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the transaction delegation information.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The session login associated with the user who last updated delegation information.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NewValue: string
  Maximum Length: 30

  The new value of the attribute that was changed.
• PreviousValue: string
  Maximum Length: 30

  The previous value for the attribute that was changed.
• StatusUpdatedByGuid: string
  Maximum Length: 64

  The user GUID of the user whose action changed the status.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the transaction delegation information.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DelegateHistoryId":{
            "type":"integer",
            "description":"The unique identifier for a delegation history record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the delegation was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who initiated a delegation change request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeAction":{
            "maxLength":30,
            "type":"string",
            "description":"The action that created the change. Valid values are ACCEPTED and DECLINED.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusUpdatedByGuid":{
            "maxLength":64,
            "type":"string",
            "description":"The user GUID of the user whose action changed the status.",
            "nullable":false,
            "x-queryable":true
        },
        "ChangeDate":{
            "type":"string",
            "description":"The date and time when a change was made to a delegation???s status.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "DelegateDetailId":{
            "type":"integer",
            "description":"The delegation detail ID from the delegation detail table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreviousValue":{
            "maxLength":30,
            "type":"string",
            "description":"The previous value for the attribute that was changed.",
            "nullable":true,
            "x-queryable":true
        },
        "DelegateHeaderId":{
            "type":"integer",
            "description":"The Delegation Header ID from the Delegation Header table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NewValue":{
            "maxLength":30,
            "type":"string",
            "description":"The new value of the attribute that was changed.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChanged":{
            "maxLength":30,
            "type":"string",
            "description":"The attribute that was changed. The value is ORA_DSTATUS for a change in delegation status.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time that the delegation was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session login associated with the user who last updated delegation information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top