Jump to

• Request
• Response
• Examples

Get an article status

get

/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

Path Parameters

• id(required): string
  The unique identifier of the object to be retrieved.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK.

Body ()

Root Schema : ArticleStatus

Type: object

Title: ArticleStatus

Show Source

• active: boolean

  This parameter can be used to filter ArticleStatus objects if they are active or inactive in the system.

• dateAdded: string(date-time)

  The date when the ArticleStatus object was created or added.

• dateModified: string(date-time)

  The date when the ArticleStatus object was last modified.

• links: array links
• localizedAttributes: array localizedAttributes
  List of LocalizedAttributes of this ArticleStatus in various Locales
• name: string

  The localized name of the ArticleStatus object. The name field can only be used for sorting.

• recordId: string

  The unique identifier of the ArticleStatus object.

• referenceKey: 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.

{
    "title":"ArticleStatus",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the ArticleStatus object.</p>",
            "type":"string"
        },
        "localizedAttributes":{
            "items":{
                "$ref":"#/definitions/LocalizedAttributes"
            },
            "description":"List of LocalizedAttributes of this ArticleStatus in various Locales",
            "type":"array"
        },
        "dateModified":{
            "description":"<p>The date when the ArticleStatus object was last modified.</p>",
            "format":"date-time",
            "type":"string"
        },
        "referenceKey":{
            "description":"<p>The reference key for the ArticleStatus object. <br/>ArticleStatus objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>",
            "type":"string"
        },
        "name":{
            "description":"<p>The localized name of the ArticleStatus object. The name field can only be used for sorting.</p>",
            "type":"string"
        },
        "dateAdded":{
            "description":"<p>The date when the ArticleStatus object was created or added.</p>",
            "format":"date-time",
            "type":"string"
        },
        "active":{
            "description":"<p>This parameter can be used to filter ArticleStatus objects if they are active or inactive in the system.</p>",
            "type":"boolean"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

Nested Schema : localizedAttributes

Type: array

List of LocalizedAttributes of this ArticleStatus in various Locales

Show Source

• Array of: object LocalizedAttributes
  Title: LocalizedAttributes

{
    "items":{
        "$ref":"#/definitions/LocalizedAttributes"
    },
    "description":"List of LocalizedAttributes of this ArticleStatus in various Locales",
    "type":"array"
}

Nested Schema : instanceLink

Type: object

Metadata describing link description objects that MAY appear in the JSON instance representation.

Show Source

• href(required): 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: string
  Media type, as defined by RFC 2046, describing the link target.
• method: string
  HTTP method for requesting the target of the link.
• profile: string
  Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..
• rel(required): 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: 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.

{
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "templated":{
            "description":"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.",
            "type":"boolean"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
            "type":"string"
        },
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
            "type":"string"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "profile":{
            "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..",
            "type":"string"
        }
    },
    "required":[
        "href",
        "rel"
    ],
    "type":"object"
}

Nested Schema : LocalizedAttributes

Type: object

Title: LocalizedAttributes

Show Source

• description: string
  Localized description in the above Locale
• localeId: string
  RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.
• name: string
  Localized Name in the above Locale

{
    "title":"LocalizedAttributes",
    "properties":{
        "localeId":{
            "description":"RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.",
            "type":"string"
        },
        "description":{
            "description":"Localized description in the above Locale",
            "type":"string"
        },
        "name":{
            "description":"Localized Name in the above Locale",
            "type":"string"
        }
    }
}

Back to Top

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"
        }
    ]
}

Back to Top