Settings | Asset Restriction
Service to manage entities of type 'AssetRestriction'.
This service extends Workshops.
Overview
| URL | api/{tenantKey}/{orgKey}/settings/assetRestrictions |
| 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 AssetRestrictions (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 AssetRestrictionResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET AssetRestriction 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 AssetRestrictionResource. |
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 AssetRestriction 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 AssetRestrictionResource. |
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 AssetRestrictions (with Workshop)
Returns the list of all the entity records available. Each record contains both data from the entity and the base entity.
Response:
| When successful, the response body contains the list of records available. See BaseAssetRestrictionResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET AssetRestrictions (with Workshop) (paged)
Returns a page of the list of all the entity records available. Each record contains both data from the entity and the base entity.
The following elements are optional:
| page | (int) The index of the page of the list that should be returned. This is a query string parameter. |
| pageSize | (int) The number of page elements that should be returned (max. is 1000). This is a query string parameter. |
Response:
| When successful, the response body contains the list of records available. See BaseAssetRestrictionResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET AssetRestriction (with Workshop) by identifier
Returns the entity record that matches the specified identifier. The record contains both data from the entity and the base entity.
The following elements are required:
| id | (string) The record identifier. |
Response:
| When successful, the response body contains the entity record. See BaseAssetRestrictionResource. |
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 AssetRestriction (with Workshop) by key
Returns the entity record that matches the specified key. The record contains both data from the entity and the base entity.
The following elements are required:
| workshopKey | (string) Workshop. |
Response:
| When successful, the response body contains the entity record. See BaseAssetRestrictionResource. |
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 AssetRestrictions
Creates a new entity record.
The following elements are required:
| assetRestrictionResource | (ApiAssetRestrictionResource) The request body should contain the entity record that should be created. See ApiAssetRestrictionResource. |
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 ApiAssetRestrictionResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST AssetRestrictions (with ApiBaseAssetRestriction)
Creates a new entity record. The record shoud contain both data from the entity and the base entity.
The following elements are required:
| assetRestrictionResource | (ApiAssetRestrictionResource) The request body should contain the entity record that should be created. See ApiAssetRestrictionResource. |
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 ApiBaseAssetRestrictionResource. |
Response status codes:
| 201 | Created. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
POST Asset Restriction Group
Inserts a new 'Asset Restriction Group' in the 'Asset Restriction'.
The following elements are required:
| workshopKey | (string) Workshop. |
| value | (ApiAssetRestrictionAssetRestrictionGroupsResource) The ApiAssetRestrictionAssetRestrictionGroupsResource instance. See ApiAssetRestrictionAssetRestrictionGroupsResource. |
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 Set AssetGroup AssetRestrictionGroup
Updates the value of attribute 'AssetGroup' 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 AssetRestriction
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:
DELETE Asset Restriction Group 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 AssetRestriction 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 AssetRestriction 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
ApiAssetRestrictionAssetRestrictionGroupsResource
The following elements are required:
| assetGroup | (string) Asset Group. |
ApiAssetRestrictionResource
The following elements are required:
| workshopKey | (string) Workshop. |
The following elements are optional:
| assetRestrictionGroups | (List of ApiAssetRestrictionAssetRestrictionGroupsResource) Asset Restriction Groups.
See ApiAssetRestrictionAssetRestrictionGroupsResource. |
ApiBaseAssetRestrictionAssetRestrictionGroupsResource
The following elements are required:
| assetGroup | (string) Asset Group. |
ApiBaseAssetRestrictionResource
The following elements are required:
| workshopKey | (string) Workshop. |
| description | (string) Description. |
The following elements are optional:
| assetRestrictionGroups | (List of ApiBaseAssetRestrictionAssetRestrictionGroupsResource) Asset Restriction Groups.
See ApiBaseAssetRestrictionAssetRestrictionGroupsResource. |
| isInternal | (bool) Is Internal. |
| isDefault | (bool) Is Default. |
| remarks | (string) Remarks. |
AssetRestrictionResource
The following elements are required:
| workshopKey | (string) Workshop. |
The following elements are optional:
| assetRestrictionGroups | (List of AssetRestrictionGroupResource) Asset Restriction Groups.
See AssetRestrictionGroupResource. |
BaseAssetRestrictionAssetRestrictionGroupsResource
The following elements are required:
| assetGroup | (string) Asset Group. |
BaseAssetRestrictionResource
The following elements are required:
| workshopKey | (string) Workshop. |
| description | (string) Description. |
The following elements are optional:
| assetRestrictionGroups | (List of BaseAssetRestrictionAssetRestrictionGroupsResource) Asset Restriction Groups.
See BaseAssetRestrictionAssetRestrictionGroupsResource. |
| isInternal | (bool) Is Internal. |
| isDefault | (bool) Is Default. |
| remarks | (string) Remarks. |