User Management

User management interface helps in creation, updation and removal of users from the system. All APIs in here require appropriate authorization level.

Add / Update Metadata – Static

POST

/api/v1/update_bulk_metadata

IMPLEMENTATION NOTES

This endpoint helps manage metadata for a single or multiple records. The record in the series will have the same metadata. Any existing metadata will be replaced with the new metadata.

Authorization is required to perform the operation.

AUTHORIZATION

Only authorized users can perform the operation.

PARAMETER

QUERY

None

BODY

Field	Type	Optional	Description
from	String		Series start number eg. TEST10001 or 10001
to	String		Series end number eg. TEST10010 or 10010
metadata	String		Text data (include unicode data) to be updated.

RESPONSE STATUS

Success – 200 HTTP_OK
Failure – 4XX

EXAMPLES

• Update metadata for a series. Authentication information is passed via user credentials.

REQUEST

POST /api/v1/update_bulk_metadata HTTP/1.1
Host: 35.215.117.72:8015
Content-Type: application/json
Username: testuser
Password: testpass

 

{
"from": "TEST10001",

"to": "TEST10010",
"metadata": "This is my test metadata"
}

 

RESPONSE

{
"message": "Updated Successfully",
"modified": "11 records updated",
"success": true,
}

Tags api, documentation