Jump to

• Request
• Response

Update a pay element expenditure type derivation precedence rule

patch

/fscmRestApi/resources/11.13.18.05/payElementExpenditureTypeDerivations/{ExpenditureTypeDerivPatternId}/child/precedenceRules/{PrecedenceId}

Request

Path Parameters

• ExpenditureTypeDerivPatternId(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=
• PrecedenceId(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: 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• DerivSetDescription: string
  Maximum Length: 2000

  Free-form description of the expenditure type derivation precedence set.
• DerivSetName: string
  Maximum Length: 200

  Free-form name of the expenditure type derivation precedence set. This name must be unique within a pattern.
• expenditureTypes: array Pay Element to Expenditure Type Results
  Title: Pay Element to Expenditure Type Results

  The Pay Element Expenditure Type Derivation Precedence Rule Expenditure Types resource is used to view and manage the expenditure type that will be applied to the project cost during distribution to projects.

{
    "type":"object",
    "properties":{
        "DerivSetDescription":{
            "maxLength":2000,
            "type":"string",
            "description":"Free-form description of the expenditure type derivation precedence set.",
            "nullable":true
        },
        "DerivSetName":{
            "maxLength":200,
            "type":"string",
            "description":"Free-form name of the expenditure type derivation precedence set. This name must be unique within a pattern.",
            "nullable":false
        },
        "expenditureTypes":{
            "title":"Pay Element to Expenditure Type Results",
            "type":"array",
            "description":"The Pay Element Expenditure Type Derivation Precedence Rule Expenditure Types resource is used to view and manage the expenditure type that will be applied to the project cost during distribution to projects.",
            "items":{
                "$ref":"#/components/schemas/payElementExpenditureTypeDerivations-precedenceRules-expenditureTypes-item-patch-request"
            }
        }
    }
}

Nested Schema : Pay Element to Expenditure Type Results

Type: array

Title: Pay Element to Expenditure Type Results

The Pay Element Expenditure Type Derivation Precedence Rule Expenditure Types resource is used to view and manage the expenditure type that will be applied to the project cost during distribution to projects.

Show Source

• Array of: object payElementExpenditureTypeDerivations-precedenceRules-expenditureTypes-item-patch-request

{
    "title":"Pay Element to Expenditure Type Results",
    "type":"array",
    "description":"The Pay Element Expenditure Type Derivation Precedence Rule Expenditure Types resource is used to view and manage the expenditure type that will be applied to the project cost during distribution to projects.",
    "items":{
        "$ref":"#/components/schemas/payElementExpenditureTypeDerivations-precedenceRules-expenditureTypes-item-patch-request"
    }
}

Nested Schema : payElementExpenditureTypeDerivations-precedenceRules-expenditureTypes-item-patch-request

Type: object

Show Source

• ExpenditureTypeId: integer (int64)
  The unique identifier of the expenditure type.
• ExpenditureTypeName: string
  Title: Expenditure Type

  Maximum Length: 240

  The name of the expenditure type.

{
    "type":"object",
    "properties":{
        "ExpenditureTypeId":{
            "type":"integer",
            "description":"The unique identifier of the expenditure type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ExpenditureTypeName":{
            "title":"Expenditure Type",
            "maxLength":240,
            "type":"string",
            "description":"The name of the expenditure type.",
            "nullable":true,
            "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 : payElementExpenditureTypeDerivations-precedenceRules-item-response

Type: object

Show Source

• DerivSetDescription: string
  Maximum Length: 2000

  Free-form description of the expenditure type derivation precedence set.
• DerivSetName: string
  Maximum Length: 200

  Free-form name of the expenditure type derivation precedence set. This name must be unique within a pattern.
• ExpenditureTypeDerivPatternId: integer (int64)
  Unique identifier of the expenditure type derivation pattern associated with this precedence set.
• expenditureTypes: array Pay Element to Expenditure Type Results
  Title: Pay Element to Expenditure Type Results

  The Pay Element Expenditure Type Derivation Precedence Rule Expenditure Types resource is used to view and manage the expenditure type that will be applied to the project cost during distribution to projects.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Precedence: integer (int32)
  Read Only: true

  Default Value: 1

  The precedence number that defines the order in which this set should be applied when the payroll cost is being distributed to projects and the pay element matches the pattern.
• PrecedenceId: integer (int64)
  Read Only: true

  The unique identifier of the precedence rule.

{
    "type":"object",
    "properties":{
        "DerivSetDescription":{
            "maxLength":2000,
            "type":"string",
            "description":"Free-form description of the expenditure type derivation precedence set.",
            "nullable":true,
            "x-queryable":true
        },
        "DerivSetName":{
            "maxLength":200,
            "type":"string",
            "description":"Free-form name of the expenditure type derivation precedence set. This name must be unique within a pattern.",
            "nullable":false,
            "x-queryable":true
        },
        "ExpenditureTypeDerivPatternId":{
            "type":"integer",
            "description":"Unique identifier of the expenditure type derivation pattern associated with this precedence set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Precedence":{
            "type":"integer",
            "description":"The precedence number that defines the order in which this set should be applied when the payroll cost is being distributed to projects and the pay element matches the pattern.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PrecedenceId":{
            "type":"integer",
            "description":"The unique identifier of the precedence rule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "expenditureTypes":{
            "title":"Pay Element to Expenditure Type Results",
            "type":"array",
            "description":"The Pay Element Expenditure Type Derivation Precedence Rule Expenditure Types resource is used to view and manage the expenditure type that will be applied to the project cost during distribution to projects.",
            "items":{
                "$ref":"#/components/schemas/payElementExpenditureTypeDerivations-precedenceRules-expenditureTypes-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Pay Element to Expenditure Type Results

Type: array

Title: Pay Element to Expenditure Type Results

The Pay Element Expenditure Type Derivation Precedence Rule Expenditure Types resource is used to view and manage the expenditure type that will be applied to the project cost during distribution to projects.

Show Source

• Array of: object payElementExpenditureTypeDerivations-precedenceRules-expenditureTypes-item-response

{
    "title":"Pay Element to Expenditure Type Results",
    "type":"array",
    "description":"The Pay Element Expenditure Type Derivation Precedence Rule Expenditure Types resource is used to view and manage the expenditure type that will be applied to the project cost during distribution to projects.",
    "items":{
        "$ref":"#/components/schemas/payElementExpenditureTypeDerivations-precedenceRules-expenditureTypes-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 : payElementExpenditureTypeDerivations-precedenceRules-expenditureTypes-item-response

Type: object

Show Source

• DerivResultNumber: integer (int32)
  Read Only: true

  Default Value: 1

  Autogenerated number as a counter within the precedence rule. There must be only one for this type of pattern.
• ExpenditureCategoryId: integer (int64)
  Read Only: true

  Unique identifier of the expenditure category associated with the expenditure type.
• ExpenditureCategoryName: string
  Title: Expenditure Category

  Read Only: true

  Maximum Length: 240

  Name of the expenditure category associated with this expenditure type.
• ExpenditureFromDate: string (date)
  Title: From Date

  Read Only: true

  The date from which this expenditure type is allowed to be used in projects.
• ExpenditureToDate: string (date)
  Title: To Date

  Read Only: true

  The date to which this expenditure type is allowed to be used in projects.
• ExpenditureTypeId: integer (int64)
  The unique identifier of the expenditure type.
• ExpenditureTypeName: string
  Title: Expenditure Type

  Maximum Length: 240

  The name of the expenditure type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PrecedenceId: integer (int64)
  The unique identifier of the precedence set associated with this expenditure type result.
• ResultId: integer (int64)
  Read Only: true

  The unique identifier of the result.

{
    "type":"object",
    "properties":{
        "DerivResultNumber":{
            "type":"integer",
            "description":"Autogenerated number as a counter within the precedence rule. There must be only one for this type of pattern.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ExpenditureCategoryId":{
            "type":"integer",
            "description":"Unique identifier of the expenditure category associated with the expenditure type.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExpenditureCategoryName":{
            "title":"Expenditure Category",
            "maxLength":240,
            "type":"string",
            "description":"Name of the expenditure category associated with this expenditure type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpenditureFromDate":{
            "title":"From Date",
            "type":"string",
            "description":"The date from which this expenditure type is allowed to be used in projects.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpenditureToDate":{
            "title":"To Date",
            "type":"string",
            "description":"The date to which this expenditure type is allowed to be used in projects.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpenditureTypeId":{
            "type":"integer",
            "description":"The unique identifier of the expenditure type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExpenditureTypeName":{
            "title":"Expenditure Type",
            "maxLength":240,
            "type":"string",
            "description":"The name of the expenditure type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrecedenceId":{
            "type":"integer",
            "description":"The unique identifier of the precedence set associated with this expenditure type result.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResultId":{
            "type":"integer",
            "description":"The unique identifier of the result.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "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."
        }
    }
}

Links

expenditureTypes

Operation: /fscmRestApi/resources/11.13.18.05/payElementExpenditureTypeDerivations/{ExpenditureTypeDerivPatternId}/child/precedenceRules/{PrecedenceId}/child/expenditureTypes

Parameters:

• ExpenditureTypeDerivPatternId: $request.path.ExpenditureTypeDerivPatternId
• PrecedenceId: $request.path.PrecedenceId

The Pay Element Expenditure Type Derivation Precedence Rule Expenditure Types resource is used to view and manage the expenditure type that will be applied to the project cost during distribution to projects.

Back to Top