Get labor schedule costs total errors
get
/fscmRestApi/resources/11.13.18.05/laborSchedulesCostsTotalErrors/{laborSchedulesCostsTotalErrorsUniqID}
Request
Path Parameters
-
laborSchedulesCostsTotalErrorsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Labor Schedule Costs Total Errors resource and used to uniquely identify an instance of Labor Schedule Costs Total Errors. The client should not generate the hash key value. Instead, the client should query on the Labor Schedule Costs Total Errors collection resource in order to navigate to a specific instance of Labor Schedule Costs Total Errors 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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : laborSchedulesCostsTotalErrors-item-response
Type:
Show Source
object
-
BusinessUnitId: integer
(int64)
Read Only:
true
Business unit identifier. -
BusinessUnitName: string
Read Only:
true
Maximum Length:240
Business unit name. -
ErrorAmount: number
Read Only:
true
Total cost amount for all the errors within the business unit the user has access too. -
errorByPeriod: array
Labor Schedule Costs Total Errors by Period
Title:
Labor Schedule Costs Total Errors by Period
The labor schedule costs total errors by period resource used to generate the total amount and row count for the last 3 periods portion of the analytic on the labor cost management page. -
ErrorCount: number
Read Only:
true
Total count of records for all the errors within the business unit the user has access too. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Labor Schedule Costs Total Errors by Period
Type:
array
Title:
Labor Schedule Costs Total Errors by Period
The labor schedule costs total errors by period resource used to generate the total amount and row count for the last 3 periods portion of the analytic on the labor cost management page.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : laborSchedulesCostsTotalErrors-errorByPeriod-item-response
Type:
Show Source
object
-
BusinessUnitId: integer
(int64)
Read Only:
true
Business unit identifier. -
BusinessUnitName: string
Read Only:
true
Maximum Length:240
Business unit name. -
ErrorAmount: number
Read Only:
true
Total cost amount for all the errors within the last three pay period start dates and the business unit the user has access too. -
ErrorCount: number
Read Only:
true
Total record count for all the errors within the last three pay period start dates and the business unit the user has access too. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayPeriodStart: string
(date)
Read Only:
true
Pay period start date associated to the error amounts and counts. Only the last three will be displayed.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- errorByPeriod
-
Parameters:
- laborSchedulesCostsTotalErrorsUniqID:
$request.path.laborSchedulesCostsTotalErrorsUniqID
The labor schedule costs total errors by period resource used to generate the total amount and row count for the last 3 periods portion of the analytic on the labor cost management page. - laborSchedulesCostsTotalErrorsUniqID:
Examples
The following example shows how to get a labor schedule costs total errors by submitting a GET request on the REST resource using cURL.
curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/laborSchedulesCostsTotalErrors/1
Response Body Example
The following shows an example of the response body in JSON format of all project templates.
{ "ErrorAmount": 2200014578, "ErrorCount": 28, "BusinessUnitId": 300100014554154, "BusinessUnitName": "Vision City Operations", "links": [ { "rel": "self", "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/laborSchedulesCostsTotalErrors/1", "name": "laborSchedulesCostsTotalErrors", "kind": "item" }, { "rel": "canonical", "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/laborSchedulesCostsTotalErrors/1", "name": "laborSchedulesCostsTotalErrors", "kind": "item" }, { "rel": "child", "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/laborSchedulesCostsTotalErrors/1/child/errorByPeriod", "name": "errorByPeriod", "kind": "collection" } ] }