Entities - Save entity metadata

API Url

Save metadata for a given entity. If metadata already exist it will be replaced.

PUT
http://localhost:16010/ProMarkREST/web/Entity/metadata/{entity}

Permissions: user

Request headers

FieldTypeDescription
Accept-LanguageoptionalString

=en-GB Language use for localization.

X-ClientoptionalString

=Client type.

Allowed values:"Portal""Mobile""Admin"
X-RoleoptionalNumber

ProMark role (1: Employee, 2: User).

Allowed values:{12}
X-WebPart-IdoptionalNumber

Unique web-part identifier.

Path parameters

FieldTypeDescription
entityString

Name of the entity.

Parameter

FieldTypeDescription
requestObject

Main object containing the request data.

  dataObject

Object containg data to be uploaded.

    preferencesObject

Object containing user view preferences.

Success example:

HTTP/1.1 200 OK
{
"request": {
"data": {
"preferences": {
...
}
}
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.