Jump to

• Request
• Response

Create a set of filter criteria

post

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

Request

Path Parameters

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

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

Back to Top