Jump to

• Request
• Response
• Examples

Update sponsor account details

patch

/fscmRestApi/resources/11.13.18.05/grantsSponsors/{SponsorId}/child/GrantsSponsorAccountDetails/{SponsorAccountDetailsId}

Request

Path Parameters

• SponsorAccountDetailsId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• SponsorId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

• Comments: string
  Maximum Length: 2000

  The comment about the sponsor account details.
• LetterOfCreditFlag: boolean
  Maximum Length: 1

  Indicates whether the sponsor billing is letter of credit.
• LetterOfCreditNumber: string
  Maximum Length: 240

  The unique number of the sponsor letter of credit.
• PrimaryFlag: boolean
  Maximum Length: 1

  Indicates whether the sponsor account is primary.
• RelatedSponsorAccountId: integer (int64)
  The unique identifier of the related sponsor account.
• RelatedSponsorAccountName: string
  Title: Account Description

  Maximum Length: 240

  The name of the related sponsor account.
• RelatedSponsorAccountNumber: string
  Title: Account Number

  Maximum Length: 30

  The unique number of the related sponsor account.
• RelatedSponsorId: integer (int64)
  The unique identifier of the related sponsor.
• RelatedSponsorName: string
  Maximum Length: 255

  The name of the related sponsor.
• RelatedSponsorNumber: string
  Maximum Length: 255

  The unique number of the related sponsor.
• SponsorAccountId: integer (int64)
  The unique identifier of the sponsor account.
• SponsorAccountName: string
  Title: Account Description

  Maximum Length: 240

  The name of the sponsor account.
• SponsorAccountNumber: string
  Title: Account Number

  Maximum Length: 30

  The unique number of the sponsor account.
• SponsorId: integer (int64)
  The unique identifier of the sponsor.
• SponsorName: string
  Maximum Length: 255

  The name of the sponsor.
• SponsorNumber: string
  Maximum Length: 255

  The unique number of the sponsor.

{
    "type":"object",
    "properties":{
        "RelatedSponsorName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the related sponsor.",
            "nullable":true
        },
        "PrimaryFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the sponsor account is primary.",
            "nullable":true
        },
        "RelatedSponsorId":{
            "type":"integer",
            "description":"The unique identifier of the related sponsor.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SponsorAccountName":{
            "title":"Account Description",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the sponsor account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Comments":{
            "maxLength":"2000",
            "type":"string",
            "description":"The comment about the sponsor account details.",
            "nullable":true
        },
        "LetterOfCreditFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the sponsor billing is letter of credit.",
            "nullable":true
        },
        "LetterOfCreditNumber":{
            "maxLength":"240",
            "type":"string",
            "description":"The unique number of the sponsor letter of credit.",
            "nullable":true
        },
        "RelatedSponsorNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique number of the related sponsor.",
            "nullable":true
        },
        "RelatedSponsorAccountId":{
            "type":"integer",
            "description":"The unique identifier of the related sponsor account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SponsorId":{
            "type":"integer",
            "description":"The unique identifier of the sponsor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SponsorName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the sponsor.",
            "nullable":true
        },
        "SponsorNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique number of the sponsor.",
            "nullable":true
        },
        "SponsorAccountNumber":{
            "title":"Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique number of the sponsor account.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelatedSponsorAccountName":{
            "title":"Account Description",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the related sponsor account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RelatedSponsorAccountNumber":{
            "title":"Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique number of the related sponsor account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SponsorAccountId":{
            "type":"integer",
            "description":"The unique identifier of the sponsor account.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : grantsSponsors-GrantsSponsorAccountDetails-item-response

Type: object

Show Source

• Comments: string
  Maximum Length: 2000

  The comment about the sponsor account details.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Created By
• CreationDate: string (date-time)
  Read Only: true

  Creation Date
• LastUpdateDate: string (date-time)
  Read Only: true

  Last Updated Date
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Last Updated By
• LetterOfCreditFlag: boolean
  Maximum Length: 1

  Indicates whether the sponsor billing is letter of credit.
• LetterOfCreditNumber: string
  Maximum Length: 240

  The unique number of the sponsor letter of credit.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrimaryFlag: boolean
  Maximum Length: 1

  Indicates whether the sponsor account is primary.
• RelatedSponsorAccountId: integer (int64)
  The unique identifier of the related sponsor account.
• RelatedSponsorAccountName: string
  Title: Account Description

  Maximum Length: 240

  The name of the related sponsor account.
• RelatedSponsorAccountNumber: string
  Title: Account Number

  Maximum Length: 30

  The unique number of the related sponsor account.
• RelatedSponsorId: integer (int64)
  The unique identifier of the related sponsor.
• RelatedSponsorName: string
  Maximum Length: 255

  The name of the related sponsor.
• RelatedSponsorNumber: string
  Maximum Length: 255

  The unique number of the related sponsor.
• SponsorAccountDetailsId: integer (int64)
  The unique identifier or the sponsor account details.
• SponsorAccountId: integer (int64)
  The unique identifier of the sponsor account.
• SponsorAccountName: string
  Title: Account Description

  Maximum Length: 240

  The name of the sponsor account.
• SponsorAccountNumber: string
  Title: Account Number

  Maximum Length: 30

  The unique number of the sponsor account.
• SponsorId: integer (int64)
  The unique identifier of the sponsor.
• SponsorName: string
  Maximum Length: 255

  The name of the sponsor.
• SponsorNumber: string
  Maximum Length: 255

  The unique number of the sponsor.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Last Updated By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Creation Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedSponsorName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the related sponsor.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Created By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the sponsor account is primary.",
            "nullable":true,
            "x-queryable":true
        },
        "SponsorAccountDetailsId":{
            "type":"integer",
            "description":"The unique identifier or the sponsor account details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RelatedSponsorId":{
            "type":"integer",
            "description":"The unique identifier of the related sponsor.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SponsorAccountName":{
            "title":"Account Description",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the sponsor account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Comments":{
            "maxLength":"2000",
            "type":"string",
            "description":"The comment about the sponsor account details.",
            "nullable":true,
            "x-queryable":true
        },
        "LetterOfCreditFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the sponsor billing is letter of credit.",
            "nullable":true,
            "x-queryable":true
        },
        "LetterOfCreditNumber":{
            "maxLength":"240",
            "type":"string",
            "description":"The unique number of the sponsor letter of credit.",
            "nullable":true,
            "x-queryable":true
        },
        "RelatedSponsorNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique number of the related sponsor.",
            "nullable":true,
            "x-queryable":true
        },
        "RelatedSponsorAccountId":{
            "type":"integer",
            "description":"The unique identifier of the related sponsor account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SponsorId":{
            "type":"integer",
            "description":"The unique identifier of the sponsor.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SponsorName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the sponsor.",
            "nullable":true,
            "x-queryable":true
        },
        "SponsorNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique number of the sponsor.",
            "nullable":true,
            "x-queryable":true
        },
        "SponsorAccountNumber":{
            "title":"Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique number of the sponsor account.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelatedSponsorAccountName":{
            "title":"Account Description",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the related sponsor account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RelatedSponsorAccountNumber":{
            "title":"Account Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique number of the related sponsor account.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SponsorAccountId":{
            "type":"integer",
            "description":"The unique identifier of the sponsor account.",
            "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"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last Updated Date",
            "format":"date-time",
            "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 sponsor account details for a particular sponsor by submitting a PATCH request on the REST resource using cURL.

curl --user ppm_cloud_user -X PATCH "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/grantsSponsors/<Sponsor_Id>/child/GrantsSponsorAccountDetails/<Sponsor_Account_details_id>"

Request Body Example

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

 {

            "LetterOfCreditFlag": true,
            "LetterOfCreditNumber": "REST_01",
            "Comments": "Comments from REST PATCH"
    }

Response Body Example

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

{
    "SponsorAccountDetailsId": <Sponsor_acct_details_id>,
    "SponsorId": <Sponsor_Id>,
    "SponsorName": "DEPARTMENT HIGHWAYS KENTUCKY",
    "SponsorNumber": "1697082",
    "SponsorAccountName": "Department Highway Account 4",
    "SponsorAccountNumber": "Vision_224297",
    "PrimaryFlag": false,
    "LetterOfCreditFlag": true,
    "LetterOfCreditNumber": "REST_01",
    "Comments": "Comments from REST PATCH",
    "RelatedSponsorAccountName": null,
    "RelatedSponsorAccountNumber": null,
    "RelatedSponsorAccountId": null,
    "RelatedSponsorId": null,
    "SponsorAccountId": 300100562079966,
    "CreatedBy": "pappu.sri",
    "CreationDate": "2022-10-27T23:44:00+00:00",
    "LastUpdateDate": "2022-10-27T23:58:36+00:00",
    "LastUpdatedBy": "pappu.sri",
    "RelatedSponsorName": null,
    "RelatedSponsorNumber": null,
    "links": [
        {
            "rel": "self",
            "href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/grantsSponsors/300100562055599/child/GrantsSponsorAccountDetails/300100562085615",
            "name": "GrantsSponsorAccountDetails",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/grantsSponsors/300100562055599/child/GrantsSponsorAccountDetails/300100562085615",
             "name": "GrantsSponsorAccountDetails",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "http://your_organization.com:port/fscmRestApi/resources/11.13.18.05/grantsSponsors/300100562055599",
            "name": "grantsSponsors",
            "kind": "item"
        }
    ]
}

Back to Top