Get an article status
/km/api/v1/articleStatus/{id}
This method returns the ArticleStatus object that has the specified ID.
Example URIs
The example URIs for this method are as follows:
-
http://<IM_REST_API_HOST>/km/api/latest/articleStatus/{id}
The request returns an ArticleStatus object with the specified ID parameter in FULL mode.
-
http://<IM_REST_API_HOST>/km/api/latest/articleStatus/{id}?mode=DATA
The request returns an ArticleStatus object with the specified ID parameter in DATA mode.
-
http://<IM_REST_API_HOST>/km/api/latest/articleStatus/{id}?mode=KEY
The request returns an ArticleStatus object with the specified ID parameter in KEY mode.
Response Errors
The possible error responses for this method are as follows:
- OKDOM-GEN0001
This error occurs when an ArticleStatus object with the specified unique identifier cannot be found.
Request
-
id: string
The unique identifier of the object to be retrieved.
Response
- application/json
- application/xml
200 Response
object
ArticleStatus
-
active(optional):
boolean
This parameter can be used to filter ArticleStatus objects if they are active or inactive in the system.
-
dateAdded(optional):
string(date-time)
The date when the ArticleStatus object was created or added.
-
dateModified(optional):
string(date-time)
The date when the ArticleStatus object was last modified.
-
links(optional):
array links
-
localizedAttributes(optional):
array localizedAttributes
List of LocalizedAttributes of this ArticleStatus in various Locales
-
name(optional):
string
The localized name of the ArticleStatus object. The name field can only be used for sorting.
-
recordId(optional):
string
The unique identifier of the ArticleStatus object.
-
referenceKey(optional):
string
The reference key for the ArticleStatus object.
ArticleStatus objects support multiple languages. This field can be used to identify the associated objects for all languages.
array
-
Array of:
object instanceLink
Metadata describing link description objects that MAY appear in the JSON instance representation.
array
-
Array of:
object LocalizedAttributes
Title:
LocalizedAttributes
object
-
href:
string
URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the "templated" property must be set to true.
-
mediaType(optional):
string
Media type, as defined by RFC 2046, describing the link target.
-
method(optional):
string
HTTP method for requesting the target of the link.
-
profile(optional):
string
Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
-
rel:
string
Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.
-
templated(optional):
boolean
Boolean flag that specifies that "href" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.
object
LocalizedAttributes
-
description(optional):
string
Localized description in the above Locale
-
localeId(optional):
string
RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.
-
name(optional):
string
Localized Name in the above Locale
Examples
The following example shows how to find the ArticleStatus object that has the specified unique identifier.
curl -X "GET" "http://<IM_REST_API_HOST>/km/api/latest/articleStatus/{id}"
Example of Request Header
The following shows an example of the request header.
curl -X GET https://<IM_REST_API_HOST>/km/api/latest/articleStatus/{id} -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json"
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "recordId": "DF4F09BD045D4E9ABC5DC5B7601C88C2", "referenceKey": "NEW_ARTICLE_STATUS", "name": "New Article Status", "links": [ { "rel": "canonical", "href": "https://<IM_REST_API_HOST>/km/api/v1/articleStatus/DF4F09BD045D4E9ABC5DC5B7601C88C2", "mediaType": "application/json, application/xml", "method": "GET" }, { "rel": "collection", "href": "https://<IM_REST_API_HOST>/km/api/v1/articleStatus", "mediaType": "application/json, application/xml", "method": "GET", "profile": "https://<IM_REST_API_HOST>/km/api/v1/metadata-catalog/articleStatus" } ], "dateAdded": "2019-04-11T07:23:25+0000", "dateModified": "2019-04-11T07:23:27+0000", "active": true, "localizedAttributes": [ { "localeId": "en_US", "name": "New Article Status" }, { "localeId": "ar_EG", "name": "New Article Status" }, { "localeId": "zh_CN", "name": "New Article Status" }, { "localeId": "da_DK", "name": "New Article Status" }, { "localeId": "fr_FR", "name": "New Article Status" }, { "localeId": "de_DE", "name": "New Article Status" }, { "localeId": "es_ES", "name": "New Article Status" }, { "localeId": "sv_SE", "name": "New Article Status" } ] }