Use the Content Search API to gather data on content, such as status, version, domain, and dates.
URL
https://AcceleratorKMS_URL/api/Content/Search
Where:
AcceleratorKMS_URL is replaced with your AcceleratorKMS instance.
HTTP Verb
Make an HTTP POST request using the following header and parameters.
Header
|
Key |
Value |
Description |
|---|---|---|
|
Authorization |
bearer <token> |
Actual token value acquired from the authentication step |
|
Content-Type |
application/json |
Designates the POST’s content response as JSON format |
Parameters
At least one search parameter is required for the request to proceed.
|
Parameter |
Type |
Description |
|---|---|---|
|
SearchText |
String |
Title and description in any language |
|
DomainId |
String |
Identifier (GUID) of the domain node |
|
Status |
Array |
Can be "Published", "Draft", "Partially Published", "Expired", "Archived" |
|
LimitSearchResults |
Integer |
Represents the number of results to return |
|
ModifiedStartDate |
Integer |
Content Modified no earlier than X days ago (lower bound) |
|
ModifiedEndDate |
Integer |
Content Modified no later than X day ago (upper bound) |
|
ModifiedStartDateCustom |
Date |
YYYY-MM-DD (lower bound) |
|
ModifiedEndDateCustom |
Date |
YYYY-MM-DD (upper bound) |
|
ExpiresBy |
Integer |
Content expires by X number of days |
|
ExpiresByCustom |
Date |
YYYY-MM-DD Date by when contents are expired. |
|
TemplateOption |
String |
"All" (default), "Asset", "Coupled", "Decoupled", "Standard", "Non templated" |
|
OrganicReview |
Boolean |
Indicates if organic review is enabled or not. If not used in the query, then all results are returned. Can be "true" or "false". |
Response Parameters
|
Content Search Response - JSON Format |
Description |
|---|---|
|
Id |
Content GUID |
|
Title |
Title text of the procedure in (base language) |
|
Titles |
All the titles available for the procedures (multi-language) |
|
Description |
Description added in the content |
|
Descriptions |
All the descriptions available for the procedures (multi-language) |
|
ContentTypeName |
Type of the content: Procedure, Process, etc. |
|
ContentTypeId |
GUID for content type |
|
ClassificationPath |
Domain full path |
|
ClassificationId |
Domain GUID |
|
ModifiedDate * |
If the content has a published version, it will report the Modified date for the published version. If not, it will report the modified date of the latest draft. |
|
ModifiedBy * |
Username of the person who last modified the content |
|
ExpiryDate |
Expiry date of the content; "null" if content is draft or archived |
|
VersionNumber |
The current version of the document |
|
CreatedBy * |
Username |
|
CreatedDate * |
Date when content was created |
|
Status |
The status of the content. If a published and draft version both exist, this will show "Published" because that is the version that is shown when searching. |
|
OrganicReview |
True if enabled, otherwise false |
|
ExtendExpiryMonths |
Number of months by which the expiry date will extend when an organic review occurs |
|
ForWorkflows |
Indicates whether content is restricted to completions in workflows. True if content is enabled for completions. False if content is not enabled for completions or process flows. |
|
TemplateId |
GUID of the related template, otherwise null |
|
TemplateType |
Type of template: 1 for standard, 0 for asset, otherwise null |
|
CoupledToTemplate |
Relationship with asset template: True if content is coupled to an asset template. False if content is decoupled from an asset template. Null if content is not related to an asset template. |
|
ContentProperties |
Values for single and multi-select type properties |
* Additional fields included in API response that are not available from All Content Search within AcceleratorKMS
Sample Query
{"SearchText":"EVAP123 - Evaporator - Shutdown","Status":["Published"]}
Sample Response (JSON)
"Id": "5c8897f7-c6eb-993h-cc6f-090p7b5be9cd",
"Title": "EVAP123 - Evaporator - Shutdown",
"Titles": {
"en-CA": "EVAP123 - Evaporator - Shutdown",
"fr-CA": "EVAP123 - Évaporateur - Arrêt"
},
"Description": "Steps to bring Evaporator EVAP123 from normal operation to a complete shutdown.",
"Descriptions": {
"en-CA": "Steps to bring Evaporator EVAP123 from normal operation to a complete shutdown.",
"fr-CA": "Étapes pour amener Évaporateur EVAP123 de fonctionnement normal à l'arrêt complet."
},
"ContentTypeName": "Procedure",
"ContentTypeId": "g55940fd-f0ed-4256-8d98-3cbff2a114a2",
"ClassificationPath": "Global",
"ClassificationId": "00000000-0000-0000-0000-000000000000",
"ModifiedDate": "2022-11-24T18:19:44.94Z",
"ModifiedBy": "erin.jones@company.com",
"ExpiryDate": "2025-11-24T23:59:59Z",
"VersionNumber": "1.0.0",
"CreatedBy": "erin.jones@company.com",
"CreatedDate": "2018-07-27T12:53:47.66Z",
"Status": "Published",
"OrganicReview": true,
"ExtendExpiryMonths": 36,
"ForWorkflows": false,
"TemplateId": null
"TemplateType": null
"CoupledToTemplate": null
"ContentProperties": [
{
"Name": "Company",
"Value": "Refinery"
},
{
"Name": "Department",
"Value": "SRU"
},
{
"Name": "HEMP Critical",
"Value": "This procedure contains HEMP critical activities."
}
]