Jump to

• Request
• Response

Update a delegate's information

patch

/fscmRestApi/resources/11.13.18.05/publicSectorDelegateNotifications/{DelegateHeaderId}

Request

Path Parameters

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

Header Parameters

• Metadata-Context: string
  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: string
  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 ()

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : publicSectorDelegateNotifications-item-response

Type: object

Show Source

• DelegateEmail: string
  Title: Delegate Email

  Read Only: true

  The email of a delegate user.
• DelegateFirstName: string
  Title: Delegate First Name

  Read Only: true

  The first name of a delegate user.
• DelegateHeaderId: integer (int64)
  The unique identifier of a delegation record.
• DelegateLastName: string
  Title: Delegate Last Name

  Read Only: true

  The last name of a delegate user.
• DelegatePhone: string
  Title: Delegate Phone

  Read Only: true

  The phone number of a delegate user.
• DelegateType: string
  Title: Delegation Type

  Read Only: true

  The delegation type. The value ORA_PROFILE indicates that the delegation is for all transactions of a profile. The value ORA_TRANSACTION indicates that the delegation is for individual transactions.
• DelegateUsername: string
  Title: Delegate User Name

  Read Only: true

  The user name that a delegate uses to sign into the system.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrivilegeType: string
  Title: Privilege Type

  Read Only: true

  The privilege type. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.
• ProfileName: string
  Title: Profile Name

  Read Only: true

  Profile or transaction owner's account profile name.
• ProfileType: string
  Title: Profile Type

  Read Only: true

  The profile type of the profile owner's profile. It can be of type Personal or Business.
• PTOEmail: string
  Title: Profile or Transaction Owner Email

  Read Only: true

  Email of the profile or transaction owner.
• PTOFirstName: string
  Title: Profile or Transaction Owner First Name

  Read Only: true

  The first name of the profile or transaction owner.
• PTOLastName: string
  Title: Profile or Transaction Owner Last Name

  Read Only: true

  The last name of the profile or transaction owner.
• PTOPhone: string
  Title: Profile or Transaction Owner Phone

  Read Only: true

  The phone number of the profile or transaction owner.
• PTOUsername: string
  Title: Profile or Transaction Owner User Name

  Read Only: true

  The user name of the profile or transaction owner.

{
    "type":"object",
    "properties":{
        "ProfileType":{
            "title":"Profile Type",
            "type":"string",
            "description":"The profile type of the profile owner's profile. It can be of type Personal or Business.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PTOFirstName":{
            "title":"Profile or Transaction Owner First Name",
            "type":"string",
            "description":"The first name of the profile or transaction owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PTOLastName":{
            "title":"Profile or Transaction Owner Last Name",
            "type":"string",
            "description":"The last name of the profile or transaction owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelegateUsername":{
            "title":"Delegate User Name",
            "type":"string",
            "description":"The user name that a delegate uses to sign into the system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PTOEmail":{
            "title":"Profile or Transaction Owner Email",
            "type":"string",
            "description":"Email of the profile or transaction owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelegateEmail":{
            "title":"Delegate Email",
            "type":"string",
            "description":"The email of a delegate user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProfileName":{
            "title":"Profile Name",
            "type":"string",
            "description":"Profile or transaction owner's account profile name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelegateFirstName":{
            "title":"Delegate First Name",
            "type":"string",
            "description":"The first name of a delegate user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelegatePhone":{
            "title":"Delegate Phone",
            "type":"string",
            "description":"The phone number of a delegate user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PTOUsername":{
            "title":"Profile or Transaction Owner User Name",
            "type":"string",
            "description":"The user name of the profile or transaction owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelegateLastName":{
            "title":"Delegate Last Name",
            "type":"string",
            "description":"The last name of a delegate user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PTOPhone":{
            "title":"Profile or Transaction Owner Phone",
            "type":"string",
            "description":"The phone number of the profile or transaction owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelegateHeaderId":{
            "type":"integer",
            "description":"The unique identifier of a delegation record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DelegateType":{
            "title":"Delegation Type",
            "type":"string",
            "description":"The delegation type. The value ORA_PROFILE indicates that the delegation is for all transactions of a profile. The value ORA_TRANSACTION indicates that the delegation is for individual transactions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrivilegeType":{
            "title":"Privilege Type",
            "type":"string",
            "description":"The privilege type. ORA_MANAGE indicates that the delegate can manage transactions. ORA_VIEWONLY indicates that the delegate has read-only access to transactions.",
            "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