Jump to

• Request
• Response

Get fee criteria

get

/fscmRestApi/resources/11.13.18.05/feeCriterias/{FeeCriteriaId}

Request

Path Parameters

• FeeCriteriaId(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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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.

There's no request body for this operation.

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

Type: object

Show Source

• criteriaDetails: array Details
  Title: Details

  Details about the included fee criteria.
• Description: string
  Title: Description

  Maximum Length: 1000

  Description of the fee criteria.
• FeeCriteriaCode: string
  Title: Fee Criteria Code

  Maximum Length: 30

  Code for the fee criteria.
• FeeCriteriaId: integer (int64)
  Title: Fee Criteria ID

  Read Only: true

  Unique identifier of the fee criteria.
• FeeCriteriaName: string
  Title: Fee Criteria Name

  Maximum Length: 50

  Name of the fee criteria.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• StatusCode: string
  Title: Status Code

  Maximum Length: 30

  Fee criteria status code.
• StatusMeaning: string
  Title: Status Meaning

  Read Only: true

  Maximum Length: 80

  Fee criteria status meaning.
• tagAssignments: array Tag Assignments
  Title: Tag Assignments

  Tags assigned to the fee criteria.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the fee criteria.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FeeCriteriaCode":{
            "title":"Fee Criteria Code",
            "maxLength":30,
            "type":"string",
            "description":"Code for the fee criteria.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FeeCriteriaId":{
            "title":"Fee Criteria ID",
            "type":"integer",
            "description":"Unique identifier of the fee criteria.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FeeCriteriaName":{
            "title":"Fee Criteria Name",
            "maxLength":50,
            "type":"string",
            "description":"Name of the fee criteria.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Fee criteria status code.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Fee criteria status meaning.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "criteriaDetails":{
            "title":"Details",
            "type":"array",
            "description":"Details about the included fee criteria.",
            "items":{
                "$ref":"#/components/schemas/feeCriterias-criteriaDetails-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "tagAssignments":{
            "title":"Tag Assignments",
            "type":"array",
            "description":"Tags assigned to the fee criteria.",
            "items":{
                "$ref":"#/components/schemas/feeCriterias-tagAssignments-item-response"
            }
        }
    }
}

Nested Schema : Details

Type: array

Title: Details

Details about the included fee criteria.

Show Source

• Array of: object feeCriterias-criteriaDetails-item-response

{
    "title":"Details",
    "type":"array",
    "description":"Details about the included fee criteria.",
    "items":{
        "$ref":"#/components/schemas/feeCriterias-criteriaDetails-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 : Tag Assignments

Type: array

Title: Tag Assignments

Tags assigned to the fee criteria.

Show Source

• Array of: object feeCriterias-tagAssignments-item-response

{
    "title":"Tag Assignments",
    "type":"array",
    "description":"Tags assigned to the fee criteria.",
    "items":{
        "$ref":"#/components/schemas/feeCriterias-tagAssignments-item-response"
    }
}

Nested Schema : feeCriterias-criteriaDetails-item-response

Type: object

Show Source

• AttributeNameCode: string
  Title: Attribute Name

  Maximum Length: 30

  Code for the attribute name.
• AttributeNameMeaning: string
  Title: Attribute Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the attribute name code.
• AttributeValue: string
  Title: Attribute Value

  Maximum Length: 1000

  Value of the attribute.
• CriteriaDetailId: integer (int64)
  Title: Criteria Detail ID

  Read Only: true

  Unique identifier of the fee criteria details.
• links: array Links
  Title: Links

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

  Maximum Length: 30

  Code of the criteria operator.
• OperandMeaning: string
  Title: Operator Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the criteria operator code.

{
    "type":"object",
    "properties":{
        "AttributeNameCode":{
            "title":"Attribute Name",
            "maxLength":30,
            "type":"string",
            "description":"Code for the attribute name.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AttributeNameMeaning":{
            "title":"Attribute Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the attribute name code.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AttributeValue":{
            "title":"Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"Value of the attribute.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CriteriaDetailId":{
            "title":"Criteria Detail ID",
            "type":"integer",
            "description":"Unique identifier of the fee criteria details.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OperandCode":{
            "title":"Operator Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the criteria operator.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OperandMeaning":{
            "title":"Operator Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the criteria operator code.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Nested Schema : feeCriterias-tagAssignments-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TagAssignmentId: integer (int64)
  Title: Tag Assignment ID

  Read Only: true

  Unique identifier of the tag assignment.
• TagCode: string
  Title: Tag Code

  Maximum Length: 30

  Code of the tag.
• TagId: integer (int64)
  Title: Tag ID

  Unique identifier of the tag.
• TagName: string
  Title: Tag Name

  Read Only: true

  Maximum Length: 64

  Name of the tag.

{
    "type":"object",
    "properties":{
        "TagAssignmentId":{
            "title":"Tag Assignment ID",
            "type":"integer",
            "description":"Unique identifier of the tag assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TagCode":{
            "title":"Tag Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the tag.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TagId":{
            "title":"Tag ID",
            "type":"integer",
            "description":"Unique identifier of the tag.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TagName":{
            "title":"Tag Name",
            "maxLength":64,
            "type":"string",
            "description":"Name of the tag.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Links

criteriaDetails

Operation: /fscmRestApi/resources/11.13.18.05/feeCriterias/{FeeCriteriaId}/child/criteriaDetails

Parameters:

• FeeCriteriaId: $request.path.FeeCriteriaId

Details about the included fee criteria.

statusCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HES_FEE_CRITERIA_STATUS%2CApplicationCode%3DHES%2CLookupCode%3D{StatusCode}

The following properties are defined on the LOV link relation:

• Source Attribute: StatusCode; Target Attribute: LookupCode
• Display Attribute: Meaning

tagAssignments

Operation: /fscmRestApi/resources/11.13.18.05/feeCriterias/{FeeCriteriaId}/child/tagAssignments

Parameters:

• FeeCriteriaId: $request.path.FeeCriteriaId

Tags assigned to the fee criteria.

Back to Top