1. REST API for Knowledge Management in Oracle Fusion Service
  2. Tasks
  3. Content (IM)
  4. Article Status

Get all article statuses

get

/km/api/v1/articleStatus

This method returns a list of ArticleStatus objects.

This resource supports the orderBy request parameter, which allows you to sort the returned list of ArticleStatus objects.

You can find different values to use with the orderBy parameter in the schema and catalog information of the resource. To get the schema and catalog information, use GET method with the mediaType value as 'application/schema+json' in the HTTP request.

The example URI to get schema and catalog of the resource is as follows:

  • http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/articleStatus

Example URIs

The example URIs for this method are as follows:

  • http://<IM_REST_API_HOST>/km/api/latest/articleStatus

    The request returns a paginated list of the ArticleStatus objects in DATA mode. By default, the Article Status objects are sorted by the date when the object was created, in descending order.

  • http://<IM_REST_API_HOST>/km/api/latest/articleStatus?mode=KEY&limit=10&offset=20

    The request returns the third page of the list of Article Status objects in KEY mode. By default, the Article Status objects are sorted by the date when the object was created, in descending order.

  • http://<IM_REST_API_HOST>/km/api/latest/articleStatus?orderBy=name

    The request returns a paginated list of ArticleStatus objects in DATA mode. The Article Status objects are sorted according to the name in ascending order.


Find by query

Supported Media Types: 'application/json', 'application/xml'


This method returns a list of ArticleStatus objects that match the specified criteria.

This resource supports the orderBy request parameter, which allows you to sort the returned list of ArticleStatus objects.

You can find different values to use with the orderBy parameter in the schema and catalog information of the resource. To get the schema and catalog information, use GET method with the mediaType value as 'application/schema+json' in the HTTP request.

The example URI to get schema and catalog of the resource is as follows:

  • http://<IM_REST_API_HOST>/km/api/latest/metadata-catalog/articleStatus

Example URIs

The example URIs for this method are as follows:

  • http://<IM_REST_API_HOST>/km/api/articleStatus?q=dateAdded after '2015-01-01'&orderBy=dateAdded&limit=10&offset=20

    The request returns the third page of the list of Article Status objects in DATA mode that were added after January 1, 2015. Objects in the list are sorted by the most recent date added.

  • http://<IM_REST_API_HOST>/km/api/latest/articleStatus?q=active eq 'true'&mode=KEY

    The request returns a paginated list of active Article Status objects in KEY mode. By default, the Article Status objects are sorted by the date when the object was created, in descending order.

  • http://<IM_REST_API_HOST>/km/api/articleStatus?q=referenceKey in ('DRAFT', 'WORK_IN_PROGRESS', 'TECHNICAL_REVIEW')

    The request returns a paginated list of Article Status objects in DATA mode that have any of the these reference key values: DRAFT, WORK_IN_PROGRESS, TECHNICAL_REVIEW. Objects in the list are sorted by date when the object was created in descending order.

Query Parameters

The following table describes the query parameters for this resource.

ParameterQueryableSortableTypeDescription
recordIdYY'type' : 'string'

The unique identifier of the ArticleStatus object.

referenceKeyYY'type' : '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.

nameNY'type' : 'string'

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

dateAddedYY'type' : 'string', 'format' : 'date-time'

The date when the ArticleStatus object was created or added.

dateModifiedYY'type' : 'string', 'format' : 'date-time'

The date when the ArticleStatus object was last modified.

activeYY'type' : 'boolean'

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

Request

Query Parameters
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter defines amount of information to be included in the returned resources - KEY is the one that has least information (and hence performs better) and FULL is the one that has most information.
    Allowed Values: [ "KEY", "DATA", "EXTENDED", "FULL" ]
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and 'asc' or 'desc'. Specify 'asc' for ascending and 'desc' for descending. The default value is 'asc'. For example, ?orderBy=field1:asc,field2:desc.
  • Value for this parameter should be Oracle Knowledge Q query - see the 'Getting Started' documentation ('Querying' page) of this operation and documentation for Q query.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : ResultList ArticleStatusData
Type: object
Title: ResultList ArticleStatusData
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : ArticleStatusData
Type: object
Title: ArticleStatusData
Show Source
Back to Top

Examples

The following example shows how to get a list of ArticleStatus objects.

curl -X "GET" "http://<IM_REST_API_HOST>/km/api/latest/articleStatus"

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" -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:

{
    "items": [
        {
            "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
        }
    ],
    "hasMore": true,
    "limit": 1,
    "offset": 0,
    "links": [
        {
            "rel": "canonical",
            "href": "https://<IM_REST_API_HOST>/km/api/v1/articleStatus?limit=1&offset=0",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        },
        {
            "rel": "next",
            "href": "https://<IM_REST_API_HOST>/km/api/v1/articleStatus?limit=1&offset=1",
            "mediaType": "application/json, application/xml",
            "method": "GET"
        }
    ],
    "count": 1
}
Back to Top