Jump to

• Request
• Response
• Examples

Update a federal treasury check range

patch

/fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/{TreasuryConfirmationId}/child/fedTreasuryCheckRanges/{CheckRangeId}

Request

Path Parameters

• CheckRangeId(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=
• TreasuryConfirmationId(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

• FromRange: integer (int64)
  Title: From Range

  The beginning payment document number of the federal treasury check range.
• ToRange: integer (int64)
  Title: To Range

  The ending payment document number of the federal treasury check range.

{
    "type":"object",
    "properties":{
        "ToRange":{
            "title":"To Range",
            "type":"integer",
            "description":"The ending payment document number of the federal treasury check range.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        },
        "FromRange":{
            "title":"From Range",
            "type":"integer",
            "description":"The beginning payment document number of the federal treasury check range.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : fedTreasuryConfirmationSchedules-fedTreasuryCheckRanges-item-response

Type: object

Show Source

• CheckRangeId: integer (int64)
  Title: Check Range ID

  The unique identifier of the federal treasury check range associated with the federal treasury confirmation schedule.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the record was created.
• FromRange: integer (int64)
  Title: From Range

  The beginning payment document number of the federal treasury check range.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The last user login that was used to update the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ToRange: integer (int64)
  Title: To Range

  The ending payment document number of the federal treasury check range.
• TreasuryConfirmationId: integer (int64)
  Title: Treasury Confirmation ID

  The unique identifier of the treasury confirmation associated with the check range.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FromRange":{
            "title":"From Range",
            "type":"integer",
            "description":"The beginning payment document number of the federal treasury check range.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ToRange":{
            "title":"To Range",
            "type":"integer",
            "description":"The ending payment document number of the federal treasury check range.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CheckRangeId":{
            "title":"Check Range ID",
            "type":"integer",
            "description":"The unique identifier of the federal treasury check range associated with the federal treasury confirmation schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TreasuryConfirmationId":{
            "title":"Treasury Confirmation ID",
            "type":"integer",
            "description":"The unique identifier of the treasury confirmation associated with the check range.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The last user login that was used to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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 a federal treasury check range by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> 
https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/{TreasuryConfirmationId}/child/fedTreasuryCheckRanges/{CheckRangeId}

Request Body Example

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

{
    "FromRange": 9921,
    "ToRange": 9922
}

Response Body Example

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

{
    "CheckRangeId": 300100589618574,
    "TreasuryConfirmationId": 100105428613938,
    "FromRange": 9921,
    "ToRange": 9922,
    "CreatedBy": "username",
    "CreationDate": "2024-04-24T09:37:20+00:00",
    "LastUpdatedBy": "username",
    "LastUpdateDate": "2024-04-24T10:04:37+00:00",
    "LastUpdateLogin": "1620753CCFAC5429E063426315ACCF93",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/100105428613938/child/fedTreasuryCheckRanges/300100589618574",
            "name": "fedTreasuryCheckRanges",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/100105428613938/child/fedTreasuryCheckRanges/300100589618574",
            "name": "fedTreasuryCheckRanges",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/100105428613938",
            "name": "fedTreasuryConfirmationSchedules",
            "kind": "item"
        }
    ]
}

Back to Top