Valuekeep Developers - Web API Reference

Workshops and Employees | Specialty

Service to manage entities of type 'Expertise'.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET Expertises (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 ExpertiseResource.

Response status codes:

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

Resource URL:

GET /workShopsCore/expertises/odata

GET Expertise 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 ExpertiseResource.

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 /workShopsCore/expertises/{id}

GET Expertise by key

Returns the entity record that matches the specified key.

The following elements are required:

expertiseKey (string) Specialty.

Response:

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

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 /workShopsCore/expertises/{expertiseKey}

POST Operations

POST Expertises

Creates a new entity record.

The following elements are required:

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

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 ApiExpertiseResource.

Response status codes:

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

Resource URL:

POST /workShopsCore/expertises

POST Expertise Cost

Inserts a new 'Expertise Cost' in the 'Specialty'.

The following elements are required:

expertiseKey (string) Specialty.
value (ApiExpertiseExpertiseCostsResource) The ApiExpertiseExpertiseCostsResource instance.
See ApiExpertiseExpertiseCostsResource.

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 is empty.

Response status codes:

204 NoContent. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /workShopsCore/expertises/{expertiseKey}/expertiseCosts

PUT Operations

PUT Set Currency Expertise

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

The following elements are required:

expertiseKey (string) Specialty.
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 /workShopsCore/expertises/{expertiseKey}/currency

PUT Set Currency ExpertiseCost

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

The following elements are required:

expertiseKey (string) Specialty.
lineId (string) The detail identifier.
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 /workShopsCore/expertises/{expertiseKey}/expertiseCosts/{lineId}/currency

PUT Set Date ExpertiseCost

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

The following elements are required:

expertiseKey (string) Specialty.
lineId (string) The detail identifier.
value (DateTime) 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 /workShopsCore/expertises/{expertiseKey}/expertiseCosts/{lineId}/date

PUT Set Description Expertise

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

The following elements are required:

expertiseKey (string) Specialty.
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 /workShopsCore/expertises/{expertiseKey}/description

PUT Set ExchangeRate Expertise

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

The following elements are required:

expertiseKey (string) Specialty.
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 /workShopsCore/expertises/{expertiseKey}/exchangeRate

PUT Set ExchangeRateDate Expertise

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

The following elements are required:

expertiseKey (string) Specialty.
value (DateTime) 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 /workShopsCore/expertises/{expertiseKey}/exchangeRateDate

PUT Set ExpertiseKey Expertise

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

The following elements are required:

expertiseKey (string) Specialty.
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 /workShopsCore/expertises/{expertiseKey}/expertiseKey

PUT Set IsActive Expertise

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

The following elements are required:

expertiseKey (string) Specialty.
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 /workShopsCore/expertises/{expertiseKey}/isActive

PUT Set Remarks Expertise

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

The following elements are required:

expertiseKey (string) Specialty.
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 /workShopsCore/expertises/{expertiseKey}/remarks

PUT Set StandardCost ExpertiseCost

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

The following elements are required:

expertiseKey (string) Specialty.
lineId (string) The detail identifier.
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 /workShopsCore/expertises/{expertiseKey}/expertiseCosts/{lineId}/standardCost

PUT Set Tier ExpertiseCost

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

The following elements are required:

expertiseKey (string) Specialty.
lineId (string) The detail identifier.
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 /workShopsCore/expertises/{expertiseKey}/expertiseCosts/{lineId}/tier

PUT Set Custom Attribute Expertise

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

The following elements are required:

expertiseKey (string) Specialty
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:

PUT /workShopsCore/expertises/{expertiseKey}/{customAttributeName}

PUT Set Custom Attribute ExpertiseCost

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

The following elements are required:

expertiseKey (string) Specialty
lineId (string) The detail identifier.
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:

PUT /workShopsCore/expertises/{expertiseKey}/expertiseCosts/{lineId}/{customAttributeName}

DELETE Operations

DELETE Expertise Cost by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

expertiseKey (string) Specialty.
lineId (string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

DELETE /workShopsCore/expertises/{expertiseKey}/expertiseCosts/{lineId}

DELETE Expertise 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 /workShopsCore/expertises/{id}

DELETE Expertise by key

Deletes the entity record that matches the specified key.

The following elements are required:

expertiseKey (string) Specialty.

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 /workShopsCore/expertises/{expertiseKey}

Resources


ApiExpertiseExpertiseCostsResource

The following elements are required:

standardCost (MoneyResource) Standard Cost.
See MoneyResource .
currency (string) Currency.
tier (string) Tier.

The following elements are optional:

date (DateTime) Date.


ApiExpertiseResource

The following elements are required:

expertiseKey (string) Specialty.
description (string) Description.
currency (string) Currency.
exchangeRate (decimal) Exchange Rate.

The following elements are optional:

expertiseCosts (List of ApiExpertiseExpertiseCostsResource) Expertise Costs.
See ApiExpertiseExpertiseCostsResource.
remarks (string) Remarks.
exchangeRateDate (DateTime) Exchange Rate Date.


ExpertiseResource

The following elements are required:

expertiseKey (string) Specialty.
description (string) Description.
currency (string) Currency.
(fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
exchangeRate (decimal) Exchange Rate.

The following elements are optional:

expertiseCosts (List of ExpertiseCostResource) Expertise Costs.
See ExpertiseCostResource.
remarks (string) Remarks.
exchangeRateDate (DateTime) Exchange Rate Date.


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.



ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.