Workshops and Employees | Workshop

Service to manage entities of type 'Workshop'.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET Workshops (odata)
  • GET Workshop by identifier
  • GET Workshop by key
• POST:
  • POST Workshops
  • POST Add Parties by keys
  • POST Add Parties by identifiers
  • POST Remove Parties by keys
  • POST Remove Parties by identifiers
  • POST Workshop Employee Manager
• PUT:
  • PUT Set Custom Attribute Workshop
  • PUT Set Custom Attribute WorkshopEmployeeManager
  • PUT Set IsActive Workshop
  • PUT Set WorkshopKey Workshop
  • PUT Set Description Workshop
  • PUT Set IsInternal Workshop
  • PUT Set IsDefault Workshop
  • PUT Set Remarks Workshop
  • PUT Set Parties Workshop
  • PUT Set Employee WorkshopEmployeeManager
• DELETE:
  • DELETE Workshop Employee Manager by identifier
  • DELETE Workshop by identifier
  • DELETE Workshop by key

All Resources

This service uses the following resources:

• ApiWorkshopResource
• ApiWorkshopWorkshopEmployeeManagersResource
• WorkshopResource
• ExtensibilityCustomAttributeValueResource

GET Operations

GET Workshops (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 WorkshopResource.

Response status codes:

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

Resource URL:

GET Workshop 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 WorkshopResource.

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 Workshop by key

Returns the entity record that matches the specified key.

The following elements are required:

workshopKey

(string) Workshop.

Response:

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

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 Workshops

Creates a new entity record.

The following elements are required:

workshopResource

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

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

Response status codes:

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

Resource URL:

POST Add Parties by keys

Adds the specified 'Parties' to the 'Workshop' (by specifying its keys).

The following elements are required:

workshopKey	(string) Workshop.
value	(Array of string) A list of record keys to be added.

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:

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

Resource URL:

POST Add Parties by identifiers

Adds the specified 'Parties' to the 'Workshop' (by specifying its identifiers).

The following elements are required:

workshopKey	(string) Workshop.
value	(Array of string) A list of record identifiers to be added.

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:

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

Resource URL:

POST Remove Parties by keys

Removes the specified 'Parties' to the 'Workshop' (by specifying its keys).

The following elements are required:

workshopKey	(string) Workshop.
value	(Array of string) A list of record keys to be removed.

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:

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

Resource URL:

POST Remove Parties by identifiers

Removes the specified 'Parties' to the 'Workshop' (by specifying its identifiers).

The following elements are required:

workshopKey	(string) Workshop.
value	(Array of string) A list of record identifiers to be removed.

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:

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

Resource URL:

POST Workshop Employee Manager

Inserts a new 'Workshop Employee Manager' in the 'Workshop'.

The following elements are required:

workshopKey	(string) Workshop.
value	(ApiWorkshopWorkshopEmployeeManagersResource) The ApiWorkshopWorkshopEmployeeManagersResource instance. See ApiWorkshopWorkshopEmployeeManagersResource.

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:

PUT Operations

PUT Set Description Workshop

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

The following elements are required:

workshopKey	(string) Workshop.
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 Employee WorkshopEmployeeManager

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

The following elements are required:

workshopKey	(string) Workshop.
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 Set IsActive Workshop

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

The following elements are required:

workshopKey	(string) Workshop.
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 Workshop

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

The following elements are required:

workshopKey	(string) Workshop.
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 IsInternal Workshop

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

The following elements are required:

workshopKey	(string) Workshop.
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 Parties Workshop

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

The following elements are required:

workshopKey	(string) Workshop.
value	(Party) 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 Workshop

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

The following elements are required:

workshopKey	(string) Workshop.
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 WorkshopKey Workshop

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

The following elements are required:

workshopKey	(string) Workshop.
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 Workshop

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

The following elements are required:

workshopKey	(string) Workshop
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 Set Custom Attribute WorkshopEmployeeManager

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

The following elements are required:

workshopKey	(string) Workshop
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:

DELETE Operations

DELETE Workshop Employee Manager by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

workshopKey	(string) Workshop.
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 Workshop 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 Workshop by key

Deletes the entity record that matches the specified key.

The following elements are required:

workshopKey

(string) Workshop.

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

ApiWorkshopResource

The following elements are required:

workshopKey	(string) Workshop.
description	(string) Description.

The following elements are optional:

isInternal	(bool) Is Internal.
isDefault	(bool) Is Default.
remarks	(string) Remarks.
parties	(Party) Parties.
workshopEmployeeManagers	(List of ApiWorkshopWorkshopEmployeeManagersResource) Managers. See ApiWorkshopWorkshopEmployeeManagersResource.

ApiWorkshopWorkshopEmployeeManagersResource

The following elements are required:

employee

(string) Employee.

WorkshopResource

The following elements are required:

workshopKey	(string) Workshop.
description	(string) Description.

The following elements are optional:

isInternal	(bool) Is Internal.
isDefault	(bool) Is Default.
remarks	(string) Remarks.
parties	(Party) Parties.
workshopEmployeeManagers	(List of WorkshopEmployeeManagerResource) Managers. See WorkshopEmployeeManagerResource.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.