Jump to

• Request
• Response
• Examples

Update a federal DATA Act file criteria

patch

/fscmRestApi/resources/11.13.18.05/fedDATAActFileCriteria/{FileCriteriaId}

Request

Path Parameters

• FileCriteriaId(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

• FederalAttributeName: string
  Title: Federal Attribute Name

  Maximum Length: 255

  Federal attribute name of the federal DATA Act file criteria.
• FederalAttributeValues: string
  Title: Federal Attribute Code

  Maximum Length: 4000

  Federal Attribute values of the federal DATA Act file criteria.
• Ledger: string
  Title: Ledger

  Maximum Length: 255

  Name of the ledger associated with the federal DATA Act file criteria.
• Operator: string
  Title: Operator

  Maximum Length: 255

  Operator of the federal DATA Act file criteria.

{
    "type":"object",
    "properties":{
        "Operator":{
            "title":"Operator",
            "maxLength":255,
            "type":"string",
            "description":"Operator of the federal DATA Act file criteria.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FederalAttributeValues":{
            "title":"Federal Attribute Code",
            "maxLength":4000,
            "type":"string",
            "description":"Federal Attribute values of the federal DATA Act file criteria.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FederalAttributeName":{
            "title":"Federal Attribute Name",
            "maxLength":255,
            "type":"string",
            "description":"Federal attribute name of the federal DATA Act file criteria.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Ledger":{
            "title":"Ledger",
            "maxLength":255,
            "type":"string",
            "description":"Name of the ledger associated with the federal DATA Act file criteria.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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

Type: object

Show Source

• 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.
• FederalAttributeName: string
  Title: Federal Attribute Name

  Maximum Length: 255

  Federal attribute name of the federal DATA Act file criteria.
• FederalAttributeValues: string
  Title: Federal Attribute Code

  Maximum Length: 4000

  Federal Attribute values of the federal DATA Act file criteria.
• FileCode: string
  Title: File Code

  Maximum Length: 30

  File code of the federal DATA Act file criteria.
• FileCriteriaId: integer (int64)
  Title: File Criteria ID

  The unique identifier of the federal DATA Act file criteria.
• 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 user who last updated the record.
• Ledger: string
  Title: Ledger

  Maximum Length: 255

  Name of the ledger associated with the federal DATA Act file criteria.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Operator: string
  Title: Operator

  Maximum Length: 255

  Operator of the federal DATA Act file criteria.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Operator":{
            "title":"Operator",
            "maxLength":255,
            "type":"string",
            "description":"Operator of the federal DATA Act file criteria.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FederalAttributeValues":{
            "title":"Federal Attribute Code",
            "maxLength":4000,
            "type":"string",
            "description":"Federal Attribute values of the federal DATA Act file criteria.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"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 criteria.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "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
        },
        "FileCriteriaId":{
            "title":"File Criteria ID",
            "type":"integer",
            "description":"The unique identifier of the federal DATA Act file criteria.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Ledger":{
            "title":"Ledger",
            "maxLength":255,
            "type":"string",
            "description":"Name of the ledger associated with the federal DATA Act file criteria.",
            "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"
            }
        },
        "FederalAttributeName":{
            "title":"Federal Attribute Name",
            "maxLength":255,
            "type":"string",
            "description":"Federal attribute name of the federal DATA Act file criteria.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "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 Operator and Federal Attribute Values of a DATA Act file Criteria 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 PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedDATAActFileCriteria/300100613363597

Request Body Example

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

{
     "Operator": "Not Equals",
      "FederalAttributeValues": "ORA_FV_E"
}

Response Body Example

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

{
    "FileCriteriaId": "300100613363597",
    "FileCode": "A",
    "Ledger": "USFed1 US",
    "Operator": "Not Equals",
    "FederalAttributeName": "Begin End Indicator",
    "FederalAttributeValues": "ORA_FV_E",
    "CreationDate": "2023-11-03T12:18:00+00:00",
    "CreatedBy": "usersname",
    "LastUpdatedBy": "usersname",
    "LastUpdateDate": "2023-11-07T13:36:40+00:00",
    "@context": {
        "key": "300100613363597",
        "headers": {
            "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
        },
        "links": [
            {
                "rel": "self",
                "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/fedDATAActFileCriteria/300100613363597",
                "name": "fedDATAActFileCriteria",
                "kind": "item"
            },
            {
                "rel": "canonical",
                "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/fedDATAActFileCriteria/300100613363597",
                "name": "fedDATAActFileCriteria",
                "kind": "item"
            }
        ]
    }
}

Back to Top