Home Page > Integration > REST API > Employees > EmployeeKeywords

EmployeeKeywords

Employees/:id/EmployeeKeywords

This endpoint is used for manipulating the Employees nested EmployeeKeywords resource. Objects are always returned in a JSON format within an array. Empty results return an empty array.

 

Object

The Projects nested EmployeeKeywords resource is represented by the following JSON Object:

[
    {
        "id": "<int>"
    }
]

GET

This verb is used for retrieving resources, it is subject to the parameters mentioned in the overview and all fields mentioned above are searchable.

 

PUT

This endpoint takes a JSON array of EmployeeKeyword ID's (As described above) to replace the current linked keywords to the parent File. These ID's can be discovered via the EmployeeKeywords resource.

 

POST

This endpoint is a shortcut for adding Keywords. It requires that you know the ID of the Keyword you want to add, after that the syntax is simple:

/REST/1/Projects/5/EmployeeKeywords/:employeeKeywordId

 

This can be seen with a curl example:

curl -D - -u admin:admin http://192.168.1.139/REST/1/Employees/5/EmployeeKeywords/43 -X POST

 

DELETE

Used for removing a relationship between the parent Employee and a Keyword Object. Below is a demonstration of this functionality:

curl -D - -u admin:admin http://192.168.1.139/REST/1/Projects/5/EmployeeKeywords

[
   {
       "id" : "37"
   },   
   {      
       "id" : "43"   
    }
]

 

The following curl command can be used to delete a relationship:

curl -D - -u admin:admin http://192.168.1.139/REST/1/Employees/5/EmployeeKeywords/43 -X DELETE

<EOF>

 

And our original query results:

[   {      "id" : "37"   }]
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.