API Keyword Subject
Home / API / Keyword Subject
Reads a subject keyword. If no parameters are sent then all Keyword Subjects will be returned. If only the Keyword Subject Code KsbCode is sent then that Keyword Subject will be returned. If only the Subject Code SbjCode is sent then all Keyword Subjects for that Subject Code SbjCode will be returned.
Authentication: Windows
Privilege : PowerUser
Method: PxStat.System.Navigation.Keyword_Subject_API.Read
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
KsbCode |
Integer | Keyword Subject Code | |
SbjCode |
Integer | 0 or empty | Subject Code |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
KsbCode |
Integer | Keyword Subject Code |
KsbValue |
String | Keywrod Subject Value |
KsbMandatoryFlag |
Boolean | Indicates if the keyword is mandatory |
SbjCode |
Integer | Subject Code |
KsbSingularisedFlag |
Boolean | Flag to indicate the word has been singularised* |
| *This value is passed if the word has been singularised. The code must correspond to the language in which the word has been singularised. |
Creates a non-mandatory Subject Keyword.
Authentication: Windows
Privilege : Administrator , Power User
Method: PxStat.System.Navigation.Keyword_Subject_API.Create
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
KsbValue |
String | Keyword Subject Value | |
SbjCode |
Integer | Subject Code | |
KsbMandatoryFlag |
Boolean | null | Indicates a mandatory keyword |
LngIsoCode |
string | ISO Language code* | |
| *This value is passed if the word has been singularised. The code must correspond to the language in which the word has been singularised. |
Return: String with value of success.
Updates a subject keyword.
Authentication: Windows
Privilege : Administrator , Power User
Method: PxStat.System.Navigation.Keyword_Subject_API.Update
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
KsbValue |
String | Keyword Subject Value | |
SbjCode |
Integer | Subject Code | |
KsbMandatoryFlag |
Boolean | null | Indicates a mandatory keyword |
LngIsoCode |
string | ISO Language code* | |
| *This value is passed if the word has been singularised. The code must correspond to the language in which the word has been singularised. |
Return: String with value of success.
Deletes a subject keyword.
Authentication: Windows
Privilege : Administrator , Power User
Method: PxStat.System.Navigation.Keyword_Subject_API.Delete
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
KsbCode |
Integer | Keyword Subject Code |
Return: String with value of success.
