API Keyword
Searches for Releases based on a Search term.
Authentication: Anonymous
Privilege : None
Method: PxStat.System.Navigation.Copyright_API.Keyword_API.Search
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
SearchTerm |
String | The words that are subject of the search |
Return: Array [ Release ]
| Name | Type | Description |
|---|---|---|
CprCode |
String | A code to describe the copyright owner of the statistical data |
CprValue |
String | The name of the copyright entity |
CprUrl |
String | The url address of the copyright entity |
Entry point to the API method - Creates a new Copyright
Authentication: Windows
Privilege : PowerUser
Method: PxStat.System.Settings.Copyright.Copyright_API.Create
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
CprCode |
String | None | A code to describe the copyright owner of the statistical data |
CprValue |
String | None | The name of the copyright entity |
CprUrl |
String | None | The url address of the copyright entity |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
CprCode |
String | A code to describe the copyright owner of the statistical data |
CprValue |
String | The name of the copyright entity |
CprUrl |
String | The url address of the copyright entity |
Entry point to the API method - Updates an existing copyright
Authentication: Windows
Privilege : PowerUser
Method: PxStat.System.Settings.Copyright.Copyright_API.Update
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
CprCodeOld |
String | The original code to describe the copyright owner of the statistical data | |
CprCodeNew |
String | The updated code to describe the copyright owner of the statistical data | |
CprValue |
String | The name of the copyright entity | |
CprUrl |
String | The url address of the copyright entity |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
CprCodeNew |
String | A code to describe the copyright owner of the statistical data |
CprValue |
String | The name of the copyright entity |
CprUrl |
String | The url address of the copyright entity |
Entry point to the API method - Deletes a Copyright
Authentication: Windows
Privilege : PowerUser
Method: PxStat.System.Settings.Copyright.Copyright_API.Delete
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
CprCode |
String | A code to describe the copyright owner of the statistical data |
Return: Message.
