Master Data Business Entities | Serie
The series service. The serie indicates the range of identification values that group a set of product entities or objects.
Overview
URL | api/{tenantKey}/{orgKey}/businessCore/series |
Methods Supported | GET, POST, PUT, DELETE |
All Operations
This service includes the following operations:
- GET:
- POST:
- PUT:
- DELETE:
All Resources
This service uses the following resources:
GET Series (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 SerieResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET Serie 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 SerieResource. |
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 Serie by key
Returns the entity record that matches the specified key.
The following elements are required:
serieKey | (string) The key for the serie. Uniquely identifies the serie within the organization. |
Response:
When successful, the response body contains the entity record. See SerieResource. |
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 Returns an EntitySet of Serie, for the given Series ID's
Returns an EntitySet of Serie, for the given Series ID's.
The following elements are required:
serviceOperationParameter1 | (string) Comma separated Guids as strings. |
Response:
When successful, the response body contains a list of resources of type 'SerieResource'. See SerieResource. |
Response status codes:
200 | OK. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Series
Creates a new entity record.
The following elements are required:
serieResource | (ApiSerieResource) The request body should contain the entity record that should be created. See ApiSerieResource. |
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 ApiSerieResource. |
Response status codes:
201 | Created. The operation was completed successfully. |
400 | BadRequest. The request parameters are invalid. |
Resource URL:
PUT Set Description Serie
Updates the value of attribute 'Description' in the specified entity record.
The following elements are required:
serieKey | (string) The key for the serie. Uniquely identifies the serie within the organization. |
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 EndDate Serie
Updates the value of attribute 'EndDate' in the specified entity record.
The following elements are required:
serieKey | (string) The key for the serie. Uniquely identifies the serie within the organization. |
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 Set EndNumber Serie
Updates the value of attribute 'EndNumber' in the specified entity record.
The following elements are required:
serieKey | (string) The key for the serie. Uniquely identifies the serie within the organization. |
value | (int) 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 ExcludeAssociationOnCreateCompany Serie
Updates the value of attribute 'ExcludeAssociationOnCreateCompany' in the specified entity record.
The following elements are required:
serieKey | (string) The key for the serie. Uniquely identifies the serie within the organization. |
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 IsActive Serie
Updates the value of attribute 'IsActive' in the specified entity record.
The following elements are required:
serieKey | (string) The key for the serie. Uniquely identifies the serie within the organization. |
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 SerieKey Serie
Updates the value of attribute 'SerieKey' in the specified entity record.
The following elements are required:
serieKey | (string) The key for the serie. Uniquely identifies the serie within the organization. |
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 StartDate Serie
Updates the value of attribute 'StartDate' in the specified entity record.
The following elements are required:
serieKey | (string) The key for the serie. Uniquely identifies the serie within the organization. |
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 Set StartNumber Serie
Updates the value of attribute 'StartNumber' in the specified entity record.
The following elements are required:
serieKey | (string) The key for the serie. Uniquely identifies the serie within the organization. |
value | (int) 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:
DELETE Serie 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 Serie by key
Deletes the entity record that matches the specified key.
The following elements are required:
serieKey | (string) The key for the serie. Uniquely identifies the serie within the organization. |
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
ApiSerieResource
The following elements are required:
serieKey | (string) The key for the serie. Uniquely identifies the serie within the organization. |
startNumber | (int) The start number for the serie. |
endNumber | (int) The end number for the serie. |
startDate | (DateTime) The start date for the serie. |
endDate | (DateTime) The end date for the serie. |
excludeAssociationOnCreateCompany | (bool) Exclude Association. |
The following elements are optional:
description | (string) The description for the serie. |
SerieResource
The following elements are required:
serieKey | (string) The key for the serie. Uniquely identifies the serie within the organization. |
startNumber | (int) The start number for the serie. |
endNumber | (int) The end number for the serie. |
startDate | (DateTime) The start date for the serie. |
endDate | (DateTime) The end date for the serie. |
excludeAssociationOnCreateCompany | (bool) Exclude Association. |
isVisible | (bool) Is Visible. |
The following elements are optional:
description | (string) The description for the serie. |