Jump to

• Request
• Response
• Examples

Create a chart of accounts filter

post

/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters

Request

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

• filterCriteria: array Filter Criteria
  Title: Filter Criteria

  The filter criteria resource is used to specify criteria for a chart of accounts filter.
• FilterId: integer (int64)
  The unique identifier of the criteria for the chart of accounts filter.
• StructureInstanceCode: string
  Maximum Length: 80

  The chart of accounts structure instance code for the generated filter ID.

{
    "type":"object",
    "properties":{
        "FilterId":{
            "type":"integer",
            "description":"The unique identifier of the criteria for the chart of accounts filter.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "filterCriteria":{
            "title":"Filter Criteria",
            "type":"array",
            "description":"The filter criteria resource is used to specify criteria for a chart of accounts filter.",
            "items":{
                "$ref":"#/components/schemas/chartOfAccountsFilters-filterCriteria-item-post-request"
            }
        },
        "StructureInstanceCode":{
            "maxLength":80,
            "type":"string",
            "description":"The chart of accounts structure instance code for the generated filter ID.",
            "nullable":true
        }
    }
}

Nested Schema : Filter Criteria

Type: array

Title: Filter Criteria

The filter criteria resource is used to specify criteria for a chart of accounts filter.

Show Source

• Array of: object schema

{
    "title":"Filter Criteria",
    "type":"array",
    "description":"The filter criteria resource is used to specify criteria for a chart of accounts filter.",
    "items":{
        "$ref":"#/components/schemas/chartOfAccountsFilters-filterCriteria-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• FromValue: string
  Maximum Length: 80

  The segment value for the segment code and the operator.
• Operator: string
  Maximum Length: 80

  The operator for the segment code used as criteria for the chart of accounts filter.
• SegmentCode: string
  Maximum Length: 80

  The segment code in a chart of accounts. The value for the segment code can be reviewed using the Setup and Maintenance work area and the Manage Chart of Accounts Configurations task.
• ToValue: string
  Maximum Length: 80

  The segment value for the segment code used only with the Between and Not Between operators.

{
    "type":"object",
    "properties":{
        "Operator":{
            "maxLength":80,
            "type":"string",
            "description":"The operator for the segment code used as criteria for the chart of accounts filter.",
            "nullable":true
        },
        "ToValue":{
            "maxLength":80,
            "type":"string",
            "description":"The segment value for the segment code used only with the Between and Not Between operators.",
            "nullable":true
        },
        "SegmentCode":{
            "maxLength":80,
            "type":"string",
            "description":"The segment code in a chart of accounts. The value for the segment code can be reviewed using the Setup and Maintenance work area and the Manage Chart of Accounts Configurations task.",
            "nullable":true
        },
        "FromValue":{
            "maxLength":80,
            "type":"string",
            "description":"The segment value for the segment code and the operator.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• filterCriteria: array Filter Criteria
  Title: Filter Criteria

  The filter criteria resource is used to specify criteria for a chart of accounts filter.
• FilterId: integer (int64)
  The unique identifier of the criteria for the chart of accounts filter.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• StructureInstanceCode: string
  Maximum Length: 80

  The chart of accounts structure instance code for the generated filter ID.

{
    "type":"object",
    "properties":{
        "filterCriteria":{
            "title":"Filter Criteria",
            "type":"array",
            "description":"The filter criteria resource is used to specify criteria for a chart of accounts filter.",
            "items":{
                "$ref":"#/components/schemas/chartOfAccountsFilters-filterCriteria-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FilterId":{
            "type":"integer",
            "description":"The unique identifier of the criteria for the chart of accounts filter.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StructureInstanceCode":{
            "maxLength":80,
            "type":"string",
            "description":"The chart of accounts structure instance code for the generated filter ID.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Filter Criteria

Type: array

Title: Filter Criteria

The filter criteria resource is used to specify criteria for a chart of accounts filter.

Show Source

• Array of: object chartOfAccountsFilters-filterCriteria-item-response

{
    "title":"Filter Criteria",
    "type":"array",
    "description":"The filter criteria resource is used to specify criteria for a chart of accounts filter.",
    "items":{
        "$ref":"#/components/schemas/chartOfAccountsFilters-filterCriteria-item-response"
    }
}

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 : chartOfAccountsFilters-filterCriteria-item-response

Type: object

Show Source

• FromValue: string
  Maximum Length: 80

  The segment value for the segment code and the operator.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Operator: string
  Maximum Length: 80

  The operator for the segment code used as criteria for the chart of accounts filter.
• SegmentCode: string
  Maximum Length: 80

  The segment code in a chart of accounts. The value for the segment code can be reviewed using the Setup and Maintenance work area and the Manage Chart of Accounts Configurations task.
• ToValue: string
  Maximum Length: 80

  The segment value for the segment code used only with the Between and Not Between operators.

{
    "type":"object",
    "properties":{
        "Operator":{
            "maxLength":80,
            "type":"string",
            "description":"The operator for the segment code used as criteria for the chart of accounts filter.",
            "nullable":true,
            "x-queryable":true
        },
        "ToValue":{
            "maxLength":80,
            "type":"string",
            "description":"The segment value for the segment code used only with the Between and Not Between operators.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SegmentCode":{
            "maxLength":80,
            "type":"string",
            "description":"The segment code in a chart of accounts. The value for the segment code can be reviewed using the Setup and Maintenance work area and the Manage Chart of Accounts Configurations task.",
            "nullable":true,
            "x-queryable":true
        },
        "FromValue":{
            "maxLength":80,
            "type":"string",
            "description":"The segment value for the segment code and the operator.",
            "nullable":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."
        }
    }
}

Links

filterCriteria

Operation: /fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/{chartOfAccountsFiltersUniqID}/child/filterCriteria

Parameters:

• chartOfAccountsFiltersUniqID: $request.path.chartOfAccountsFiltersUniqID

The filter criteria resource is used to specify criteria for a chart of accounts filter.

Back to Top

Examples

Example 1

The following example shows how to create a chart of accounts filter with one segment by submitting a POST 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/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
    "StructureInstanceCode":"OPERATIONS_ACCOUNTING_FLEX",
    "filterCriteria":[
    {
        "SegmentCode":"Department",
        "Operator":"BETWEEN",
        "FromValue":"05",
        "ToValue":"15"
    }]
}

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
    "FilterId": 300100185055422,
    "StructureInstanceCode": "OPERATIONS_ACCOUNTING_FLEX",
    "filterCriteria": [
        {
            "SegmentCode": "Department",
            "Operator": "BETWEEN",
            "FromValue": "05",
            "ToValue": "15",
            "links": [
                {
                    "rel": "self",
                    "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100185055420/child/filterCriteria/300100185055421",
                    "name": "filterCriteria",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100185055420/child/filterCriteria/300100185055421",
                    "name": "filterCriteria",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100185055420",
                    "name": "chartOfAccountsFilters",
                    "kind": "item"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100185055420",
            "name": "chartOfAccountsFilters",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100185055420",
            "name": "chartOfAccountsFilters",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100185055420/child/filterCriteria",
            "name": "filterCriteria",
            "kind": "collection"
        }
    ]
}

Example 2

The following example shows how to create a chart of accounts filter with multiple segments by submitting a POST 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/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
        "StructureInstanceCode":"OPERATIONS_ACCOUNTING_FLEX",
         "filterCriteria":[
        {                   
                  "SegmentCode":"Company",
                  "Operator":"EQUALTO",
                  "FromValue":"01"
        },
 
        {                 
                  "SegmentCode":"Product",
                  "Operator":"EQUALTO",
                  "FromValue":"2370"
        },
 
        {                   
                  "SegmentCode":"Account",
                  "Operator":"LESSTHANEQUALTO",
                  "FromValue":"09"
        },
 
        {                   
                  "SegmentCode":"Department",
                  "Operator":"BETWEEN",
                  "FromValue":"05",
                  "ToValue":"15"
        }]
}

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
    "FilterId": 300100543621935,
    "StructureInstanceCode": "OPERATIONS_ACCOUNTING_FLEX",
    "filterCriteria": [
        {
            "SegmentCode": "Company",
            "Operator": "EQUALTO",
            "FromValue": "01",
            "ToValue": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100543621930/child/filterCriteria/300100543621931",
                    "name": "filterCriteria",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100543621930/child/filterCriteria/300100543621931",
                    "name": "filterCriteria",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100543621930",
                    "name": "chartOfAccountsFilters",
                    "kind": "item"
                }
            ]
        },
        {
            "SegmentCode": "Product",
            "Operator": "EQUALTO",
            "FromValue": "2370",
            "ToValue": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100543621930/child/filterCriteria/300100543621932",
                    "name": "filterCriteria",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100543621930/child/filterCriteria/300100543621932",
                    "name": "filterCriteria",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100543621930",
                    "name": "chartOfAccountsFilters",
                    "kind": "item"
                }
            ]
        },
        {
            "SegmentCode": "Account",
            "Operator": "LESSTHANEQUALTO",
            "FromValue": "09",
            "ToValue": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100543621930/child/filterCriteria/300100543621933",
                    "name": "filterCriteria",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100543621930/child/filterCriteria/300100543621933",
                    "name": "filterCriteria",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100543621930",
                    "name": "chartOfAccountsFilters",
                    "kind": "item"
                }
            ]
        },
        {
            "SegmentCode": "Department",
            "Operator": "BETWEEN",
            "FromValue": "05",
            "ToValue": "15",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100543621930/child/filterCriteria/300100543621934",
                    "name": "filterCriteria",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100543621930/child/filterCriteria/300100543621934",
                    "name": "filterCriteria",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100543621930",
                    "name": "chartOfAccountsFilters",
                    "kind": "item"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100543621930",
            "name": "chartOfAccountsFilters",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100543621930",
            "name": "chartOfAccountsFilters",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/300100543621930/child/filterCriteria",
            "name": "filterCriteria",
            "kind": "collection"
        }
    ]
}

Back to Top