Jump to

• Request
• Response

Get a delegate's information

get

/fscmRestApi/resources/11.13.18.05/publicSectorDelegateInvitationNotifications/{DelegateHeaderId}

Request

Path Parameters

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : publicSectorDelegateInvitationNotifications-item-response

Type: object

Show Source

• AcceptLink: string
  Title: Accept Link

  Read Only: true

  The URL for the link that a user clicks to accept a delegation invitation.
• AcceptLinkLabel: string
  Title: Accept

  Read Only: true

  Label for the link that a user clicks to accept a delegation invitation.
• DeclineLink: string
  Title: Decline Link

  Read Only: true

  The URL for the link that a user clicks to decline a delegation invitation.
• DeclineLinkLabel: string
  Title: Decline

  Read Only: true

  Label for the link that a user clicks to decline a delegation invitation.
• 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.
• 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

  The 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.
• RegisterLink: string
  Title: Register Link

  Read Only: true

  The URL for the link that a user clicks to access the public user registration page.
• RegisterLinkLabel: string
  Title: Register

  Read Only: true

  Label for the link to the page for public user registration.

{
    "type":"object",
    "properties":{
        "RegisterLink":{
            "title":"Register Link",
            "type":"string",
            "description":"The URL for the link that a user clicks to access the public user registration page.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "DeclineLinkLabel":{
            "title":"Decline",
            "type":"string",
            "description":"Label for the link that a user clicks to decline a delegation invitation.",
            "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
        },
        "AcceptLink":{
            "title":"Accept Link",
            "type":"string",
            "description":"The URL for the link that a user clicks to accept a delegation invitation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProfileName":{
            "title":"Profile Name",
            "type":"string",
            "description":"The 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
        },
        "AcceptLinkLabel":{
            "title":"Accept",
            "type":"string",
            "description":"Label for the link that a user clicks to accept a delegation invitation.",
            "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
        },
        "DeclineLink":{
            "title":"Decline Link",
            "type":"string",
            "description":"The URL for the link that a user clicks to decline a delegation invitation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelegateHeaderId":{
            "type":"integer",
            "description":"The unique identifier of a delegation.",
            "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
        },
        "RegisterLinkLabel":{
            "title":"Register",
            "type":"string",
            "description":"Label for the link to the page for public user registration.",
            "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