Jump to

• Request
• Response

Create pay elements eligible for project distribution.

post

/fscmRestApi/resources/11.13.18.05/projectPayElements

Request

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Comments: string
  Maximum Length: 4000

  Free-form comments associated with the pay element eligible for project distribution.
• DistributeEndDate: string (date)
  End of the time period when the pay element is eligible for project distribution.
• DistributeStartDate: string (date)
  Start of the time period when the pay element is eligible for project distribution.
• LegislationCode: string
  Legislation Code
• LegislativeDataGroupId: integer
  The unique identifier of the legislative data group of the pay element eligible for project distribution.
• LegislativeDataGroupName: string
  Legislative Data Group
• PayElement: string
  Maximum Length: 80

  Pay Element
• PayElementDistributionId: integer (int64)
  The unique identifier of the pay element eligible for project distribution.
• PayElementName: string
  Maximum Length: 80

  Pay Element Name
• PayElementTypeId: integer (int64)
  The unique identifier of a pay element from the pay element source table.
• TimeCardDistributionBasis: string
  Maximum Length: 30

  Code of the time card distribution basis that indicates which target time cards are eligible to receive pay element costs based on the expenditure type class attribute of the time card transaction. The list of valid values is defined in the lookup type ORA_PJC_TIMECARD_DIST_BASIS.
• TimeCardDistributionBasisName: string
  Maximum Length: 255

  Name of the time card distribution basis that indicates which target time cards are eligible to receive pay element costs based on the expenditure type class attribute of the time card transaction. The list of valid values is defined in the lookup type ORA_PJC_TIMECARD_DIST_BASIS.

{
    "type":"object",
    "properties":{
        "Comments":{
            "maxLength":4000,
            "type":"string",
            "description":"Free-form comments associated with the pay element eligible for project distribution.",
            "nullable":true
        },
        "DistributeEndDate":{
            "type":"string",
            "description":"End of the time period when the pay element is eligible for project distribution.",
            "format":"date",
            "nullable":true
        },
        "DistributeStartDate":{
            "type":"string",
            "description":"Start of the time period when the pay element is eligible for project distribution.",
            "format":"date",
            "nullable":false
        },
        "LegislationCode":{
            "type":"string",
            "description":"Legislation Code",
            "nullable":true
        },
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"The unique identifier of the legislative data group of the pay element eligible for project distribution.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ldgId"
                ]
            }
        },
        "LegislativeDataGroupName":{
            "type":"string",
            "description":"Legislative Data Group",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LdgName"
                ]
            }
        },
        "PayElement":{
            "maxLength":80,
            "type":"string",
            "description":"Pay Element",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PayElementDistributionId":{
            "type":"integer",
            "description":"The unique identifier of the pay element eligible for project distribution.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PayElementName":{
            "maxLength":80,
            "type":"string",
            "description":"Pay Element Name",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PayElementTypeId":{
            "type":"integer",
            "description":"The unique identifier of a pay element from the pay element source table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TimeCardDistributionBasis":{
            "maxLength":30,
            "type":"string",
            "description":"Code of the time card distribution basis that indicates which target time cards are eligible to receive pay element costs based on the expenditure type class attribute of the time card transaction. The list of valid values is defined in the lookup type ORA_PJC_TIMECARD_DIST_BASIS.",
            "nullable":true
        },
        "TimeCardDistributionBasisName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the time card distribution basis that indicates which target time cards are eligible to receive pay element costs based on the expenditure type class attribute of the time card transaction. The list of valid values is defined in the lookup type ORA_PJC_TIMECARD_DIST_BASIS.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Meaning"
                ]
            }
        }
    }
}

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

Type: object

Show Source

• Comments: string
  Maximum Length: 4000

  Free-form comments associated with the pay element eligible for project distribution.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Created By
• CreationDate: string (date-time)
  Read Only: true

  Creation Date
• DistributeEndDate: string (date)
  End of the time period when the pay element is eligible for project distribution.
• DistributeStartDate: string (date)
  Start of the time period when the pay element is eligible for project distribution.
• LastUpdateDate: string (date-time)
  Read Only: true

  Last Updated By
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Last Updated Date
• LegislationCode: string
  Legislation Code
• LegislativeDataGroupId: integer
  The unique identifier of the legislative data group of the pay element eligible for project distribution.
• LegislativeDataGroupName: string
  Legislative Data Group
• links: array Links
  Title: Links

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

  Pay Element
• PayElementDistributionId: integer (int64)
  The unique identifier of the pay element eligible for project distribution.
• PayElementName: string
  Maximum Length: 80

  Pay Element Name
• PayElementTypeId: integer (int64)
  The unique identifier of a pay element from the pay element source table.
• TimeCardDistributionBasis: string
  Maximum Length: 30

  Code of the time card distribution basis that indicates which target time cards are eligible to receive pay element costs based on the expenditure type class attribute of the time card transaction. The list of valid values is defined in the lookup type ORA_PJC_TIMECARD_DIST_BASIS.
• TimeCardDistributionBasisName: string
  Maximum Length: 255

  Name of the time card distribution basis that indicates which target time cards are eligible to receive pay element costs based on the expenditure type class attribute of the time card transaction. The list of valid values is defined in the lookup type ORA_PJC_TIMECARD_DIST_BASIS.

{
    "type":"object",
    "properties":{
        "Comments":{
            "maxLength":4000,
            "type":"string",
            "description":"Free-form comments associated with the pay element eligible for project distribution.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Created By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Creation Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DistributeEndDate":{
            "type":"string",
            "description":"End of the time period when the pay element is eligible for project distribution.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DistributeStartDate":{
            "type":"string",
            "description":"Start of the time period when the pay element is eligible for project distribution.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Last Updated By",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Last Updated Date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LegislationCode":{
            "type":"string",
            "description":"Legislation Code",
            "nullable":true,
            "x-queryable":true
        },
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"The unique identifier of the legislative data group of the pay element eligible for project distribution.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ldgId"
                ]
            },
            "x-queryable":true
        },
        "LegislativeDataGroupName":{
            "type":"string",
            "description":"Legislative Data Group",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LdgName"
                ]
            },
            "x-queryable":true
        },
        "PayElement":{
            "maxLength":80,
            "type":"string",
            "description":"Pay Element",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PayElementDistributionId":{
            "type":"integer",
            "description":"The unique identifier of the pay element eligible for project distribution.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PayElementName":{
            "maxLength":80,
            "type":"string",
            "description":"Pay Element Name",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PayElementTypeId":{
            "type":"integer",
            "description":"The unique identifier of a pay element from the pay element source table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TimeCardDistributionBasis":{
            "maxLength":30,
            "type":"string",
            "description":"Code of the time card distribution basis that indicates which target time cards are eligible to receive pay element costs based on the expenditure type class attribute of the time card transaction. The list of valid values is defined in the lookup type ORA_PJC_TIMECARD_DIST_BASIS.",
            "nullable":true,
            "x-queryable":true
        },
        "TimeCardDistributionBasisName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the time card distribution basis that indicates which target time cards are eligible to receive pay element costs based on the expenditure type class attribute of the time card transaction. The list of valid values is defined in the lookup type ORA_PJC_TIMECARD_DIST_BASIS.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Meaning"
                ]
            },
            "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."
        }
    }
}

Back to Top