Jump to

• Request
• Response
• Examples

Get all project enterprise labor resources

get

/fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}

Request

Path Parameters

• projectEnterpriseLaborResourcesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Project Enterprise Labor Resources resource and used to uniquely identify an instance of Project Enterprise Labor Resources. The client should not generate the hash key value. Instead, the client should query on the Project Enterprise Labor Resources collection resource in order to navigate to a specific instance of Project Enterprise Labor Resources to get the hash key.

Query Parameters

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

Header Parameters

• Metadata-Context:
  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 : projectEnterpriseLaborResources-item-response

Type: object

Show Source

• Attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• BillRate: number
  Title: Bill Rate

  The amount paid to a business by its customer for a unit of work completed by the project enterprise resource.
• BillRateCurrencyCode: string
  Title: Bill Rate Currency Code

  Maximum Length: 15

  Code of the currency used to define the bill rate of the project enterprise resource. If no value is passed, the default value is set to the Default Currency field value from the Project Management Implementation Options setup page.
• CalendarId: integer (int64)
  Title: Calendar ID

  Identifier of the calendar that establishes the normal working days, hours, and exceptions for a project enterprise resource. If no value is passed, the default value is set to the Resource Calendar field value from the Project Management Implementation Options setup page.
• CalendarName: string
  Title: Calendar

  Name of the calendar that establishes the normal working days, hours, and exceptions for a project enterprise resource.
• CostRate: number
  Title: Cost Rate

  The cost of a unit of work by the project enterprise resource.
• CostRateCurrencyCode: string
  Title: Cost Rate Currency Code

  Maximum Length: 15

  Code of the currency used to define the cost rate of the project enterprise resource. If no value is passed, the default value is set to the Default Currency field value from the Project Management Implementation Options setup page.
• Email: string
  Title: Email

  Maximum Length: 240

  Email address of the project enterprise resource. Mandatory for POST operation if the resource isn't created from an existing HCM person.
• ExternalId: string
  Title: External ID

  Maximum Length: 240

  Identifier of the project enterprise resource in the external application.
• FirstName: string
  Title: First Name

  Maximum Length: 150

  First name of the project enterprise resource. In POST operation, if the resource isn't created from an existing HCM person, then either pass First Name and Last Name or the Resource Name.
• FromDate: string (date)
  Title: From Date

  The date from which you can assign the project enterprise resource to a project.
• HCMPersonName: string
  Title: HCM Person

  Maximum Length: 240

  Name of the person in HCM for the project enterprise resource.
• HCMPersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 30

  Number of the HCM person associated with the project enterprise resource.
• LastName: string
  Title: Last Name

  Maximum Length: 150

  Last name of the project enterprise resource. In POST operation, if the resource isn't created from an existing HCM person, then either pass First Name and Last Name or the Resource Name.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManagerEmail: string
  Title: Manager Email

  Maximum Length: 240

  Email address of the person who is the manager of the project enterprise resource.
• ManageResourceStaffingFlag: boolean
  Title: Manage Resource Staffing Indicator

  Maximum Length: 1

  Indicates whether the project enterprise resource is eligible for staffing. The valid values are Y and N.
• ManagerId: integer (int64)
  Title: Manager ID

  Identifier of the person who is the manager of the project enterprise resource.
• ManagerName: string
  Title: Manager

  Maximum Length: 240

  Name of the person who is the manager of the project enterprise resource.
• PersonAssignmentDetails: array Project Enterprise Resource HCM Assignment Details
  Title: Project Enterprise Resource HCM Assignment Details

  The Project Enterprise Resource HCM Assignment Details resource is used to view primary HCM assignment details such as business unit, organization, job, or manager related to the enterprise labor resource.
• PersonId: integer (int64)
  Title: Person ID

  Identifier of the HCM person associated with the project enterprise resource. You can provide the Person ID or the Person Number in the POST operation to create a resource from an existing HCM person. Person ID takes precedence over Person Number.
• PersonNumber: string
  Title: Person Number

  Unique number of the person associated with the project enterprise resource. You can provide the Person ID or the Person Number in the POST operation to create a resource from an existing HCM person. Person ID takes precedence over Person Number.
• PhoneNumber: string
  Title: Phone

  Maximum Length: 240

  The phone number of the project enterprise resource.
• PoolMembershipFromDate: string (date)
  Title: Membership From Date

  Start date of the resource pool membership for the project enterprise resource. You can pass a value only if ManageResourceScheduleFlag is passed as Y. The default value is set to system date if no value is passed.
• PoolName: string
  Title: Resource Pool

  Read Only: true

  Maximum Length: 240

  Name of the resource pool associated to the project enterprise resource.
• PrimaryProjectRoleId: integer (int64)
  Title: Primary Project Role ID

  Default Value: 13

  Identifier of the primary role for the project enterprise resource.
• PrimaryProjectRoleName: string
  Title: Primary Project Role

  Maximum Length: 240

  Name of the primary role for the project enterprise resource.
• ProjectEnterpriseResourceImage: array Project Enterprise Resource Image
  Title: Project Enterprise Resource Image

  The Project Enterprise Resource Image is used to view and create project enterprise resource image.
• ProjectId: integer (int64)
  Title: Project ID

  Identifier of the project associated to the project enterprise resource.
• ProjectName: string
  Title: Project Name

  Read Only: true

  Maximum Length: 240

  Name of the project associated to the project enterprise resource.
• ResourceCalendars: array Project Enterprise Resource Calendars
  Title: Project Enterprise Resource Calendars

  The Project Enterprise Resource Calendars resource is used to view calendars of a Project Enterprise Resource which are single workday pattern and single shift. A calendar is used when scheduling or staffing a Project Enterprise Resource.
• ResourceId: integer (int64)
  Title: Resource ID

  Identifier of the project enterprise resource.
• ResourceName: string
  Title: Resource Name

  Maximum Length: 240

  Name of the project enterprise resource. Mandatory for POST operation if the resource isn't created from an existing HCM person and if First Name and Last Name are not populated.
• ResourcePoolId: integer (int64)
  Title: Resource Pool ID

  Identifier of the resource pool for the resource pool membership. You can pass a value only if ManageResourceScheduleFlag is passed as Y. The default value is set to Resources with No Pool Membership if no resource pool ID is passed.
• ResourcePoolMembership: array Project Enterprise Resource Pool Membership
  Title: Project Enterprise Resource Pool Membership

  The Project Enterprise Resource Pool Membership resource is used to view resource pools where the Project Enterprise Resource has present, past, or future memberships.
• ResourcePoolName: string
  Title: Resource Pool

  Name of the resource pool for the resource pool membership.
• ToDate: string (date)
  Title: To Date

  The last date that you can assign the project enterprise resource to a project.

{
    "type":"object",
    "properties":{
        "Email":{
            "title":"Email",
            "maxLength":"240",
            "type":"string",
            "description":"Email address of the project enterprise resource. Mandatory for POST operation if the resource isn't created from an existing HCM person.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectName":{
            "title":"Project Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project associated to the project enterprise resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryProjectRoleId":{
            "title":"Primary Project Role ID",
            "type":"integer",
            "description":"Identifier of the primary role for the project enterprise resource.",
            "format":"int64",
            "nullable":true,
            "default":"13",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project enterprise resource. Mandatory for POST operation if the resource isn't created from an existing HCM person and if First Name and Last Name are not populated.",
            "nullable":false,
            "x-queryable":true
        },
        "ManagerName":{
            "title":"Manager",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the person who is the manager of the project enterprise resource.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ManagerEmail":{
            "title":"Manager Email",
            "maxLength":"240",
            "type":"string",
            "description":"Email address of the person who is the manager of the project enterprise resource.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CalendarId":{
            "title":"Calendar ID",
            "type":"integer",
            "description":"Identifier of the calendar that establishes the normal working days, hours, and exceptions for a project enterprise resource. If no value is passed, the default value is set to the Resource Calendar field value from the Project Management Implementation Options setup page.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourcePoolName":{
            "title":"Resource Pool",
            "type":"string",
            "description":"Name of the resource pool for the resource pool membership.",
            "nullable":true,
            "x-queryable":true
        },
        "CalendarName":{
            "title":"Calendar",
            "type":"string",
            "description":"Name of the calendar that establishes the normal working days, hours, and exceptions for a project enterprise resource.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/projectEnterpriseLaborResources-Attachments-item-response"
            }
        },
        "CostRateCurrencyCode":{
            "title":"Cost Rate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Code of the currency used to define the cost rate of the project enterprise resource. If no value is passed, the default value is set to the Default Currency field value from the Project Management Implementation Options setup page.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PoolName":{
            "title":"Resource Pool",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the resource pool associated to the project enterprise resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResourcePoolId":{
            "title":"Resource Pool ID",
            "type":"integer",
            "description":"Identifier of the resource pool for the resource pool membership. You can pass a value only if ManageResourceScheduleFlag is passed as Y. The default value is set to Resources with No Pool Membership if no resource pool ID is passed.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "type":"string",
            "description":"Unique number of the person associated with the project enterprise resource. You can provide the Person ID or the Person Number in the POST operation to create a resource from an existing HCM person. Person ID takes precedence over Person Number.",
            "nullable":true,
            "x-queryable":true
        },
        "PoolMembershipFromDate":{
            "title":"Membership From Date",
            "type":"string",
            "description":"Start date of the resource pool membership for the project enterprise resource. You can pass a value only if ManageResourceScheduleFlag is passed as Y. The default value is set to system date if no value is passed.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryProjectRoleName":{
            "title":"Primary Project Role",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the primary role for the project enterprise resource.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CostRate":{
            "title":"Cost Rate",
            "type":"number",
            "description":"The cost of a unit of work by the project enterprise resource.",
            "nullable":true,
            "x-hints":{
                "precision":"22",
                "scale":"5"
            },
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":"150",
            "type":"string",
            "description":"First name of the project enterprise resource. In POST operation, if the resource isn't created from an existing HCM person, then either pass First Name and Last Name or the Resource Name.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalId":{
            "title":"External ID",
            "maxLength":"240",
            "type":"string",
            "description":"Identifier of the project enterprise resource in the external application.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Identifier of the project associated to the project enterprise resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillRateCurrencyCode":{
            "title":"Bill Rate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Code of the currency used to define the bill rate of the project enterprise resource. If no value is passed, the default value is set to the Default Currency field value from the Project Management Implementation Options setup page.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ResourceCalendars":{
            "title":"Project Enterprise Resource Calendars",
            "type":"array",
            "description":"The Project Enterprise Resource Calendars resource is used to view calendars of a Project Enterprise Resource which are single workday pattern and single shift. A calendar is used when scheduling or staffing a Project Enterprise Resource.",
            "items":{
                "$ref":"#/components/schemas/projectEnterpriseLaborResources-ResourceCalendars-item-response"
            }
        },
        "ProjectEnterpriseResourceImage":{
            "title":"Project Enterprise Resource Image",
            "type":"array",
            "description":"The Project Enterprise Resource Image is used to view and create project enterprise resource image.",
            "items":{
                "$ref":"#/components/schemas/projectEnterpriseLaborResources-ProjectEnterpriseResourceImage-item-response"
            }
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"Identifier of the HCM person associated with the project enterprise resource. You can provide the Person ID or the Person Number in the POST operation to create a resource from an existing HCM person. Person ID takes precedence over Person Number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"Identifier of the project enterprise resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "HCMPersonName":{
            "title":"HCM Person",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the person in HCM for the project enterprise resource.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ManageResourceStaffingFlag":{
            "title":"Manage Resource Staffing Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the project enterprise resource is eligible for staffing. The valid values are Y and N.",
            "nullable":true,
            "x-queryable":true
        },
        "HCMPersonNumber":{
            "title":"Person Number",
            "maxLength":"30",
            "type":"string",
            "description":"Number of the HCM person associated with the project enterprise resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillRate":{
            "title":"Bill Rate",
            "type":"number",
            "description":"The amount paid to a business by its customer for a unit of work completed by the project enterprise resource.",
            "nullable":true,
            "x-hints":{
                "precision":"22",
                "scale":"5"
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":"240",
            "type":"string",
            "description":"The phone number of the project enterprise resource.",
            "nullable":true,
            "x-queryable":true
        },
        "FromDate":{
            "title":"From Date",
            "type":"string",
            "description":"The date from which you can assign the project enterprise resource to a project.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ToDate":{
            "title":"To Date",
            "type":"string",
            "description":"The last date that you can assign the project enterprise resource to a project.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":"150",
            "type":"string",
            "description":"Last name of the project enterprise resource. In POST operation, if the resource isn't created from an existing HCM person, then either pass First Name and Last Name or the Resource Name.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonAssignmentDetails":{
            "title":"Project Enterprise Resource HCM Assignment Details",
            "type":"array",
            "description":"The Project Enterprise Resource HCM Assignment Details resource is used to view primary HCM assignment details such as business unit,  organization, job, or manager related to the enterprise labor resource.",
            "items":{
                "$ref":"#/components/schemas/projectEnterpriseLaborResources-PersonAssignmentDetails-item-response"
            }
        },
        "ResourcePoolMembership":{
            "title":"Project Enterprise Resource Pool Membership",
            "type":"array",
            "description":"The Project Enterprise Resource Pool Membership resource is used to view resource pools where the Project Enterprise Resource has present, past, or future memberships.",
            "items":{
                "$ref":"#/components/schemas/projectEnterpriseLaborResources-ResourcePoolMembership-item-response"
            }
        },
        "ManagerId":{
            "title":"Manager ID",
            "type":"integer",
            "description":"Identifier of the person who is the manager of the project enterprise resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object projectEnterpriseLaborResources-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/projectEnterpriseLaborResources-Attachments-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 : Project Enterprise Resource HCM Assignment Details

Type: array

Title: Project Enterprise Resource HCM Assignment Details

The Project Enterprise Resource HCM Assignment Details resource is used to view primary HCM assignment details such as business unit, organization, job, or manager related to the enterprise labor resource.

Show Source

• Array of: object projectEnterpriseLaborResources-PersonAssignmentDetails-item-response

{
    "title":"Project Enterprise Resource HCM Assignment Details",
    "type":"array",
    "description":"The Project Enterprise Resource HCM Assignment Details resource is used to view primary HCM assignment details such as business unit,  organization, job, or manager related to the enterprise labor resource.",
    "items":{
        "$ref":"#/components/schemas/projectEnterpriseLaborResources-PersonAssignmentDetails-item-response"
    }
}

Nested Schema : Project Enterprise Resource Image

Type: array

Title: Project Enterprise Resource Image

The Project Enterprise Resource Image is used to view and create project enterprise resource image.

Show Source

• Array of: object projectEnterpriseLaborResources-ProjectEnterpriseResourceImage-item-response

{
    "title":"Project Enterprise Resource Image",
    "type":"array",
    "description":"The Project Enterprise Resource Image is used to view and create project enterprise resource image.",
    "items":{
        "$ref":"#/components/schemas/projectEnterpriseLaborResources-ProjectEnterpriseResourceImage-item-response"
    }
}

Nested Schema : Project Enterprise Resource Calendars

Type: array

Title: Project Enterprise Resource Calendars

The Project Enterprise Resource Calendars resource is used to view calendars of a Project Enterprise Resource which are single workday pattern and single shift. A calendar is used when scheduling or staffing a Project Enterprise Resource.

Show Source

• Array of: object projectEnterpriseLaborResources-ResourceCalendars-item-response

{
    "title":"Project Enterprise Resource Calendars",
    "type":"array",
    "description":"The Project Enterprise Resource Calendars resource is used to view calendars of a Project Enterprise Resource which are single workday pattern and single shift. A calendar is used when scheduling or staffing a Project Enterprise Resource.",
    "items":{
        "$ref":"#/components/schemas/projectEnterpriseLaborResources-ResourceCalendars-item-response"
    }
}

Nested Schema : Project Enterprise Resource Pool Membership

Type: array

Title: Project Enterprise Resource Pool Membership

The Project Enterprise Resource Pool Membership resource is used to view resource pools where the Project Enterprise Resource has present, past, or future memberships.

Show Source

• Array of: object projectEnterpriseLaborResources-ResourcePoolMembership-item-response

{
    "title":"Project Enterprise Resource Pool Membership",
    "type":"array",
    "description":"The Project Enterprise Resource Pool Membership resource is used to view resource pools where the Project Enterprise Resource has present, past, or future memberships.",
    "items":{
        "$ref":"#/components/schemas/projectEnterpriseLaborResources-ResourcePoolMembership-item-response"
    }
}

Nested Schema : projectEnterpriseLaborResources-Attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

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

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

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

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : projectEnterpriseLaborResources-PersonAssignmentDetails-item-response

Type: object

Show Source

• AssignmentId: integer (int64)
  Title: Assignment ID

  Read Only: true

  Unique identifier for the HCM person assignment.
• AssignmentName: string
  Title: Assignment Name

  Read Only: true

  Maximum Length: 80

  Translated name of the HCM person assignment.
• AssignmentNumber: string
  Title: Assignment Number

  Read Only: true

  Maximum Length: 30

  Number identifying the person assignment.
• AssignmentStatusType: string
  Title: Assignment Status Type

  Read Only: true

  Maximum Length: 30

  HR status of the HCM person assignment, such as Active, Inactive, and Suspended.
• AssignmentType: string
  Title: Assignment Type

  Read Only: true

  Maximum Length: 30

  Assignment type. The valid values are E for employee and C for contingent worker.
• BusinessUnitId: integer (int64)
  Title: Business Unit Id

  Read Only: true

  Unique identifier for the business unit.
• BusinessUnitName: string
  Title: Business Unit Name

  Read Only: true

  Maximum Length: 240

  Translated name of the business unit.
• DepartmentName: string
  Title: Department Name

  Read Only: true

  Maximum Length: 240

  Translated name of the department.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  Read Only: true

  End date of the period within which the HCM resource assignment is effective.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  Read Only: true

  Start date of the period within which the HCM resource assignment is effective.
• JobId: integer (int64)
  Title: Job Id

  Read Only: true

  Unique identifier of the job.
• JobName: string
  Title: Job Name

  Read Only: true

  Maximum Length: 240

  Name of the job.
• LineManagerName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the person who is the line manager of the project enterprise resource.
• LineManagerPersonId: integer (int64)
  Read Only: true

  Identifier of the person who is the line manager of the project enterprise resource.
• links: array Links
  Title: Links

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

  Unique identifier for location
• LocationName: string
  Title: Location Name

  Read Only: true

  Maximum Length: 240

  Name of location
• OrganizationId: integer (int64)
  Title: Organization ID

  Read Only: true

  Unique identifier of the department.
• UserPersonType: string
  Title: User Person Type

  Read Only: true

  Maximum Length: 80

  Unique identifier of the employment type. The valid values are E for employees and C for the contingent workers.

{
    "type":"object",
    "properties":{
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"End date of the period within which the HCM resource assignment is effective.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentStatusType":{
            "title":"Assignment Status Type",
            "maxLength":"30",
            "type":"string",
            "description":"HR status of the HCM person assignment, such as Active, Inactive, and Suspended.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "title":"Business Unit Id",
            "type":"integer",
            "description":"Unique identifier for the business unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "JobName":{
            "title":"Job Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the job.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationId":{
            "type":"integer",
            "description":"Unique identifier for location",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserPersonType":{
            "title":"User Person Type",
            "maxLength":"80",
            "type":"string",
            "description":"Unique identifier of the employment type. The valid values are E for employees and C for the contingent workers.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"Unique identifier of the department.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LocationName":{
            "title":"Location Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of location",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentName":{
            "title":"Assignment Name",
            "maxLength":"80",
            "type":"string",
            "description":"Translated name of the HCM person assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "maxLength":"30",
            "type":"string",
            "description":"Assignment type. The valid values are E for employee and C for contingent worker.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentId":{
            "title":"Assignment ID",
            "type":"integer",
            "description":"Unique identifier for the HCM person assignment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignmentNumber":{
            "title":"Assignment Number",
            "maxLength":"30",
            "type":"string",
            "description":"Number identifying the person assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineManagerName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the person who is the line manager of the project enterprise resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentName":{
            "title":"Department Name",
            "maxLength":"240",
            "type":"string",
            "description":"Translated name of the department.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":"240",
            "type":"string",
            "description":"Translated name of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineManagerPersonId":{
            "type":"integer",
            "description":"Identifier of the person who is the line manager of the project enterprise resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Start date of the period within which the HCM resource assignment is effective.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobId":{
            "title":"Job Id",
            "type":"integer",
            "description":"Unique identifier of the job.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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 : projectEnterpriseLaborResources-ProjectEnterpriseResourceImage-item-response

Type: object

Show Source

• Image: string (byte)
  Title: Image

  Image of the project enterprise resource.
• ImageId: integer (int64)
  Title: Image ID

  Identifier of the project enterprise resource image.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResourceId: integer (int64)
  Identifier of the project enterprise resource.

{
    "type":"object",
    "properties":{
        "ImageId":{
            "title":"Image ID",
            "type":"integer",
            "description":"Identifier of the project enterprise resource image.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Image":{
            "title":"Image",
            "type":"string",
            "description":"Image of the project enterprise resource.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ResourceId":{
            "type":"integer",
            "description":"Identifier of the project enterprise resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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 : projectEnterpriseLaborResources-ResourceCalendars-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active Indicator

  Read Only: true

  Indicates if the calendar is active.
• CalendarExceptions: array Project Enterprise Resource Calendar Exceptions
  Title: Project Enterprise Resource Calendar Exceptions

  The Project Enterprise Resource Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used to define holidays or exceptional working days on a weekend. A calendar could have many exceptions.
• CalendarId: integer (int64)
  Title: Calendar ID

  Read Only: true

  Unique identifier of the calendar.
• CategoryCode: string
  Title: Calendar Category Code

  Read Only: true

  Maximum Length: 30

  The category used for the calendar.
• Description: string
  Title: Calendar Description

  Read Only: true

  Maximum Length: 2000

  Description of the calendar.
• EffectiveFromDate: string (date)
  Title: Effective from Date

  Read Only: true

  The date from which the calendar is effective.
• EffectiveToDate: string (date)
  Title: Effective to Date

  Read Only: true

  The inclusive last date of the effectivity of the calendar.
• FirstDayOfWeek: integer
  Title: First Day of Week for Calendar

  Read Only: true

  The index of the first day in the week: 1 for Sunday, 2 for Monday, 3 for Tuesday, and so on. The default value is 2.
• FridayWorkFlag: boolean
  Title: Friday Work Indicator

  Read Only: true

  Indicates if Fridays are workable. True if it's workable, False if it's not.
• HoursPerDay: number
  Title: Hours per Day

  Read Only: true

  Number of working hours in a day. Value depends on the number of hours in the shift.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MondayWorkFlag: boolean
  Title: Monday Work Indicator

  Read Only: true

  Indicates if Mondays are workable. True if it is workable, False if it is not.
• Name: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the calendar.
• QuaterlyTypeCode: string
  Title: Quarterly Type Code

  Read Only: true

  Maximum Length: 30

  Indicates the quarter type of the calendar.
• SaturdayWorkFlag: boolean
  Title: Saturday Work Indicator

  Read Only: true

  Indicates if Saturdays are workable. True if it is workable, False if it is not.
• SundayWorkFlag: boolean
  Title: Sunday Work Indicator

  Read Only: true

  Indicates if Sundays are workable. True if it is workable, False if it is not.
• ThursdayWorkFlag: boolean
  Title: Thursday Work Indicator

  Read Only: true

  Indicates if Thursdays are workable. True if it is workable, False if it is not.
• TuesdayWorkFlag: boolean
  Title: Tuesday Work Indicator

  Read Only: true

  Indicates if Tuesdays are workable. True if it is workable, False if it is not.
• WednesdayWorkFlag: boolean
  Title: Wednesday Work Indicator

  Read Only: true

  Indicates if Wednesdays are workable. True if it is workable, False if it is not.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Calendar Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"The category used for the calendar.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WednesdayWorkFlag":{
            "title":"Wednesday Work Indicator",
            "type":"boolean",
            "description":"Indicates if Wednesdays are workable. True if it is workable, False if it is not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Calendar Description",
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the calendar.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SaturdayWorkFlag":{
            "title":"Saturday Work Indicator",
            "type":"boolean",
            "description":"Indicates if Saturdays are workable. True if it is workable, False if it is not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuaterlyTypeCode":{
            "title":"Quarterly Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the quarter type of the calendar.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SundayWorkFlag":{
            "title":"Sunday Work Indicator",
            "type":"boolean",
            "description":"Indicates if Sundays are workable. True if it is workable, False if it is not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HoursPerDay":{
            "title":"Hours per Day",
            "type":"number",
            "description":"Number of working hours in a day. Value depends on the number of hours in the shift.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalendarId":{
            "title":"Calendar ID",
            "type":"integer",
            "description":"Unique identifier of the calendar.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CalendarExceptions":{
            "title":"Project Enterprise Resource Calendar Exceptions",
            "type":"array",
            "description":"The Project Enterprise Resource Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used to define holidays or exceptional working days on a weekend. A calendar could have many exceptions.",
            "items":{
                "$ref":"#/components/schemas/projectEnterpriseLaborResources-ResourceCalendars-CalendarExceptions-item-response"
            }
        },
        "MondayWorkFlag":{
            "title":"Monday Work Indicator",
            "type":"boolean",
            "description":"Indicates if Mondays are workable. True if it is workable, False if it is not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active Indicator",
            "type":"boolean",
            "description":"Indicates if the calendar is active.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TuesdayWorkFlag":{
            "title":"Tuesday Work Indicator",
            "type":"boolean",
            "description":"Indicates if Tuesdays are workable. True if it is workable, False if it is not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the calendar.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveFromDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date from which the calendar is effective.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FridayWorkFlag":{
            "title":"Friday Work Indicator",
            "type":"boolean",
            "description":"Indicates if Fridays are workable. True if it's workable, False if it's not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveToDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The inclusive last date of the effectivity of the calendar.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ThursdayWorkFlag":{
            "title":"Thursday Work Indicator",
            "type":"boolean",
            "description":"Indicates if Thursdays are workable. True if it is workable, False if it is not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstDayOfWeek":{
            "title":"First Day of Week for Calendar",
            "type":"integer",
            "description":"The index of the first day in the week: 1 for Sunday, 2 for Monday, 3 for Tuesday, and so on. The default value is 2.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Project Enterprise Resource Calendar Exceptions

Type: array

Title: Project Enterprise Resource Calendar Exceptions

The Project Enterprise Resource Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used to define holidays or exceptional working days on a weekend. A calendar could have many exceptions.

Show Source

• Array of: object projectEnterpriseLaborResources-ResourceCalendars-CalendarExceptions-item-response

{
    "title":"Project Enterprise Resource Calendar Exceptions",
    "type":"array",
    "description":"The Project Enterprise Resource Calendar Exceptions resource is used to view exceptions on a calendar. A calendar exception is used to define holidays or exceptional working days on a weekend. A calendar could have many exceptions.",
    "items":{
        "$ref":"#/components/schemas/projectEnterpriseLaborResources-ResourceCalendars-CalendarExceptions-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 : projectEnterpriseLaborResources-ResourceCalendars-CalendarExceptions-item-response

Type: object

Show Source

• AllDayFlag: boolean
  Title: All Day Exception Indicator

  Read Only: true

  Maximum Length: 1

  Default Value: true

  Indicates if the calendar exception is for the whole day.
• CategoryCode: string
  Title: Calendar Exception Category Code

  Read Only: true

  Maximum Length: 30

  Category code in which the exception falls.
• Code: string
  Title: Calendar Exception Code

  Read Only: true

  Maximum Length: 3

  Code to identify the exception.
• Description: string
  Title: Calendar Exception Description

  Read Only: true

  Maximum Length: 2000

  Description of the exception.
• EndDate: string (date-time)
  Title: Calendar Exception End Date

  Read Only: true

  The inclusive end date of the calendar exception. Value contains time component if the exception is not for all day long.
• ExceptionId: integer (int64)
  Title: Calendar Exception ID

  Read Only: true

  Unique identifier of the exception in the calendar.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Calendar Exception Name

  Read Only: true

  Maximum Length: 240

  Name of the exception.
• PeriodType: string
  Title: Calendar Exception Period Type

  Read Only: true

  Maximum Length: 30

  Indicates if the calendar exception is a workable period or not. Valid values are OFF_PERIOD and WORK_PERIOD.
• StartDate: string (date-time)
  Title: Calendar Exception Start Date

  Read Only: true

  The date on which the calendar exception begins. Value contains time component if the exception is not for all day long.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Calendar Exception Start Date",
            "type":"string",
            "description":"The date on which the calendar exception begins. Value contains time component if the exception is not for all day long.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryCode":{
            "title":"Calendar Exception Category Code",
            "maxLength":"30",
            "type":"string",
            "description":"Category code in which the exception falls.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodType":{
            "title":"Calendar Exception Period Type",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the calendar exception is a workable period or not. Valid values are OFF_PERIOD and WORK_PERIOD.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Calendar Exception Description",
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExceptionId":{
            "title":"Calendar Exception ID",
            "type":"integer",
            "description":"Unique identifier of the exception in the calendar.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AllDayFlag":{
            "title":"All Day Exception Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the calendar exception is for the whole day.",
            "nullable":false,
            "readOnly":true,
            "default":true,
            "x-queryable":true
        },
        "Code":{
            "title":"Calendar Exception Code",
            "maxLength":"3",
            "type":"string",
            "description":"Code to identify the exception.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Calendar Exception End Date",
            "type":"string",
            "description":"The inclusive end date of the calendar exception. Value contains time component if the exception is not for all day long.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Calendar Exception Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the exception.",
            "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"
    }
}

Nested Schema : projectEnterpriseLaborResources-ResourcePoolMembership-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PoolMembershipFromDate: string (date)
  Title: Pool Membership From Date

  Read Only: true

  Start date of the resource pool membership.
• PoolMembershipToDate: string (date)
  Title: Pool Membership To Date

  Read Only: true

  Last date of the resource pool membership.
• PoolOwnerResourceId: integer (int64)
  Title: Pool Owner Resource ID

  Read Only: true

  Identifier of the project enterprise resource, who is the project resource pool owner.
• ResourcePoolId: integer (int64)
  Title: Resource Pool ID

  Read Only: true

  Unique identifier of the project resource pool.
• ResourcePoolMembershipId: integer (int64)
  Title: Resource Pool Membership ID

  Read Only: true

  Unique identifier of the project resource pool membership.
• ResourcePoolName: string
  Title: Resource Pool Name

  Read Only: true

  Maximum Length: 240

  Name of the project resource pool.

{
    "type":"object",
    "properties":{
        "ResourcePoolMembershipId":{
            "title":"Resource Pool Membership ID",
            "type":"integer",
            "description":"Unique identifier of the project resource pool membership.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PoolMembershipFromDate":{
            "title":"Pool Membership From Date",
            "type":"string",
            "description":"Start date of the resource pool membership.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PoolOwnerResourceId":{
            "title":"Pool Owner Resource ID",
            "type":"integer",
            "description":"Identifier of the project enterprise resource, who is the project resource pool owner.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourcePoolName":{
            "title":"Resource Pool Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project resource pool.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PoolMembershipToDate":{
            "title":"Pool Membership To Date",
            "type":"string",
            "description":"Last date of the resource pool membership.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourcePoolId":{
            "title":"Resource Pool ID",
            "type":"integer",
            "description":"Unique identifier of the project resource pool.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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"
    }
}

Links

Attachments

Operation: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/Attachments

Parameters:

• projectEnterpriseLaborResourcesUniqID: $request.path.projectEnterpriseLaborResourcesUniqID

The attachments resource is used to view, create, and update attachments.

PersonAssignmentDetails

Operation: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/PersonAssignmentDetails

Parameters:

• projectEnterpriseLaborResourcesUniqID: $request.path.projectEnterpriseLaborResourcesUniqID

The Project Enterprise Resource HCM Assignment Details resource is used to view primary HCM assignment details such as business unit, organization, job, or manager related to the enterprise labor resource.

ProjectEnterpriseResourceImage

Operation: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/ProjectEnterpriseResourceImage

Parameters:

• projectEnterpriseLaborResourcesUniqID: $request.path.projectEnterpriseLaborResourcesUniqID

The Project Enterprise Resource Image is used to view and create project enterprise resource image.

ResourceCalendars

Operation: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/ResourceCalendars

Parameters:

• projectEnterpriseLaborResourcesUniqID: $request.path.projectEnterpriseLaborResourcesUniqID

The Project Enterprise Resource Calendars resource is used to view calendars of a Project Enterprise Resource which are single workday pattern and single shift. A calendar is used when scheduling or staffing a Project Enterprise Resource.

ResourcePoolMembership

Operation: /fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/{projectEnterpriseLaborResourcesUniqID}/child/ResourcePoolMembership

Parameters:

• projectEnterpriseLaborResourcesUniqID: $request.path.projectEnterpriseLaborResourcesUniqID

The Project Enterprise Resource Pool Membership resource is used to view resource pools where the Project Enterprise Resource has present, past, or future memberships.

Back to Top

Examples

The following example shows how to get a project enterprise labor resource invoices by submitting a GET request on the REST resource using cURL. Keep in mind that the path parameter is a hash key which consists of ResourceId and PoolAssignmentId.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/00020000000EACED00057708000110F07B475DFF0000000EACED00057708000110F07B475E01

Example of Response Body

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

{
  "ResourceId": 300100023180799,
  "PersonId": 100100004278102,
  "PersonNumber": "100004278102",
  "HCMPersonName": "George White",
  "FirstName": null,
  "LastName": null,
  "ResourceName": "George White",
  "Email": "[e-mail]",
  "FromDate": null,
  "ToDate": null,
  "PhoneNumber": null,
  "ManagerId": null,
  "ManagerName": null,
  "ManagerEmail": null,
  "CalendarId": 300100010293735,
  "CalendarName": "PJT Standard US Calendar",
  "PrimaryProjectRoleId": 300100025498083,
  "PrimaryProjectRoleName": "Oracle DBA",
  "BillRate": null,
  "BillRateCurrencyCode": null,
  "CostRate": null,
  "CostRateCurrencyCode": null,
  "ManageResourceStaffingFlag": true,
  "ResourcePoolId": 300100023181117,
  "ResourcePoolName": "QA BAT Resource Pool 1",
  "PoolMembershipFromDate": "2013-08-13",
  "ProjectId": null,
  "ProjectName": null,
  "ExternalId": null,
  "links": [
    {
      "rel": "self",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/00020000000EACED00057708000110F07B475DFF0000000EACED00057708000110F07B475E01",
      "name": "projectEnterpriseLaborResources",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000027704000000027372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C71007E000378"
      }
    },
    {
      "rel": "canonical",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/00020000000EACED00057708000110F07B475DFF0000000EACED00057708000110F07B475E01",
      "name": "projectEnterpriseLaborResources",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/00020000000EACED00057708000110F07B475DFF0000000EACED00057708000110F07B475E01/lov/ProjectsHcmPersonVVO1",
      "name": "ProjectsHcmPersonVVO1",
      "kind": "collection"
    },
    {
      "rel": "lov",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/00020000000EACED00057708000110F07B475DFF0000000EACED00057708000110F07B475E01/lov/ProjectRolePVO1",
      "name": "ProjectRolePVO1",
      "kind": "collection"
    },
    {
      "rel": "lov",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/00020000000EACED00057708000110F07B475DFF0000000EACED00057708000110F07B475E01/lov/EnterpriseResourcePVO1",
      "name": "EnterpriseResourcePVO1",
      "kind": "collection"
    },
    {
      "rel": "lov",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/00020000000EACED00057708000110F07B475DFF0000000EACED00057708000110F07B475E01/lov/CurrencyPVO1",
      "name": "CurrencyPVO1",
      "kind": "collection"
    },
    {
      "rel": "lov",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/00020000000EACED00057708000110F07B475DFF0000000EACED00057708000110F07B475E01/lov/PjtSchedulesPVO1",
      "name": "PjtSchedulesPVO1",
      "kind": "collection"
    },
    {
      "rel": "child",
      "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/00020000000EACED00057708000110F07B475DFF0000000EACED00057708000110F07B475E01/child/ProjectEnterpriseResourceImage",
      "name": "ProjectEnterpriseResourceImage",
      "kind": "collection"
    }
  ]
}

Back to Top