Jump to

• Request
• Response

Get projected utilization of a resource.

post

/fscmRestApi/resources/11.13.18.05/projectEnterpriseLaborResources/action/getProjectedUtilization

Get resource projected utilization for the period between the start date and end date, based on all assignments or only billable assignments or excluding absences from total capacity.

Request

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.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• assignmentType: string
  Indicates whether projected utilization will consider all assignments of the resource or only billable assignments. Valid values are ALL, BILLABLE or blank.The default value is ALL when unspecified.
• endDate: string (date)
  Resource availability and assignments period end for calculating the capacity.
• resourceIds: array resourceIds
  Unique identifier of the resources.
• startDate: string (date)
  Resource availability and assignments period start for calculating the capacity.
• subtractTimeOffFromCapacityFlag: string
  Indicates whether capacity will consider total capacity based on calendar or only the capacity remaining after subtracting Paid Time Off (PTO) and absences from total capacity.The default value is total capacity.

{
    "type":"object",
    "properties":{
        "endDate":{
            "type":"string",
            "description":"Resource availability and assignments period end for calculating the capacity.",
            "format":"date",
            "nullable":true
        },
        "subtractTimeOffFromCapacityFlag":{
            "type":"string",
            "description":"Indicates whether capacity will consider total capacity based on calendar or only the capacity remaining after subtracting Paid Time Off (PTO) and absences from total capacity.The default value is total capacity.",
            "nullable":true
        },
        "startDate":{
            "type":"string",
            "description":"Resource availability and assignments period start for calculating the capacity.",
            "format":"date",
            "nullable":true
        },
        "assignmentType":{
            "type":"string",
            "description":"Indicates whether projected utilization will consider all assignments of the resource or only billable assignments. Valid values are ALL, BILLABLE or blank.The default value is ALL when unspecified.",
            "nullable":true
        },
        "resourceIds":{
            "type":"array",
            "description":"Unique identifier of the resources.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : resourceIds

Type: array

Unique identifier of the resources.

Show Source

• Array of: number

{
    "type":"array",
    "description":"Unique identifier of the resources.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  The custom action returns the projected utilization for each of the resource IDs requested.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"number"
                }
            },
            "description":"The custom action returns the projected utilization for each of the resource IDs requested."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"number"
        }
    },
    "description":"The custom action returns the projected utilization for each of the resource IDs requested."
}

The custom action returns the projected utilization for each of the resource IDs requested.

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: number

{
    "type":"array",
    "items":{
        "type":"number"
    }
}

Back to Top