REST API for Knowledge Advanced in B2C Service

Find by ID

get

/km/api/v1/dataLists/{id}

This method returns the DataList object having the specified ID parameter.

Request

Path Parameters

id: string

The unique identifier of the object to be retrieved.

Response

Supported Media Types

application/json
application/xml

200 Response

OK.

Root Schema : DataList

Match All

Show Source

allOf DataListData
object DataList-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/DataListData"
        },
        {
            "properties":{
                "contentType":{
                    "$ref":"#/definitions/ContentTypeKey",
                    "description":"Relationship to ContentChannel"
                },
                "dataListFilters":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DataListFilterKey"
                    },
                    "description":"To Many Relationship to DataListFilter"
                },
                "dataListItems":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/DataListItemKey"
                    },
                    "description":"To Many Relationship to DataListItem"
                }
            }
        }
    ]
}

Nested Schema : DataListData

Match All

Show Source

allOf DataListKey
object DataListData-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/DataListKey"
        },
        {
            "properties":{
                "dateAdded":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date when the data list was created."
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"The date when the data list was last modified."
                },
                "defaultValue":{
                    "type":"string",
                    "description":"The value compared to defaultValueSource using defaultValueOperator to determine the default data list item."
                },
                "defaultValueOperator":{
                    "type":"integer",
                    "description":"Operator used when comparing defaultValue to defaultValueSource to determine the default data list item.  1 represents equals, 2 represents not equals."
                },
                "defaultValueSource":{
                    "type":"string",
                    "description":"The source compared to defaultValue using defaultValueOperator.  The source is an attribute of a content channel."
                },
                "displaySource":{
                    "type":"string",
                    "description":"Source of strings displayed for data list items.  This source is an attribute of a content channel."
                },
                "name":{
                    "type":"string",
                    "description":"The name of the data list.  The name field can only be used for sorting."
                },
                "sortValueSource":{
                    "type":"string",
                    "description":"The source of strings used for sorting data list items.  This source is an attribute of a content channel."
                },
                "staticSort":{
                    "type":"boolean",
                    "description":"Sorting type for static data lists.  Either 'S' for the sort order defined in the list, or 'A' for alphabetical."
                },
                "useContentGuid":{
                    "type":"boolean",
                    "description":"Unused."
                },
                "useOrFilter":{
                    "type":"string",
                    "description":"Unused."
                },
                "valueSource":{
                    "type":"string",
                    "description":"The source of strings used as values for data list items.  This source is an attribute of a content channel."
                }
            }
        }
    ]
}

Nested Schema : DataListKey

Match All

Show Source

object Singular Resource

Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"The unique identifier of the DataList object."
                },
                "referenceKey":{
                    "type":"string",
                    "description":"The reference key for the DataList object."
                }
            }
        }
    ]
}

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 : DataListKey-allOf[1]

Type: object

Show Source

recordId(optional): string

The unique identifier of the DataList object.
referenceKey(optional): string

The reference key for the DataList object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"The unique identifier of the DataList object."
        },
        "referenceKey":{
            "type":"string",
            "description":"The reference key for the DataList object."
        }
    }
}

Nested Schema : DataListData-allOf[1]

Type: object

Show Source

dateAdded(optional): string(date-time)

The date when the data list was created.
dateModified(optional): string(date-time)

The date when the data list was last modified.
defaultValue(optional): string

The value compared to defaultValueSource using defaultValueOperator to determine the default data list item.
defaultValueOperator(optional): integer

Operator used when comparing defaultValue to defaultValueSource to determine the default data list item. 1 represents equals, 2 represents not equals.
defaultValueSource(optional): string

The source compared to defaultValue using defaultValueOperator. The source is an attribute of a content channel.
displaySource(optional): string

Source of strings displayed for data list items. This source is an attribute of a content channel.
name(optional): string

The name of the data list. The name field can only be used for sorting.
sortValueSource(optional): string

The source of strings used for sorting data list items. This source is an attribute of a content channel.
staticSort(optional): boolean

Sorting type for static data lists. Either 'S' for the sort order defined in the list, or 'A' for alphabetical.
useContentGuid(optional): boolean

Unused.
useOrFilter(optional): string

Unused.
valueSource(optional): string

The source of strings used as values for data list items. This source is an attribute of a content channel.

{
    "properties":{
        "dateAdded":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the data list was created."
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the data list was last modified."
        },
        "defaultValue":{
            "type":"string",
            "description":"The value compared to defaultValueSource using defaultValueOperator to determine the default data list item."
        },
        "defaultValueOperator":{
            "type":"integer",
            "description":"Operator used when comparing defaultValue to defaultValueSource to determine the default data list item.  1 represents equals, 2 represents not equals."
        },
        "defaultValueSource":{
            "type":"string",
            "description":"The source compared to defaultValue using defaultValueOperator.  The source is an attribute of a content channel."
        },
        "displaySource":{
            "type":"string",
            "description":"Source of strings displayed for data list items.  This source is an attribute of a content channel."
        },
        "name":{
            "type":"string",
            "description":"The name of the data list.  The name field can only be used for sorting."
        },
        "sortValueSource":{
            "type":"string",
            "description":"The source of strings used for sorting data list items.  This source is an attribute of a content channel."
        },
        "staticSort":{
            "type":"boolean",
            "description":"Sorting type for static data lists.  Either 'S' for the sort order defined in the list, or 'A' for alphabetical."
        },
        "useContentGuid":{
            "type":"boolean",
            "description":"Unused."
        },
        "useOrFilter":{
            "type":"string",
            "description":"Unused."
        },
        "valueSource":{
            "type":"string",
            "description":"The source of strings used as values for data list items.  This source is an attribute of a content channel."
        }
    }
}

Nested Schema : DataList-allOf[1]

Type: object

Show Source

contentType(optional): ContentTypeKey
dataListFilters(optional): array dataListFilters

To Many Relationship to DataListFilter
dataListItems(optional): array dataListItems

To Many Relationship to DataListItem

{
    "properties":{
        "contentType":{
            "$ref":"#/definitions/ContentTypeKey",
            "description":"Relationship to ContentChannel"
        },
        "dataListFilters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataListFilterKey"
            },
            "description":"To Many Relationship to DataListFilter"
        },
        "dataListItems":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataListItemKey"
            },
            "description":"To Many Relationship to DataListItem"
        }
    }
}

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

Nested Schema : ContentTypeKey

Match All

Show Source

object Singular Resource

Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the ContentType object.</p>"
                },
                "referenceKey":{
                    "type":"string",
                    "description":"<p>The reference key for the ContentType object.</p> <p>ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>"
                },
                "name":{
                    "type":"string",
                    "description":"<p>The name for the ContentType object.  The name field can only be used for sorting.</p> <p>Content Types support multiple languages. This field identifies the object associated with the language specified by the user. </p>"
                },
                "description":{
                    "type":"string",
                    "description":"<p>The description for the ContentType object. Content Types support multiple languages.</p>        <p> This field identifies the object associated with the language specified by the user.</p>"
                }
            }
        }
    ]
}

Nested Schema : dataListFilters

Type: array

To Many Relationship to DataListFilter

Show Source

Array of: DataListFilterKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DataListFilterKey"
    },
    "description":"To Many Relationship to DataListFilter"
}

Nested Schema : dataListItems

Type: array

To Many Relationship to DataListItem

Show Source

Array of: DataListItemKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DataListItemKey"
    },
    "description":"To Many Relationship to DataListItem"
}

Nested Schema : ContentTypeKey-allOf[1]

Type: object

Show Source

description(optional): string

The description for the ContentType object. Content Types support multiple languages.

This field identifies the object associated with the language specified by the user.
name(optional): string

The name for the ContentType object. The name field can only be used for sorting.

Content Types support multiple languages. This field identifies the object associated with the language specified by the user.
recordId(optional): string

The unique identifier of the ContentType object.
referenceKey(optional): string

The reference key for the ContentType object.

ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the ContentType object.</p>"
        },
        "referenceKey":{
            "type":"string",
            "description":"<p>The reference key for the ContentType object.</p> <p>ContentType objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>The name for the ContentType object.  The name field can only be used for sorting.</p> <p>Content Types support multiple languages. This field identifies the object associated with the language specified by the user. </p>"
        },
        "description":{
            "type":"string",
            "description":"<p>The description for the ContentType object. Content Types support multiple languages.</p>        <p> This field identifies the object associated with the language specified by the user.</p>"
        }
    }
}

Nested Schema : DataListFilterKey

Match All

Show Source

object Singular Resource

Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"The unique record ID of the DataListFilter object."
                }
            }
        }
    ]
}

Nested Schema : DataListFilterKey-allOf[1]

Type: object

Show Source

recordId(optional): string

The unique record ID of the DataListFilter object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"The unique record ID of the DataListFilter object."
        }
    }
}

Nested Schema : DataListItemKey

Match All

Show Source

object Singular Resource

Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"The unique record ID of the DataListItem object."
                },
                "value":{
                    "type":"string",
                    "description":"<p>The value of the dataListItem.</p>"
                },
                "name":{
                    "type":"string",
                    "description":"<p>The name of the dataListItem.</p>"
                }
            }
        }
    ]
}

Nested Schema : DataListItemKey-allOf[1]

Type: object

Show Source

name(optional): string

The name of the dataListItem.
recordId(optional): string

The unique record ID of the DataListItem object.
value(optional): string

The value of the dataListItem.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"The unique record ID of the DataListItem object."
        },
        "value":{
            "type":"string",
            "description":"<p>The value of the dataListItem.</p>"
        },
        "name":{
            "type":"string",
            "description":"<p>The name of the dataListItem.</p>"
        }
    }
}

Examples

The following example shows how to find the Data List object having the specified ID parameter by submitting a get request on the REST resource using cURL.

cURL Command

curl -X "GET" "http://<IM_REST_API_HOST>/km/api/latest/dataLists/{id}"

Example of Request Header

The following shows an example of the request header.

-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"integrationUserToken\":\"\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9"}" \
-H "Accept: application/json"

Example of Response Body

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

{
  "contentType" : {
    "referenceKey" : "REFERENCEKEY_VALUE",
    "name" : "NAME_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}"
    } ]
  },
  "dataListFilters" : [ {
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET"
    } ]
  } ],
  "dataListItems" : [ {
    "links" : [ {
      "rel" : "canonical",
      "href" : "http://<IM_REST_API_HOST>/km/api/{version}/{resourceURI}",
      "mediaType" : "application/json, application/xml",
      "templated" : true,
      "method" : "GET"
    } ]
  } ],
  "referenceKey" : "REFERENCEKEY_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}"
  } ],
  "dateAdded" : "2013-04-23T21:06:22EDT",
  "dateModified" : "2013-04-23T21:06:22EDT",
  "defaultValue" : "DEFAULTVALUE_VALUE",
  "defaultValueOperator" : -1926441397,
  "defaultValueSource" : "DEFAULTVALUESOURCE_VALUE",
  "displaySource" : "DISPLAYSOURCE_VALUE",
  "name" : "NAME_VALUE",
  "sortValueSource" : "SORTVALUESOURCE_VALUE",
  "staticSort" : true,
  "useContentGuid" : true,
  "useOrFilter" : "USEORFILTER_VALUE",
  "valueSource" : "VALUESOURCE_VALUE"
}