Jump to

• Request
• Response
• Examples

Update a federal DATA Act file sequence

patch

/fscmRestApi/resources/11.13.18.05/fedDATAActFileSequences/{fedDATAActFileSequencesUniqID}

Request

Path Parameters

• fedDATAActFileSequencesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Federal DATA Act File Sequences resource and used to uniquely identify an instance of Federal DATA Act File Sequences. The client should not generate the hash key value. Instead, the client should query on the Federal DATA Act File Sequences collection resource in order to navigate to a specific instance of Federal DATA Act File Sequences 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

• BalanceName: string
  Title: Balance Name

  Maximum Length: 120

  Balance name of the federal DATA Act file sequences.
• ChangeSign: string
  Title: Change Sign

  Maximum Length: 255

  Change sign of the federal DATA Act file sequences.
• ReportSequence: integer (int32)
  Title: Report Sequence

  Default Value: 0

  Report sequence of the federal DATA Act file sequences.

{
    "type":"object",
    "properties":{
        "ReportSequence":{
            "title":"Report Sequence",
            "type":"integer",
            "description":"Report sequence of the federal DATA Act file sequences.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":6,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ChangeSign":{
            "title":"Change Sign",
            "maxLength":255,
            "type":"string",
            "description":"Change sign of the federal DATA Act file sequences.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BalanceName":{
            "title":"Balance Name",
            "maxLength":120,
            "type":"string",
            "description":"Balance name of the federal DATA Act file sequences.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : fedDATAActFileSequences-item-response

Type: object

Show Source

• BalanceName: string
  Title: Balance Name

  Maximum Length: 120

  Balance name of the federal DATA Act file sequences.
• ChangeSign: string
  Title: Change Sign

  Maximum Length: 255

  Change sign of the federal DATA Act file sequences.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the record was created.
• FileCode: string
  Title: File Code

  Maximum Length: 30

  File code of the federal DATA Act file sequences.
• FileSequenceId: integer (int64)
  Title: File Sequence ID

  The unique identifier of the file sequence of the federal DATA Act file sequences.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The date when the record was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReportSequence: integer (int32)
  Title: Report Sequence

  Default Value: 0

  Report sequence of the federal DATA Act file sequences.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The date when the record was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FileCode":{
            "title":"File Code",
            "maxLength":30,
            "type":"string",
            "description":"File code of the federal DATA Act file sequences.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "dependencies":[
                    "BalanceHeaderId_HDREO"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeSign":{
            "title":"Change Sign",
            "maxLength":255,
            "type":"string",
            "description":"Change sign of the federal DATA Act file sequences.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FileSequenceId":{
            "title":"File Sequence ID",
            "type":"integer",
            "description":"The unique identifier of the file sequence of the federal DATA Act file sequences.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ReportSequence":{
            "title":"Report Sequence",
            "type":"integer",
            "description":"Report sequence of the federal DATA Act file sequences.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":6,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "BalanceName":{
            "title":"Balance Name",
            "maxLength":120,
            "type":"string",
            "description":"Balance name of the federal DATA Act file sequences.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "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 the Report Sequence and Change Sign of a DATA Act file sequence by submitting a PATCH request on the REST resource using cURL.

curl -i -u "username:password" -H "Content-type: application/json" -X PATCH "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/fedDATAActFileSequences/300100613850604

Request Body Example

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

{
           
            "ReportSequence": 15020,
            "ChangeSign": "Yes"
}

Response Body Example

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

{
    "FileSequenceId": "300100613850604",
    "BalanceName": "BAL03",
    "FileCode": "A",
    "ReportSequence": 15020,
    "ChangeSign": "Yes",
    "CreationDate": "2023-11-07T13:06:30+00:00",
    "CreatedBy": "usersname",
    "LastUpdatedBy": "usersname",
    "LastUpdateDate": "2023-11-07T13:08:52+00:00",
    "@context": {
        "key": "300100613850604,300100613850598,300100613850598,Y,ORA_FV_DACT_FILE_NAME,A,ORA_FV_DACT_FILE_NAME,YES_NO",
        "headers": {
            "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
        },
        "links": [
            {
                "rel": "self",
                "href": "https:/servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/fedDATAActFileSequences/300100613850604%2C300100613850598%2C300100613850598%2CY%2CORA_FV_DACT_FILE_NAME%2CA%2CORA_FV_DACT_FILE_NAME%2CYES_NO",
                "name": "fedDATAActFileSequences",
                "kind": "item"
            },
            {
                "rel": "canonical",
                "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/fedDATAActFileSequences/300100613850604%2C300100613850598%2C300100613850598%2CY%2CORA_FV_DACT_FILE_NAME%2CA%2CORA_FV_DACT_FILE_NAME%2CYES_NO",
                "name": "fedDATAActFileSequences",
                "kind": "item"
            }
        ]
    }
}

Back to Top