Workshops and Employees | Scheduling Labor Cost

Service to manage entities of type 'SchedulingLaborCost'.

Overview

URL	api/{tenantKey}/{orgKey}/workShopsCore/schedulingLaborCosts
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

• GET:
  • GET SchedulingLaborCosts (odata)
  • GET SchedulingLaborCost by identifier
  • GET SchedulingLaborCost by key
• POST:
  • POST SchedulingLaborCosts
• PUT:
  • PUT Set Custom Attribute SchedulingLaborCost
  • PUT Set IsActive SchedulingLaborCost
  • PUT Set SchedulingLaborKey SchedulingLaborCost
  • PUT Set Description SchedulingLaborCost
  • PUT Set SchedulingGroup SchedulingLaborCost
  • PUT Set Tier SchedulingLaborCost
  • PUT Set Cost SchedulingLaborCost
  • PUT Set Currency SchedulingLaborCost
  • PUT Set Remarks SchedulingLaborCost
  • PUT Set Company SchedulingLaborCost
  • PUT Set IsDefault SchedulingLaborCost
• DELETE:
  • DELETE SchedulingLaborCost by identifier
  • DELETE SchedulingLaborCost by key

All Resources

This service uses the following resources:

• ApiSchedulingLaborCostResource
• MoneyResource
• SchedulingLaborCostResource
• ExtensibilityCustomAttributeValueResource

GET Operations

GET SchedulingLaborCosts (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts	(ODataQueryOptions) OData query option.

Response:

When successful, the response body contains the list of records available. See SchedulingLaborCostResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

GET SchedulingLaborCost by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See SchedulingLaborCostResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

GET SchedulingLaborCost by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
schedulingLaborKey	(string) Scheduling Labor.
schedulingGroup	(string) Scheduling Group.

Response:

When successful, the response body contains the entity record. See SchedulingLaborCostResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

POST Operations

POST SchedulingLaborCosts

Creates a new entity record.

The following elements are required:

schedulingLaborCostResource

(ApiSchedulingLaborCostResource) The request body should contain the entity record that should be created. See ApiSchedulingLaborCostResource.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiSchedulingLaborCostResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Operations

PUT Set Company SchedulingLaborCost

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

schedulingLaborKey	(string) Scheduling Labor.
schedulingGroup	(string) Scheduling Group.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Cost SchedulingLaborCost

Updates the value of attribute 'Cost' in the specified entity record.

The following elements are required:

schedulingLaborKey	(string) Scheduling Labor.
schedulingGroup	(string) Scheduling Group.
companyKey	(string) The company key.
value	(decimal) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Currency SchedulingLaborCost

Updates the value of attribute 'Currency' in the specified entity record.

The following elements are required:

schedulingLaborKey	(string) Scheduling Labor.
schedulingGroup	(string) Scheduling Group.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Description SchedulingLaborCost

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

schedulingLaborKey	(string) Scheduling Labor.
schedulingGroup	(string) Scheduling Group.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set IsActive SchedulingLaborCost

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

schedulingLaborKey	(string) Scheduling Labor.
schedulingGroup	(string) Scheduling Group.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

PUT Set IsDefault SchedulingLaborCost

Updates the value of attribute 'IsDefault' in the specified entity record.

The following elements are required:

schedulingLaborKey	(string) Scheduling Labor.
schedulingGroup	(string) Scheduling Group.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Remarks SchedulingLaborCost

Updates the value of attribute 'Remarks' in the specified entity record.

The following elements are required:

schedulingLaborKey	(string) Scheduling Labor.
schedulingGroup	(string) Scheduling Group.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SchedulingGroup SchedulingLaborCost

Updates the value of attribute 'SchedulingGroup' in the specified entity record.

The following elements are required:

schedulingLaborKey	(string) Scheduling Labor.
schedulingGroup	(string) Scheduling Group.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set SchedulingLaborKey SchedulingLaborCost

Updates the value of attribute 'SchedulingLaborKey' in the specified entity record.

The following elements are required:

schedulingLaborKey	(string) Scheduling Labor.
schedulingGroup	(string) Scheduling Group.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Tier SchedulingLaborCost

Updates the value of attribute 'Tier' in the specified entity record.

The following elements are required:

schedulingLaborKey	(string) Scheduling Labor.
schedulingGroup	(string) Scheduling Group.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

PUT Set Custom Attribute SchedulingLaborCost

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
schedulingLaborKey	(string) Scheduling Labor
schedulingGroup	(string) Scheduling Group
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE Operations

DELETE SchedulingLaborCost by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

DELETE SchedulingLaborCost by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
schedulingLaborKey	(string) Scheduling Labor.
schedulingGroup	(string) Scheduling Group.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

Resources

ApiSchedulingLaborCostResource

The following elements are required:

schedulingLaborKey	(string) Scheduling Labor.
description	(string) Description.
schedulingGroup	(string) Scheduling Group.
tier	(string) Tier.
cost	(MoneyResource) Cost. See MoneyResource .
currency	(string) Currency.
company	(string) Company.
isDefault	(bool) Is Default.

The following elements are optional:

remarks

(string) Remarks.

MoneyResource

The following elements are required:

amount

(decimal) The amount.

The following elements are optional:

baseAmount	(decimal) The base amount.
reportingAmount	(decimal) The reporting amount.
fractionDigits	(int) The fraction digits.
symbol	(string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.

SchedulingLaborCostResource

The following elements are required:

schedulingLaborKey	(string) Scheduling Labor.
description	(string) Description.
schedulingGroup	(string) Scheduling Group. (fk) Allowed value: the natural key of a record of type SchedulingGroup. These records are accessibly through the SchedulingGroups service.
tier	(string) Tier. (fk) Allowed value: the natural key of a record of type Tier. These records are accessibly through the Tiers service.
cost	(MoneyResource) Cost. See MoneyResource .
currency	(string) Currency. (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
company	(string) Company. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
isDefault	(bool) Is Default.

The following elements are optional:

remarks

(string) Remarks.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.