Jump to

• Request
• Response
• Examples

Get many Person Assignment Labor Schedule headers.

get

/fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the Person Assignment Labor Schedule header with the specified primary key.
    Finder Variables
    • LaborScheduleId; integer; The unique identifier of the Person Assignment Labor Schedule header.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AssignmentDepartment; string; The department of the assignment.
  • AssignmentId; integer; Unique identifier of the assignment for this Person Assignment Labor Schedule header.
  • AssignmentName; string; Name of the assignment for this Person Assignment Labor Schedule header.
  • AssignmentNumber; string; Number of the assignment for this Person Assignment Labor Schedule header.
  • BusinessUnitId; integer; Unique identifier of the business unit that's used for Element Level labor schedules only.
  • BusinessUnitName; string; Name of the business unit that's associated to the Element Level labor schedule.
  • CreatedBy; string; The user who created the record.
  • CreationDate; string; The date the record was created.
  • LaborScheduleId; integer; The unique identifier of the Person Assignment Labor Schedule header.
  • LaborScheduleName; string; The name of the labor schedule header.
  • LaborScheduleType; string; The name for the labor schedule type that identifies the attributes that drive the distributions.
  • LaborScheduleTypeCode; string; The code for the labor schedule type.
  • LastUpdateDate; string; The date when the record was last updated.
  • LastUpdatedBy; string; The user who last updated the record.
  • LegislativeDataGroupId; integer; Unique identifier of the legislative data group for the pay element.
  • LegislativeDataGroupName; string; Name of the legislative data group associated to the pay element.
  • PayElement; string; The payroll element code for this labor schedule. Applies to labor schedules of type element.
  • PayElementId; integer; The payroll element identifier for this labor schedule. Applies to labor schedules of type element.
  • PayElementName; string; The payroll element name for this labor schedule. Applies to labor schedules of type element.
  • PersonEmail; string; Email of the person.
  • PersonId; integer; Unique identifier of the person.
  • PersonName; string; Full name, first then last, of the person.
  • PersonNumber; string; Human Resources number of the person.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

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 : personAssignmentLaborSchedules

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/personAssignmentLaborSchedules-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object personAssignmentLaborSchedules-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/personAssignmentLaborSchedules-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 : personAssignmentLaborSchedules-item-response

Type: object

Show Source

• AssignmentDepartment: string
  Title: Assignment Department

  Read Only: true

  Maximum Length: 240

  The department of the assignment.
• AssignmentId: integer (int64)
  Unique identifier of the assignment for this Person Assignment Labor Schedule header.
• AssignmentName: string
  Maximum Length: 255

  Name of the assignment for this Person Assignment Labor Schedule header.
• AssignmentNumber: string
  Maximum Length: 255

  Number of the assignment for this Person Assignment Labor Schedule header.
• BusinessUnitId: integer (int64)
  Unique identifier of the business unit that's used for Element Level labor schedules only.
• BusinessUnitName: string
  Title: Business Unit

  Maximum Length: 240

  Name of the business unit that's associated to the Element Level labor schedule.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the record was created.
• LaborScheduleId: integer (int64)
  The unique identifier of the Person Assignment Labor Schedule header.
• LaborScheduleName: string
  Maximum Length: 240

  The name of the labor schedule header.
• LaborScheduleType: string
  Maximum Length: 80

  The name for the labor schedule type that identifies the attributes that drive the distributions.
• LaborScheduleTypeCode: string
  Maximum Length: 30

  The code for the labor schedule type.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LegislativeDataGroupId: integer
  Unique identifier of the legislative data group for the pay element.
• LegislativeDataGroupName: string
  Name of the legislative data group associated to the pay element.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayElement: string
  Title: Element Name

  Maximum Length: 80

  The payroll element code for this labor schedule. Applies to labor schedules of type element.
• PayElementId: integer (int64)
  The payroll element identifier for this labor schedule. Applies to labor schedules of type element.
• PayElementName: string
  Maximum Length: 80

  The payroll element name for this labor schedule. Applies to labor schedules of type element.
• PersonEmail: string
  Title: Email

  Read Only: true

  Maximum Length: 240

  Email of the person.
• PersonId: integer (int64)
  Unique identifier of the person.
• PersonName: string
  Title: Name

  Maximum Length: 240

  Full name, first then last, of the person.
• PersonNumber: string
  Title: Person Number

  Maximum Length: 30

  Human Resources number of the person.
• RuleSource: string
  Maximum Length: 20

  Source of the labor schedule creation. Either UI, REST, or FBDI.
• versions: array Person Assignment Labor Schedule Versions
  Title: Person Assignment Labor Schedule Versions

  The versions resource is used as a child of the Person Assignment Labor Schedules resource to view and manage the versions of labor schedules for a person and assignment combination.

{
    "type":"object",
    "properties":{
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Unique identifier of the legislative data group for the pay element.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "LdgId"
                ]
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleSource":{
            "maxLength":20,
            "type":"string",
            "description":"Source of the labor schedule creation. Either UI, REST, or FBDI.",
            "nullable":true,
            "x-queryable":false
        },
        "PayElementName":{
            "maxLength":80,
            "type":"string",
            "description":"The payroll element name for this labor schedule. Applies to labor schedules of type element.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "EffectiveStartDateElemPEO",
                    "EffectiveEndDateElemPEO"
                ]
            },
            "x-queryable":true
        },
        "LaborScheduleId":{
            "type":"integer",
            "description":"The unique identifier of the Person Assignment Labor Schedule header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LegislativeDataGroupName":{
            "type":"string",
            "description":"Name of the legislative data group associated to the pay element.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LdgName"
                ]
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Unique identifier of the assignment for this Person Assignment Labor Schedule header.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number of the assignment for this Person Assignment Labor Schedule header.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AssignmentNumberPEO"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AssignmentDepartment":{
            "title":"Assignment Department",
            "maxLength":240,
            "type":"string",
            "description":"The department of the assignment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "Language",
                    "EffectiveStartDate",
                    "EffectiveEndDate",
                    "StartDate"
                ]
            },
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of the business unit that's associated to the Element Level labor schedule.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LaborScheduleTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code for the labor schedule type.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Human Resources number of the person.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "EffectiveStartDatePersonDPEO",
                    "EffectiveEndDatePersonDPEO",
                    "StartDate"
                ]
            },
            "x-queryable":true
        },
        "PersonName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Full name, first then last, of the person.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "EffectiveStartDatePersonNameDPEO",
                    "EffectiveEndDatePersonNameDPEO",
                    "StartDate"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PayElementId":{
            "type":"integer",
            "description":"The payroll element identifier for this labor schedule. Applies to labor schedules of type element.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LaborScheduleType":{
            "maxLength":80,
            "type":"string",
            "description":"The name for the labor schedule type that identifies the attributes that drive the distributions.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Unique identifier of the business unit that's used for Element Level labor schedules only.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "LaborScheduleName":{
            "maxLength":240,
            "type":"string",
            "description":"The name of the labor schedule header.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique identifier of the person.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the assignment for this Person Assignment Labor Schedule header.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AssignmentNamePEO"
                ]
            },
            "x-queryable":true
        },
        "versions":{
            "title":"Person Assignment Labor Schedule Versions",
            "type":"array",
            "description":"The versions resource is used as a child of the Person Assignment Labor Schedules resource to view and manage the versions of labor schedules for a person and assignment combination.",
            "items":{
                "$ref":"#/components/schemas/personAssignmentLaborSchedules-versions-item-response"
            }
        },
        "PersonEmail":{
            "title":"Email",
            "maxLength":240,
            "type":"string",
            "description":"Email of the person.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PersonNumber"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PayElement":{
            "title":"Element Name",
            "maxLength":80,
            "type":"string",
            "description":"The payroll element code for this labor schedule. Applies to labor schedules of type element.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "EffectiveStartDateElemPEO",
                    "EffectiveEndDateElemPEO"
                ]
            },
            "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 : Person Assignment Labor Schedule Versions

Type: array

Title: Person Assignment Labor Schedule Versions

The versions resource is used as a child of the Person Assignment Labor Schedules resource to view and manage the versions of labor schedules for a person and assignment combination.

Show Source

• Array of: object personAssignmentLaborSchedules-versions-item-response

{
    "title":"Person Assignment Labor Schedule Versions",
    "type":"array",
    "description":"The versions resource is used as a child of the Person Assignment Labor Schedules resource to view and manage the versions of labor schedules for a person and assignment combination.",
    "items":{
        "$ref":"#/components/schemas/personAssignmentLaborSchedules-versions-item-response"
    }
}

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 : personAssignmentLaborSchedules-versions-item-response

Type: object

Show Source

• BusinessUnitId: integer (int64)
  The business unit identifier derived from the person assignment.
• BusinessUnitLedger: integer (int64)
  Read Only: true

  GL Account for this distribution, if the rule is to a GL account.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the record was created.
• distributionRules: array Person Assignment Labor Schedule Version Rules
  Title: Person Assignment Labor Schedule Version Rules

  The DistributionRule services is used as a child of the Person Assignment Version resource to view and manage the distribution rules for a certain version.
• LaborScheduleId: integer (int64)
  Title: Labor Schedule ID

  Read Only: true

  The unique identifier of the Person Assignment Labor Schedule header.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• VersionComments: string
  Title: Version Comments

  Maximum Length: 4000

  Free form comments associated to the labor schedule version.
• VersionEndDate: string (date)
  Title: Version End Date

  The end date of the labor schedule version.
• VersionId: integer (int64)
  Title: Version ID

  The unique identifier of the labor schedule version.
• VersionName: string
  Title: Version Name

  Maximum Length: 300

  The name of the labor schedule version.
• VersionStartDate: string (date)
  Title: Version Start Date

  The start date of the labor schedule version.
• VersionStatus: string
  Title: Status

  Maximum Length: 80

  The labor schedule version status, such as New, Active or Inactive.
• VersionStatusCode: string
  Title: Version Status Code

  Maximum Length: 30

  The code associated to the labor schedule version status.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionId":{
            "title":"Version ID",
            "type":"integer",
            "description":"The unique identifier of the labor schedule version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "distributionRules":{
            "title":"Person Assignment Labor Schedule Version Rules",
            "type":"array",
            "description":"The DistributionRule services is used as a child of the Person Assignment Version resource to view and manage the distribution rules for a certain version.",
            "items":{
                "$ref":"#/components/schemas/personAssignmentLaborSchedules-versions-distributionRules-item-response"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"The business unit identifier derived from the person assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VersionEndDate":{
            "title":"Version End Date",
            "type":"string",
            "description":"The end date of the labor schedule version.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "VersionStatus":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The labor schedule version status, such as New, Active or Inactive.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LaborScheduleId":{
            "title":"Labor Schedule ID",
            "type":"integer",
            "description":"The unique identifier of the Person Assignment Labor Schedule header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "VersionComments":{
            "title":"Version Comments",
            "maxLength":4000,
            "type":"string",
            "description":"Free form comments associated to the labor schedule version.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "VersionStatusCode":{
            "title":"Version Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The code associated to the labor schedule version status.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "VersionName":{
            "title":"Version Name",
            "maxLength":300,
            "type":"string",
            "description":"The name of the labor schedule version.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "VersionStartDate":{
            "title":"Version Start Date",
            "type":"string",
            "description":"The start date of the labor schedule version.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitLedger":{
            "type":"integer",
            "description":"GL Account for this distribution, if the rule is to a GL account.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Person Assignment Labor Schedule Version Rules

Type: array

Title: Person Assignment Labor Schedule Version Rules

The DistributionRule services is used as a child of the Person Assignment Version resource to view and manage the distribution rules for a certain version.

Show Source

• Array of: object personAssignmentLaborSchedules-versions-distributionRules-item-response

{
    "title":"Person Assignment Labor Schedule Version Rules",
    "type":"array",
    "description":"The DistributionRule services is used as a child of the Person Assignment Version resource to view and manage the distribution rules for a certain version.",
    "items":{
        "$ref":"#/components/schemas/personAssignmentLaborSchedules-versions-distributionRules-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 : personAssignmentLaborSchedules-versions-distributionRules-item-response

Type: object

Show Source

• BillableFlag: boolean
  Maximum Length: 1

  Identifies if the charge is billable or not.
• CapitalizableFlag: boolean
  Maximum Length: 1

  Information that indicates if a project-related item is eligible for capitalization.
• ChartOfAccountsId: integer
  GL Account for this distribution, if the rule is to a GL account.
• ContextCategory: string
  Maximum Length: 40

  Default Value: PJC_Labor_Distribution

  Identifies the descriptive flexfield application context for project-related standardized cost collection.
• ContractId: integer (int64)
  Identifier of contract, used with Oracle Contract Billing or Oracle Grants Management.
• ContractLineId: integer (int64)
  Tracks contract line information. Not used currently.
• ContractName: string
  Title: Contract Name

  Maximum Length: 300

  Name associated to the contract ID.
• ContractNumber: string
  Title: Contract Number

  Maximum Length: 120

  Number associated to the contract ID.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date the record was created.
• DistributionRuleId: integer (int64)
  Primary key of distribution rule concatenated with the Line Number to make it unique.
• ExpenditureItemDate: string (date-time)
  Date on which a project-related transaction is incurred.
• ExpenditureOrganizationId: integer (int64)
  Identifier for expenditure organization used to build the transaction descriptive flexfield for project-related transaction distributions.
• ExpenditureOrganizationName: string
  Title: Expenditure Organization

  Maximum Length: 240

  Name for expenditure organization.
• ExpenditureTypeId: integer (int64)
  Title: Expenditure Type

  Expenditure type used to build the transaction descriptive flexfield for project-related transaction distributions.
• ExpenditureTypeName: string
  Title: Expenditure Type

  Maximum Length: 240

  Name of the expenditure type for this cost distribution.
• FundingAllocationId: integer (int64)
  Specifies the name of the project funding override. Not used currently.
• FundingSourceId: string
  Maximum Length: 150

  Identifier of the funding source for this distribution.
• FundingSourceName: string
  Title: Funding Source Name

  Maximum Length: 360

  Funding source name.
• FundingSourceNumber: string
  Title: Funding Source Number

  Maximum Length: 50

  Funding source number associated to this distribution.
• GLAccount: string
  GL Account for this distribution, if the rule is to a GL account.
• GLAccountCombinationId: integer (int64)
  The GL Account code combination identifier, if the rule is set to a GL account.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LineNumber: integer
  Primary key of distribution rule concatenated with the DistributionRuleID to make it unique.
• LinePercent: number
  Default Value: 0

  The percentage for this distribution rule, to be applied to the total cost for distribution.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectId: integer (int64)
  Identifier of the project for this distribution rule, if it's a project distribution.
• ProjectName: string
  Title: Project Name

  Maximum Length: 240

  Name of the project associated to this distribution if it's a project distribution.
• ProjectNumber: string
  Title: Project Number

  Maximum Length: 25

  Number of the project associated to this distribution if it's a project distribution.
• TaskId: integer (int64)
  Title: Task

  Identifier of the task for this distribution rule, if it's a project distribution.
• TaskName: string
  Title: Task Name

  Maximum Length: 255

  Name of the task associated to this distribution if it's a project distribution.
• TaskNumber: string
  Title: Task Number

  Maximum Length: 100

  Task number associated with this distribution.
• WorkTypeId: integer (int64)
  Identifier for project-related classification of the worked performed.
• WorkTypeName: string
  Title: Work Type

  Read Only: true

  Maximum Length: 240

  Name for project-related classification of the worked performed.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractNumber":{
            "title":"Contract Number",
            "maxLength":120,
            "type":"string",
            "description":"Number associated to the contract ID.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ProjectId"
                ]
            },
            "x-queryable":true
        },
        "TaskId":{
            "title":"Task",
            "type":"integer",
            "description":"Identifier of the task for this distribution rule, if it's a project distribution.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ProjectId"
                ]
            },
            "x-queryable":true
        },
        "ContextCategory":{
            "maxLength":40,
            "type":"string",
            "description":"Identifies the descriptive flexfield application context for project-related standardized cost collection.",
            "nullable":true,
            "default":"PJC_Labor_Distribution",
            "x-queryable":true
        },
        "ProjectName":{
            "title":"Project Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the project associated to this distribution if it's a project distribution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContractLineId":{
            "type":"integer",
            "description":"Tracks contract line information. Not used currently.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LineNumber":{
            "type":"integer",
            "description":"Primary key of distribution rule concatenated with the DistributionRuleID to make it unique.",
            "nullable":false,
            "x-queryable":true
        },
        "WorkTypeId":{
            "type":"integer",
            "description":"Identifier for project-related classification of the worked performed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LinePercent":{
            "type":"number",
            "description":"The percentage for this distribution rule, to be applied to the total cost for distribution.",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":5,
                "scale":2
            },
            "x-queryable":true
        },
        "CapitalizableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Information that indicates if a project-related item is eligible for capitalization.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DistributionRuleId":{
            "type":"integer",
            "description":"Primary key of distribution rule concatenated with the Line Number to make it unique.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FundingAllocationId":{
            "type":"integer",
            "description":"Specifies the name of the project funding override. Not used currently.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":25,
            "type":"string",
            "description":"Number of the project associated to this distribution if it's a project distribution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProjectId":{
            "type":"integer",
            "description":"Identifier of the project for this distribution rule, if it's a project distribution.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":100,
            "type":"string",
            "description":"Task number associated with this distribution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Identifies if the charge is billable or not.",
            "nullable":true,
            "x-queryable":true
        },
        "GLAccount":{
            "type":"string",
            "description":"GL Account for this distribution, if the rule is to a GL account.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.projects.costing.setup.laborDistributions.restModel.view.PersonAssignmentDistributionRuleVO#GlAccountFlexField",
                "FND_ACFF_ResourceName":"personAssignmentLaborSchedules",
                "ojStructureInstanceNumber":"ChartOfAccountsId"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            },
            "x-queryable":true
        },
        "ChartOfAccountsId":{
            "type":"integer",
            "description":"GL Account for this distribution, if the rule is to a GL account.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ExpenditureOrganizationId"
                ]
            },
            "x-queryable":true
        },
        "WorkTypeName":{
            "title":"Work Type",
            "maxLength":240,
            "type":"string",
            "description":"Name for project-related classification of the worked performed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractId":{
            "type":"integer",
            "description":"Identifier of contract, used with Oracle Contract Billing or Oracle Grants Management.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ProjectId"
                ]
            },
            "x-queryable":true
        },
        "GLAccountCombinationId":{
            "type":"integer",
            "description":"The GL Account code combination identifier, if the rule is set to a GL account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_CCID":"GlAccountFlexField",
                "precision":18
            },
            "x-queryable":true
        },
        "FundingSourceName":{
            "title":"Funding Source Name",
            "maxLength":360,
            "type":"string",
            "description":"Funding source name.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ContractId",
                    "ProjectId"
                ]
            },
            "x-queryable":true
        },
        "ContractName":{
            "title":"Contract Name",
            "maxLength":300,
            "type":"string",
            "description":"Name associated to the contract ID.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ProjectId"
                ]
            },
            "x-queryable":true
        },
        "ExpenditureItemDate":{
            "type":"string",
            "description":"Date on which a project-related transaction is incurred.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "FundingSourceId":{
            "maxLength":150,
            "type":"string",
            "description":"Identifier of the funding source for this distribution.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ContractId",
                    "ProjectId"
                ]
            },
            "x-queryable":true
        },
        "FundingSourceNumber":{
            "title":"Funding Source Number",
            "maxLength":50,
            "type":"string",
            "description":"Funding source number associated to this distribution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ContractId",
                    "ProjectId"
                ]
            },
            "x-queryable":true
        },
        "ExpenditureTypeId":{
            "title":"Expenditure Type",
            "type":"integer",
            "description":"Expenditure type used to build the transaction descriptive flexfield for project-related transaction distributions.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExpenditureTypeName":{
            "title":"Expenditure Type",
            "maxLength":240,
            "type":"string",
            "description":"Name of the expenditure type for this cost distribution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ExpenditureOrganizationName":{
            "title":"Expenditure Organization",
            "maxLength":240,
            "type":"string",
            "description":"Name for expenditure organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "OrgId"
                ]
            },
            "x-queryable":true
        },
        "TaskName":{
            "title":"Task Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the task associated to this distribution if it's a project distribution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ProjectId"
                ]
            },
            "x-queryable":true
        },
        "ExpenditureOrganizationId":{
            "type":"integer",
            "description":"Identifier for expenditure organization used to build the transaction descriptive flexfield for project-related transaction distributions.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "GLAccountCombinationId"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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"
    }
}

Back to Top

Examples

The following example shows how to get many person assignment labor schedule headers by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules

Response Body Example

The following shows an example of the response body in JSON format of all project templates.

{
  "items": [
    {
      "LaborScheduleId": 300100185256941,
      "LaborScheduleName": "MW PMan - Element Updated",
      "PersonId": 300100170330656,
      "PersonNumber": "955160008191117",
      "PersonName": "Malvin Wiley",
      "PersonEmail": "[e-mail]",
      "AssignmentId": 300100170330674,
      "AssignmentNumber": "E955160008191117",
      "AssignmentName": "Consultant",
      "AssignmentDepartment": "Vision City Administration",
      "CreatedBy": "Ldboth",
      "CreationDate": "2020-03-27T21:21:58+00:00",
      "LastUpdateDate": "2020-03-30T07:59:22+00:00",
      "LastUpdatedBy": "Ldboth",
      "links": [
        {
          "rel": "self",
          "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/300100185256941",
          "name": "personAssignmentLaborSchedules",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
          }
        },
        {
          "rel": "canonical",
          "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/300100185256941",
          "name": "personAssignmentLaborSchedules",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules/300100185256941/child/versions",
          "name": "versions",
          "kind": "collection"
        }
      ]
    },
    ...
  ],
  "count": 25,
  "hasMore": true,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/personAssignmentLaborSchedules",
      "name": "personAssignmentLaborSchedules",
      "kind": "collection"
    }
  ]
}

Back to Top