The following operations are available for this resource.
Http Verb | Operation | ||
---|---|---|---|
GET | Method: Get, URL: ReferenceData/Keywords/{id}?filter={filter}&maintenanceMode={maintenanceMode} | Test | |
Get the details of a keyword by id. To get the resource only if the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). |
|||
GET | Method: GetAll, URL: ReferenceData/Keywords?filter={filter}&maintenanceMode={maintenanceMode} | Test | |
Get all keywords. To get only the resources for which the user has write/edit access, pass filter="writeonly". To get the resources in maintenance mode(ignore Control Groups), pass maintenanceMode="true". Maintenance mode requires users to have access to the reference tables. (Specified in TX_REFTABLE_USERGROUP). For filtering on specific property value, pass the property name with value as query parameter. If the property is another non primitive object, pass PropertyName.Id and its value as query parameter. |
|||
GET | Method: GetDataFor, URL: ReferenceData/Keywords/Data?keywordId={keywordId} | Test | |
Gets potential values for a Keyword as KeywordDataItems. |
|||
GET | Method: GetSummaries, URL: ReferenceData/Keywords/Summary | Test | |
Get a summary representation of all keywords. |
|||
POST | Method: Create, URL: ReferenceData/Keywords | Test | |
Create a new keyword. |
|||
PUT | Method: Update, URL: ReferenceData/Keywords/{id} | Test | |
Update an existing keyword. |
|||
DELETE | Method: Delete, URL: ReferenceData/Keywords/{id} | Test | |
Delete an existing keyword. |