REST API for Knowledge Advanced in B2C Service

Add aqi

post

/km/api/v1/content/versions/{versionId}/aqi

This method adds the Article Quality Index (AQI) score to a given content version.

This API needs both the userToken and the integrationUserToken in kmauthtoken. The API user must have the required permissions to access the API. The account user (agent) must have the 'Add Aqi' privilege for the Content Type of the document in the console role. Web users can't access this API.

In the request body, the AQI score must be between -128 and 127. Providing a comment is optional and it is limited to 4000 characters.

Response Errors

The possible error responses for this method are as follows:

OKDOM-GEN0001
The error occurs when the specified versionId parameter is invalid.
OK-SEC0001
The error occurs when:
- The user(coach) does not have the view privileges for the article.
- The user(coach) is not an Account user.
OK-GEN0036
The error occurs when the aqi score in the request body is either null or out of range of the allowed integer values from -128 to 127.
OK-GEN0007
The error occurs when the comments in the request body exceed permitted 4000 characters.
OK-GEN0026
This error occurs when API user does not have permission to access the requested API.

Example URIs

The example URIs for this method are as follows:

http://<IM_REST_API_HOST>/km/api/latest/content/versions/{versionId}/aqi
The request returns the added ArticleQualityIndex object to the specified content version.

Request

Supported Media Types

application/json
application/xml

Path Parameters

versionId: string

The content version identifier

The new content aqi

Root Schema : ArticleQualityIndexKey

Type: object

Title: ArticleQualityIndexKey

Show Source

aqi(optional): string

The AQI score of the version of a document.
coach(optional): UserKey
comments(optional): string

The comments added with AQI score.
dateAdded(optional): string(date-time)

The date when the ArticleQualityIndex object was created.
recordId(optional): string

The unique identifier of the ArticleQualityIndex object.

{
    "title":"ArticleQualityIndexKey",
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the ArticleQualityIndex object.</p>"
        },
        "aqi":{
            "type":"string",
            "description":"<p>The AQI score of the version of a document.</p>"
        },
        "comments":{
            "type":"string",
            "description":"<p>The comments added with AQI score.</p>"
        },
        "dateAdded":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the ArticleQualityIndex object was created.</p>"
        },
        "coach":{
            "$ref":"#/definitions/UserKey",
            "description":"<p>The User who submitted AQI score to the article.</p>"
        }
    }
}

Nested Schema : UserKey

Match All

Show Source

object Singular Resource

Title: Singular Resource

Oracle base singular resource schema definition.
object UserKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"The unique record ID of the User object."
                },
                "name":{
                    "type":"string",
                    "description":"User's full name"
                },
                "email":{
                    "type":"string",
                    "description":"Email of the User object"
                },
                "externalId":{
                    "type":"integer",
                    "description":"The ExternalId is the Id of the corresponding User from an external system.  It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system."
                },
                "externalType":{
                    "type":"string",
                    "description":"The ExternalType is the type of the corresponding User from an external system.  It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system."
                }
            }
        }
    ]
}

Nested Schema : Singular Resource

Type: object

Title: Singular Resource

Oracle base singular resource schema definition.

Show Source

links(optional): array links

{
    "title":"Singular Resource",
    "description":"Oracle base singular resource schema definition.",
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/instanceLink"
            }
        }
    }
}

Nested Schema : UserKey-allOf[1]

Type: object

Show Source

email(optional): string

Email of the User object
externalId(optional): integer

The ExternalId is the Id of the corresponding User from an external system. It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.
externalType(optional): string

The ExternalType is the type of the corresponding User from an external system. It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system.
name(optional): string

User's full name
recordId(optional): string

The unique record ID of the User object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"The unique record ID of the User object."
        },
        "name":{
            "type":"string",
            "description":"User's full name"
        },
        "email":{
            "type":"string",
            "description":"Email of the User object"
        },
        "externalId":{
            "type":"integer",
            "description":"The ExternalId is the Id of the corresponding User from an external system.  It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system."
        },
        "externalType":{
            "type":"string",
            "description":"The ExternalType is the type of the corresponding User from an external system.  It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system."
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

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

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

Nested Schema : instanceLink

Type: object

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

Show Source

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.

{
    "type":"object",
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "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"
        },
        "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"
        },
        "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"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "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"
    ]
}

Response

Supported Media Types

application/json
application/xml

201 Response

Created.

Root Schema : ArticleQualityIndexKey

Type: object

Title: ArticleQualityIndexKey

Show Source

aqi(optional): string

The AQI score of the version of a document.
coach(optional): UserKey
comments(optional): string

The comments added with AQI score.
dateAdded(optional): string(date-time)

The date when the ArticleQualityIndex object was created.
recordId(optional): string

The unique identifier of the ArticleQualityIndex object.

{
    "title":"ArticleQualityIndexKey",
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the ArticleQualityIndex object.</p>"
        },
        "aqi":{
            "type":"string",
            "description":"<p>The AQI score of the version of a document.</p>"
        },
        "comments":{
            "type":"string",
            "description":"<p>The comments added with AQI score.</p>"
        },
        "dateAdded":{
            "type":"string",
            "format":"date-time",
            "description":"<p>The date when the ArticleQualityIndex object was created.</p>"
        },
        "coach":{
            "$ref":"#/definitions/UserKey",
            "description":"<p>The User who submitted AQI score to the article.</p>"
        }
    }
}

Nested Schema : UserKey

Match All

Show Source

object Singular Resource

Title: Singular Resource

Oracle base singular resource schema definition.
object UserKey-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"The unique record ID of the User object."
                },
                "name":{
                    "type":"string",
                    "description":"User's full name"
                },
                "email":{
                    "type":"string",
                    "description":"Email of the User object"
                },
                "externalId":{
                    "type":"integer",
                    "description":"The ExternalId is the Id of the corresponding User from an external system.  It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system."
                },
                "externalType":{
                    "type":"string",
                    "description":"The ExternalType is the type of the corresponding User from an external system.  It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system."
                }
            }
        }
    ]
}

Nested Schema : Singular Resource

Type: object

Title: Singular Resource

Oracle base singular resource schema definition.

Show Source

links(optional): array links

{
    "title":"Singular Resource",
    "description":"Oracle base singular resource schema definition.",
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/instanceLink"
            }
        }
    }
}

Nested Schema : UserKey-allOf[1]

Type: object

Show Source

email(optional): string

Email of the User object
externalId(optional): integer

The ExternalId is the Id of the corresponding User from an external system. It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.
externalType(optional): string

The ExternalType is the type of the corresponding User from an external system. It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system.
name(optional): string

User's full name
recordId(optional): string

The unique record ID of the User object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"The unique record ID of the User object."
        },
        "name":{
            "type":"string",
            "description":"User's full name"
        },
        "email":{
            "type":"string",
            "description":"Email of the User object"
        },
        "externalId":{
            "type":"integer",
            "description":"The ExternalId is the Id of the corresponding User from an external system.  It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system."
        },
        "externalType":{
            "type":"string",
            "description":"The ExternalType is the type of the corresponding User from an external system.  It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system."
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object instanceLink

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

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

Nested Schema : instanceLink

Type: object

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

Show Source

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.

{
    "type":"object",
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "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"
        },
        "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"
        },
        "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"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "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"
    ]
}

Examples

The following example shows how to add the AQI score to a given content version by submitting a post request on the REST resource using cURL.

cURL Command

Command: curl -X "POST" "http://<IM_REST_API_HOST>/km/api/latest/content/versions/{versionId}/aqi"

Example of Request Header

The following shows an example of the request header.

-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"integrationUserToken\":\"\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9",\"userToken\":\"UoyWTKRG4RpyJCH4Wqjzht2iYUrsDdk5ir+3IpwEkxcwajJkGR9OGSQBTANQVGW0iVT9MFeDzqL+RYdgfzGSK+h5QzDFIDM+rDLgdKeEE19ljWFm3zMCF+kgYp/dJ/Yq5V7Re+aDXqHg6YkHfvprFA==\"}" \
-H "Accept: application/json"

Example of Request Body

The following shows an example of the request body in JSON format.

{
  "aqi" : "55",
  "comments" : "COMMENTS_VALUE"
}

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "recordId" : "RECORDID_VALUE",
  "aqi" : "55",
  "comments" : "COMMENTS_VALUE",
  "dateAdded" : "149250275-05-03T01:32:10-0600",
  "coach" : {
    "recordId" : "RECORDID_VALUE",
    "name" : "NAME_VALUE",
    "email" : "EMAIL_VALUE",
    "externalId" : 1587554420000,
    "externalType" : "EXTERNALTYPE_VALUE",
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET",
      "profile" : "http://<IM_REST_API_HOST>/km/api/{version}/metadata-catalog/{resourceName}"
    } ]
  }
}