Valuekeep Developers - Web API Reference

Settings | Access Level

Service to manage entities of type 'AccessLevel'.

Overview


URL api/{tenantKey}/{orgKey}/settings/accessLevels
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 AccessLevels (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 AccessLevelResource.

Response status codes:

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

Resource URL:

GET /settings/accessLevels/odata

GET AccessLevel 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 AccessLevelResource.

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 /settings/accessLevels/{id}

GET AccessLevel by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
accessLevelKey (string) Access Level.

Response:

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

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 /settings/accessLevels/{companyKey}/{accessLevelKey}

POST Operations

POST AccessLevels

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /settings/accessLevels

POST Add EquipmentItems by keys

Adds the specified 'EquipmentItems' to the 'Access Level' (by specifying its keys).

The following elements are required:

accessLevelKey (string) Access Level.
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 /settings/accessLevels/{accessLevelKey}/equipmentitems/add

POST Add EquipmentItems by identifiers

Adds the specified 'EquipmentItems' to the 'Access Level' (by specifying its identifiers).

The following elements are required:

accessLevelKey (string) Access Level.
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 /settings/accessLevels/{accessLevelKey}/equipmentitems/addById

POST Remove EquipmentItems by keys

Removes the specified 'EquipmentItems' to the 'Access Level' (by specifying its keys).

The following elements are required:

accessLevelKey (string) Access Level.
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 /settings/accessLevels/{accessLevelKey}/equipmentitems/remove

POST Remove EquipmentItems by identifiers

Removes the specified 'EquipmentItems' to the 'Access Level' (by specifying its identifiers).

The following elements are required:

accessLevelKey (string) Access Level.
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 /settings/accessLevels/{accessLevelKey}/equipmentitems/removeById

POST Add Locations by keys

Adds the specified 'Locations' to the 'Access Level' (by specifying its keys).

The following elements are required:

accessLevelKey (string) Access Level.
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 /settings/accessLevels/{accessLevelKey}/locations/add

POST Add Locations by identifiers

Adds the specified 'Locations' to the 'Access Level' (by specifying its identifiers).

The following elements are required:

accessLevelKey (string) Access Level.
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 /settings/accessLevels/{accessLevelKey}/locations/addById

POST Remove Locations by keys

Removes the specified 'Locations' to the 'Access Level' (by specifying its keys).

The following elements are required:

accessLevelKey (string) Access Level.
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 /settings/accessLevels/{accessLevelKey}/locations/remove

POST Remove Locations by identifiers

Removes the specified 'Locations' to the 'Access Level' (by specifying its identifiers).

The following elements are required:

accessLevelKey (string) Access Level.
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 /settings/accessLevels/{accessLevelKey}/locations/removeById

POST Add Parties by keys

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

The following elements are required:

accessLevelKey (string) Access Level.
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 /settings/accessLevels/{accessLevelKey}/parties/add

POST Add Parties by identifiers

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

The following elements are required:

accessLevelKey (string) Access Level.
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 /settings/accessLevels/{accessLevelKey}/parties/addById

POST Remove Parties by keys

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

The following elements are required:

accessLevelKey (string) Access Level.
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 /settings/accessLevels/{accessLevelKey}/parties/remove

POST Remove Parties by identifiers

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

The following elements are required:

accessLevelKey (string) Access Level.
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 /settings/accessLevels/{accessLevelKey}/parties/removeById

POST Access Level Tool

Inserts a new 'Access Level Tool' in the 'Access Level'.

The following elements are required:

accessLevelKey (string) Access Level.
companyKey (string) The company key.
value (ApiAccessLevelAccessLevelToolsResource) The ApiAccessLevelAccessLevelToolsResource instance.
See ApiAccessLevelAccessLevelToolsResource.

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 /settings/accessLevels/{companyKey}/{accessLevelKey}/accessLevelTools

PUT Operations

PUT Set AccessLevelKey AccessLevel

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

The following elements are required:

accessLevelKey (string) Access Level.
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 /settings/accessLevels/{companyKey}/{accessLevelKey}/accessLevelKey

PUT Set Company AccessLevel

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

The following elements are required:

accessLevelKey (string) Access Level.
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 /settings/accessLevels/{companyKey}/{accessLevelKey}/company

PUT Set Description AccessLevel

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

The following elements are required:

accessLevelKey (string) Access Level.
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 /settings/accessLevels/{companyKey}/{accessLevelKey}/description

PUT Set Employee AccessLevel

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

The following elements are required:

accessLevelKey (string) Access Level.
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 /settings/accessLevels/{companyKey}/{accessLevelKey}/employee

PUT Set EquipmentItems AccessLevel

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

The following elements are required:

accessLevelKey (string) Access Level.
companyKey (string) The company key.
value (EquipmentItem) 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 /settings/accessLevels/{companyKey}/{accessLevelKey}/equipmentItems

PUT Set IsActive AccessLevel

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

The following elements are required:

accessLevelKey (string) Access Level.
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 /settings/accessLevels/{companyKey}/{accessLevelKey}/isActive

PUT Set IsDefault AccessLevel

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

The following elements are required:

accessLevelKey (string) Access Level.
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 /settings/accessLevels/{companyKey}/{accessLevelKey}/isDefault

PUT Set Locations AccessLevel

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

The following elements are required:

accessLevelKey (string) Access Level.
companyKey (string) The company key.
value (Location) 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 /settings/accessLevels/{companyKey}/{accessLevelKey}/locations

PUT Set Parties AccessLevel

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

The following elements are required:

accessLevelKey (string) Access Level.
companyKey (string) The company key.
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 /settings/accessLevels/{companyKey}/{accessLevelKey}/parties

PUT Set Remarks AccessLevel

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

The following elements are required:

accessLevelKey (string) Access Level.
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 /settings/accessLevels/{companyKey}/{accessLevelKey}/remarks

PUT Set Tool AccessLevelTool

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

The following elements are required:

accessLevelKey (string) Access Level.
lineId (string) The detail identifier.
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 /settings/accessLevels/{companyKey}/{accessLevelKey}/accessLevelTools/{lineId}/tool

PUT Set Custom Attribute AccessLevel

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

The following elements are required:

companyKey (string) The company key.
accessLevelKey (string) Access Level
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 /settings/accessLevels/{companyKey}/{accessLevelKey}/{customAttributeName}

PUT Set Custom Attribute AccessLevelTool

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

The following elements are required:

companyKey (string) The company key.
accessLevelKey (string) Access Level
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 /settings/accessLevels/{companyKey}/{accessLevelKey}/accessLevelTools/{lineId}/{customAttributeName}

DELETE Operations

DELETE Access Level Tool by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

accessLevelKey (string) Access Level.
companyKey (string) The company key.
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 /settings/accessLevels/{companyKey}/{accessLevelKey}/accessLevelTools/{lineId}

DELETE AccessLevel 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 /settings/accessLevels/{id}

DELETE AccessLevel by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
accessLevelKey (string) Access Level.

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 /settings/accessLevels/{companyKey}/{accessLevelKey}

Resources


AccessLevelResource

The following elements are required:

accessLevelKey (string) Access Level.
description (string) Description.
company (string) Company.
(fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.

The following elements are optional:

remarks (string) Remarks.
isDefault (bool) Is Default.
equipmentItems (EquipmentItem) Equipments.
locations (Location) Locations.
parties (Party) Parties.
accessLevelTools (List of AccessLevelToolResource) Access Level Tools.
See AccessLevelToolResource.
employee (string) Employee.
(fk) Allowed value: the natural key of a record of type Employee. These records are accessibly through the Employees service.


ApiAccessLevelAccessLevelToolsResource

The following elements are required:

tool (string) Tool.


ApiAccessLevelResource

The following elements are required:

accessLevelKey (string) Access Level.
description (string) Description.
company (string) Company.

The following elements are optional:

remarks (string) Remarks.
isDefault (bool) Is Default.
equipmentItems (EquipmentItem) Equipments.
locations (Location) Locations.
parties (Party) Parties.
accessLevelTools (List of ApiAccessLevelAccessLevelToolsResource) Access Level Tools.
See ApiAccessLevelAccessLevelToolsResource.
employee (string) Employee.


ExtensibilityCustomAttributeValueResource

The following elements are required:

value (object) The custom attribute value.