Jump to

• Request
• Response
• Examples

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "AgencyLocationCode":{
            "title":"Agency Location Code",
            "maxLength":30,
            "type":"string",
            "description":"Accounting office within an agency that reports disbursements and collections to Treasury.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"false"
            }
        },
        "DisbursingType":{
            "title":"Disbursing Type",
            "maxLength":80,
            "type":"string",
            "description":"Treasury or non treasury disbursing type for agency location.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "DisbursingTypeCode",
                    "LookupCode1",
                    "Meaning1"
                ]
            }
        },
        "AgencyLocationCodeId":{
            "type":"integer",
            "description":"Unique identifier for the agency location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "AgencyType":{
            "title":"Agency Type",
            "maxLength":80,
            "type":"string",
            "description":"Internal or trading partner agency location code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "AgencyTypeCode",
                    "LookupCode",
                    "Meaning"
                ]
            }
        },
        "AgencyLocationName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Identifier for the accounting office within an agency that reports disbursements and collections to Treasury.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "fedAgencyLocationCodeDFF":{
            "title":"Federal Agency Location Codes Descriptive Flexfields",
            "type":"array",
            "description":"The federal agency location codes descriptive flexfields resource manages details about the descriptive flexfield references for an agency location.",
            "items":{
                "$ref":"#/components/schemas/fedAgencyLocationCodes-fedAgencyLocationCodeDFF-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

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

• Array of: object fedAgencyLocationCodes-fedAgencyLocationCodeDFF-item-patch-request

{
    "title":"Federal Agency Location Codes Descriptive Flexfields",
    "type":"array",
    "description":"The federal agency location codes descriptive flexfields resource manages details about the descriptive flexfield references for an agency location.",
    "items":{
        "$ref":"#/components/schemas/fedAgencyLocationCodes-fedAgencyLocationCodeDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : fedAgencyLocationCodes-fedAgencyLocationCodeDFF-item-patch-request

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "AgencyLocationCodeId":{
            "type":"integer",
            "description":"Unique identifier for the agency location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Descriptive flexfield context.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : fedAgencyLocationCodes-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyLocationCode":{
            "title":"Agency Location Code",
            "maxLength":30,
            "type":"string",
            "description":"Accounting office within an agency that reports disbursements and collections to Treasury.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"false"
            },
            "x-queryable":true
        },
        "DisbursingType":{
            "title":"Disbursing Type",
            "maxLength":80,
            "type":"string",
            "description":"Treasury or non treasury disbursing type for agency location.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "DisbursingTypeCode",
                    "LookupCode1",
                    "Meaning1"
                ]
            },
            "x-queryable":true
        },
        "fedAgencyLocationCodeDFF":{
            "title":"Federal Agency Location Codes Descriptive Flexfields",
            "type":"array",
            "description":"The federal agency location codes descriptive flexfields resource manages details about the descriptive flexfield references for an agency location.",
            "items":{
                "$ref":"#/components/schemas/fedAgencyLocationCodes-fedAgencyLocationCodeDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AgencyLocationCodeId":{
            "type":"integer",
            "description":"Unique identifier for the agency location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AgencyType":{
            "title":"Agency Type",
            "maxLength":80,
            "type":"string",
            "description":"Internal or trading partner agency location code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "AgencyTypeCode",
                    "LookupCode",
                    "Meaning"
                ]
            },
            "x-queryable":true
        },
        "AgencyLocationName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Identifier for the accounting office within an agency that reports disbursements and collections to Treasury.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object fedAgencyLocationCodes-fedAgencyLocationCodeDFF-item-response

{
    "title":"Federal Agency Location Codes Descriptive Flexfields",
    "type":"array",
    "description":"The federal agency location codes descriptive flexfields resource manages details about the descriptive flexfield references for an agency location.",
    "items":{
        "$ref":"#/components/schemas/fedAgencyLocationCodes-fedAgencyLocationCodeDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : fedAgencyLocationCodes-fedAgencyLocationCodeDFF-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AgencyLocationCodeId":{
            "type":"integer",
            "description":"Unique identifier for the agency location.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Descriptive flexfield context.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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."
        }
    }
}

Links

fedAgencyLocationCodeDFF

Operation: /fscmRestApi/resources/11.13.18.05/fedAgencyLocationCodes/{AgencyLocationCodeId}/child/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.

Back to Top

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"
        }
    ]
}

Back to Top