Update an agency location code
patch
/fscmRestApi/resources/11.13.18.05/fedAgencyLocationCodes/{AgencyLocationCodeId}
Request
Path Parameters
-
AgencyLocationCodeId(required): integer(int64)
Unique identifier for the agency location.
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
Root Schema : schema
Type:
Show Source
object
-
AgencyLocationCode: string
Title:
Agency Location Code
Maximum Length:30
Accounting office within an agency that reports disbursements and collections to Treasury. -
AgencyLocationCodeId: integer
(int64)
Unique identifier for the agency location.
-
AgencyLocationName: string
Title:
Name
Maximum Length:240
Identifier for the accounting office within an agency that reports disbursements and collections to Treasury. -
AgencyType: string
Title:
Agency Type
Maximum Length:80
Internal or trading partner agency location code. -
DisbursingType: string
Title:
Disbursing Type
Maximum Length:80
Treasury or non treasury disbursing type for agency location. -
fedAgencyLocationCodeDFF: array
Federal Agency Location Codes Descriptive Flexfields
Title:
Federal Agency Location Codes Descriptive Flexfields
The federal agency location codes descriptive flexfields resource manages details about the descriptive flexfield references for an agency location.
Nested Schema : Federal Agency Location Codes Descriptive Flexfields
Type:
array
Title:
Federal Agency Location Codes Descriptive Flexfields
The federal agency location codes descriptive flexfields resource manages details about the descriptive flexfield references for an agency location.
Show Source
Nested Schema : fedAgencyLocationCodes-fedAgencyLocationCodeDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
Descriptive flexfield context. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value. -
AgencyLocationCodeId: integer
(int64)
Unique identifier for the agency location.
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.
Root Schema : fedAgencyLocationCodes-item-response
Type:
Show Source
object
-
AgencyLocationCode: string
Title:
Agency Location Code
Maximum Length:30
Accounting office within an agency that reports disbursements and collections to Treasury. -
AgencyLocationCodeId: integer
(int64)
Unique identifier for the agency location.
-
AgencyLocationName: string
Title:
Name
Maximum Length:240
Identifier for the accounting office within an agency that reports disbursements and collections to Treasury. -
AgencyType: string
Title:
Agency Type
Maximum Length:80
Internal or trading partner agency location code. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
DisbursingType: string
Title:
Disbursing Type
Maximum Length:80
Treasury or non treasury disbursing type for agency location. -
fedAgencyLocationCodeDFF: array
Federal Agency Location Codes Descriptive Flexfields
Title:
Federal Agency Location Codes Descriptive Flexfields
The federal agency location codes descriptive flexfields resource manages details about the descriptive flexfield references for an agency location. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The session login associated to the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Federal Agency Location Codes Descriptive Flexfields
Type:
array
Title:
Federal Agency Location Codes Descriptive Flexfields
The federal agency location codes descriptive flexfields resource manages details about the descriptive flexfield references for an agency location.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fedAgencyLocationCodes-fedAgencyLocationCodeDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
Descriptive flexfield context. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value. -
AgencyLocationCodeId: integer
(int64)
Unique identifier for the agency location.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- fedAgencyLocationCodeDFF
-
Parameters:
- AgencyLocationCodeId:
$request.path.AgencyLocationCodeId
The federal agency location codes descriptive flexfields resource manages details about the descriptive flexfield references for an agency location. - AgencyLocationCodeId:
Examples
The following example shows how to update an agency location code 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/fedAgencyLocationCodes/300100181825404
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "AgencyLocationCode": "Post1Test15", "AgencyLocationName": "US RK1 Location", "AgencyType": "Internal", "DisbursingType": "Treasury Disbursing Office" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "AgencyLocationCode": "Post1Test15", "AgencyLocationName": "US RK1 Location", "AgencyLocationCodeId": 300100181825404, "AgencyType": "Internal", "DisbursingType": "Treasury Disbursing Office", "CreatedBy": "FIN_USER1", "CreationDate": "2019-11-22T07:03:05.001+00:00", "LastUpdateDate": "2019-11-22T07:33:52+00:00", "LastUpdateLogin": "97EF9E46829A1CC6E053A732C40AF01C", "LastUpdatedBy": "FIN_USER1", "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAgencyLocationCodes/300100181825404", "name": "fedAgencyLocationCodes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAgencyLocationCodes/300100181825404", "name": "fedAgencyLocationCodes", "kind": "item" }, { "rel": "child", "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAgencyLocationCodes/300100181825404/child/fedAgencyLocationCodeDFF", "name": "fedAgencyLocationCodeDFF", "kind": "collection" } ] }