Jump to

• Request
• Response
• Examples

Update an expense attendee record for an expense identifier

patch

/fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseAttendee/{ExpenseAttendeeId}

Request

Path Parameters

• ExpenseAttendeeId(required): integer(int64)
  Value that uniquely identifies the event attendee.
• expensesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Expenses resource and used to uniquely identify an instance of Expenses. The client should not generate the hash key value. Instead, the client should query on the Expenses collection resource in order to navigate to a specific instance of Expenses to get the hash key.

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 ()

Root Schema : schema

Type: object

Show Source

• Amount: number
  Title: Amount

  Amount spent on the event attendee.
• AttendeeEmail: string
  Email address of the attendee.
• AttendeePhoneNumber: string
  Phone number of the attendee.
• AttendeeType: string
  Title: Attendee Type

  Maximum Length: 30

  Type of event attendee. Possible values are EMPLOYEE and NONEMPLOYEE.
• EmployeeFlag: boolean
  Maximum Length: 1

  Indicates whether an event attendee is an employee.
• EmployerAddress: string
  Title: Employer Address

  Maximum Length: 240

  Employer address of the event attendee.
• EmployerName: string
  Title: Employer

  Maximum Length: 240

  Employer name of the event attendee.
• EmployerPartyId: integer (int64)
  Value that uniquely identifies an employer.
• ExpenseAttendeeId: integer (int64)
  Value that uniquely identifies the event attendee.
• ExpenseId: integer (int64)
  Value that uniquely identifies an expense item.
• Name: string
  Title: Name

  Maximum Length: 240

  Name of the employee or nonemployee event attendee.
• TaxIdentifier: string
  Maximum Length: 30

  Tax identifier of the employee or nonemployee event attendee.
• Title: string
  Title: Title

  Maximum Length: 80

  Title of the employee or nonemployee event attendee.

{
    "type":"object",
    "properties":{
        "ExpenseId":{
            "type":"integer",
            "description":"Value that uniquely identifies an expense item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount spent on the event attendee.",
            "nullable":true
        },
        "TaxIdentifier":{
            "maxLength":"30",
            "type":"string",
            "description":"Tax identifier of the employee or nonemployee event attendee.",
            "nullable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":"80",
            "type":"string",
            "description":"Title of the employee or nonemployee event attendee.",
            "nullable":true
        },
        "ExpenseAttendeeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the event attendee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "AttendeeEmail":{
            "type":"string",
            "description":"Email address of the attendee.",
            "nullable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the employee or nonemployee event attendee.",
            "nullable":true
        },
        "AttendeeType":{
            "title":"Attendee Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of event attendee. Possible values are EMPLOYEE and NONEMPLOYEE.",
            "nullable":true
        },
        "EmployerAddress":{
            "title":"Employer Address",
            "maxLength":"240",
            "type":"string",
            "description":"Employer address of the event attendee.",
            "nullable":true
        },
        "EmployerPartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies an employer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "EmployeeFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an event attendee is an employee.",
            "nullable":true
        },
        "EmployerName":{
            "title":"Employer",
            "maxLength":"240",
            "type":"string",
            "description":"Employer name of the event attendee.",
            "nullable":true
        },
        "AttendeePhoneNumber":{
            "type":"string",
            "description":"Phone number of the attendee.",
            "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:
  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 : expenses-ExpenseAttendee-item-response

Type: object

Show Source

• Amount: number
  Title: Amount

  Amount spent on the event attendee.
• AttendeeEmail: string
  Email address of the attendee.
• AttendeePhoneNumber: string
  Phone number of the attendee.
• AttendeeType: string
  Title: Attendee Type

  Maximum Length: 30

  Type of event attendee. Possible values are EMPLOYEE and NONEMPLOYEE.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the row.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the record was created.
• EmployeeFlag: boolean
  Maximum Length: 1

  Indicates whether an event attendee is an employee.
• EmployerAddress: string
  Title: Employer Address

  Maximum Length: 240

  Employer address of the event attendee.
• EmployerName: string
  Title: Employer

  Maximum Length: 240

  Employer name of the event attendee.
• EmployerPartyId: integer (int64)
  Value that uniquely identifies an employer.
• ExpenseAttendeeId: integer (int64)
  Value that uniquely identifies the event attendee.
• ExpenseId: integer (int64)
  Value that uniquely identifies an expense item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the row.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Session login associated with the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 240

  Name of the employee or nonemployee event attendee.
• TaxIdentifier: string
  Maximum Length: 30

  Tax identifier of the employee or nonemployee event attendee.
• Title: string
  Title: Title

  Maximum Length: 80

  Title of the employee or nonemployee event attendee.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpenseId":{
            "type":"integer",
            "description":"Value that uniquely identifies an expense item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount spent on the event attendee.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxIdentifier":{
            "maxLength":"30",
            "type":"string",
            "description":"Tax identifier of the employee or nonemployee event attendee.",
            "nullable":true,
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":"80",
            "type":"string",
            "description":"Title of the employee or nonemployee event attendee.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpenseAttendeeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the event attendee.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AttendeeEmail":{
            "type":"string",
            "description":"Email address of the attendee.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the employee or nonemployee event attendee.",
            "nullable":true,
            "x-queryable":true
        },
        "AttendeeType":{
            "title":"Attendee Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of event attendee. Possible values are EMPLOYEE and NONEMPLOYEE.",
            "nullable":true,
            "x-queryable":true
        },
        "EmployerAddress":{
            "title":"Employer Address",
            "maxLength":"240",
            "type":"string",
            "description":"Employer address of the event attendee.",
            "nullable":true,
            "x-queryable":true
        },
        "EmployerPartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies an employer.",
            "format":"int64",
            "nullable":true,
            "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"
            }
        },
        "EmployeeFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an event attendee is an employee.",
            "nullable":true,
            "x-queryable":true
        },
        "EmployerName":{
            "title":"Employer",
            "maxLength":"240",
            "type":"string",
            "description":"Employer name of the event attendee.",
            "nullable":true,
            "x-queryable":true
        },
        "AttendeePhoneNumber":{
            "type":"string",
            "description":"Phone number of the attendee.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Session login associated with the user who last updated the row.",
            "nullable":false,
            "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

Examples

The following example shows how to update an expense attendee record for an expense by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenses/300100185936902/child/ExpenseAttendee/300100185936904

Example Request Payload

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

{
	"Name":"Robert James",
	"EmployeeFlag":"Y",
	"Amount":80,
	"AttendeeEmail": "[e-mail]"
}

Example Response Body

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

{
    "Amount": 80,
    "AttendeeType": "EMPLOYEE",
    "CreatedBy": "FINUSER1",
    "CreationDate": "2020-06-18T07:48:22.310+00:00",
    "EmployeeFlag": true,
    "EmployerAddress": null,
    "EmployerName": null,
    "EmployerPartyId": null,
    "ExpenseAttendeeId": 300100185936904,
    "ExpenseId": 300100185936902,
    "LastUpdateDate": "2020-06-18T10:23:46.098+00:00",
    "LastUpdateLogin": "A84BE0FBF0E104BCE053D713F50A0BED",
    "LastUpdatedBy": "FINUSER1",
    "Name": "Robert James",
    "TaxIdentifier": null,
    "Title": null,
    "AttendeeEmail": "[e-mail]",
    "AttendeePhoneNumber": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenses/300100185936902/child/ExpenseAttendee/300100185936904",
            "name": "ExpenseAttendee",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenses/300100185936902/child/ExpenseAttendee/300100185936904",
            "name": "ExpenseAttendee",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenses/300100185936902",
            "name": "expenses",
            "kind": "item"
        }
    ]
}

Back to Top