Jump to

• Request
• Response
• Examples

Get media

get

/km/api/v1/media

This method returns the list of files in the repository the user has access to.

Example URIs

The nameTokenSearchType parameter value will be applied only if the nameToken parameter is specified as well.

The default value of the nameTokenSearchType is CONTAINS if the nameToken is set by itself.

The relativePath and nameToken may be combined or specified separately.

Following are the example URIs for this method:

• http://<IM_REST_API_HOST>/km/api/latest/media?nameToken=fileName

  The request returns a list of files that contains the string specified by the nameToken query parameter.

• http://<IM_REST_API_HOST>/km/api/latest/media?relativePath=path

  The request returns a list of files that are located in or under the relativePath parameter value.

• http://<IM_REST_API_HOST>/km/api/latest/media?relativePath=path&nameToken=fileName&nameTokenSearchType=STARTS_WITH

  The request returns a list of files that are located in or under the relativePath parameter value where the file's name starts with the passed in value of the nameToken.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• limit(optional): integer
  Number of files to return
• nameToken(optional): string
  The filename to search on
• nameTokenSearchType(optional):
  Valid values are CONTAINS, STARTS_WITH, ENDS_WITH. If nothing is passed it will be defaulted to CONTAINS.

  Allowed Values: [ "STARTS_WITH", "ENDS_WITH", "CONTAINS" ]
• offset(optional): integer
  Start index
• relativePath(optional): string
  The relative path to look for files

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK.

Body ()

Root Schema : ResultList MediaItem

Type: object

Title: ResultList MediaItem

Match All

Show Source

• allOf Collection Paging Resource
  Title: Collection Paging Resource

  Oracle base collection resource schema definition.
• object ResultList MediaItem-allOf[1]

{
    "title":"ResultList MediaItem",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/collectionPagedResource"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/MediaItem"
                    }
                }
            }
        }
    ]
}

Nested Schema : Collection Paging Resource

Title: Collection Paging Resource

Oracle base collection resource schema definition.

Match All

Show Source

• allOf Base Collection Resource
  Title: Base Collection Resource

  Oracle base collection resource schema definition.
• object Collection Paging Resource-allOf[1]

{
    "title":"Collection Paging Resource",
    "description":"Oracle base collection resource schema definition. ",
    "allOf":[
        {
            "$ref":"#/definitions/collectionBaseResource"
        },
        {
            "properties":{
                "hasMore":{
                    "type":"boolean",
                    "description":"Boolean value that is set to true if more resources are available on the server than the subset returned in current page."
                },
                "totalResults":{
                    "type":"integer",
                    "description":"Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request."
                },
                "limit":{
                    "type":"integer",
                    "description":"Actual paging size used by the server."
                },
                "count":{
                    "type":"integer",
                    "description":"Number of resource instances returned in the current range."
                },
                "offset":{
                    "type":"integer",
                    "description":"Offset value used in the current page. "
                }
            }
        }
    ]
}

Nested Schema : Base Collection Resource

Title: Base Collection Resource

Oracle base collection resource schema definition.

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

  Oracle base singular resource schema definition.
• object Base Collection Resource-allOf[1]

{
    "title":"Base Collection Resource",
    "description":"Oracle base collection resource schema definition. ",
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "type":"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 : Base Collection Resource-allOf[1]

Type: object

Show Source

• items(optional): array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    }
}

Nested Schema : Collection Paging Resource-allOf[1]

Type: object

Show Source

• count(optional): integer
  Number of resource instances returned in the current range.
• hasMore(optional): boolean
  Boolean value that is set to true if more resources are available on the server than the subset returned in current page.
• limit(optional): integer
  Actual paging size used by the server.
• offset(optional): integer
  Offset value used in the current page.
• totalResults(optional): integer
  Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request.

{
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Boolean value that is set to true if more resources are available on the server than the subset returned in current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request."
        },
        "limit":{
            "type":"integer",
            "description":"Actual paging size used by the server."
        },
        "count":{
            "type":"integer",
            "description":"Number of resource instances returned in the current range."
        },
        "offset":{
            "type":"integer",
            "description":"Offset value used in the current page. "
        }
    }
}

Nested Schema : ResultList MediaItem-allOf[1]

Type: object

Show Source

• items(optional): array items

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

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

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : items

Type: array

Show Source

• Array of: object MediaItem
  Title: MediaItem

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

Nested Schema : MediaItem

Type: object

Title: MediaItem

Show Source

• errorMessage(optional): string
  Contains error messages if request for this file was unsucessful
• fileName(optional): string
  The name of the file
• relativePath(optional): string
  Relative path under the repository to place image in
• resourceURL(optional): string
  Relative path to image stored in the repository
• thumbnailURL(optional): string
  Relative path to thumbnail image stored in the repository

{
    "title":"MediaItem",
    "properties":{
        "fileName":{
            "type":"string",
            "description":"The name of the file"
        },
        "relativePath":{
            "type":"string",
            "description":"Relative path under the repository to place image in"
        },
        "resourceURL":{
            "type":"string",
            "description":"Relative path to image stored in the repository"
        },
        "thumbnailURL":{
            "type":"string",
            "description":"Relative path to thumbnail image stored in the repository"
        },
        "errorMessage":{
            "type":"string",
            "description":"Contains error messages if request for this file was unsucessful"
        }
    }
}

Back to Top

Examples

The following example shows how to find a list of media files in the Oracle Knowledge repository by submitting a GET request on the REST resource using cURL.

cURL Command Example

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

Example of Request Header

The following shows an example of the request header.

-H "kmauthtoken: {\"siteName\":\"ORACLE_KNOWLEDGE\",\"integrationUserToken\":\"\"+eCJYkxKwj5HUaIiJYun0/TpatwT1LmtcsF05W33xnEojifV/AsLDj9RpN0lKuorTMNKeSE1tgC7svVL+BzntqDON4KiM1HFlpxvXEUCB0P2w0Xrs75McygqxdVaDSE9",\"userToken\":\"vS7CbxXcItaVWh3koKSYt3VzA5mEgPbW0xnGb1QFZXh3bo6+qUxTh2TWtgJKKe9Khc54JaIsA7cbGU7wHIViiAe+qcWYmqX9ilX1qEehL3AXxkQi6p6tG+avlJOqn+A9qYZXiWmw9jbh8BMsP62oiQ=="}" \
-H "Accept: application/json"

Response Body Example

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

{
  "items" : [ {
    "fileName" : "FILENAME_VALUE",
    "relativePath" : "RELATIVEPATH_VALUE",
    "resourceURL" : "RESOURCEURL_VALUE",
    "thumbnailURL" : "THUMBNAILURL_VALUE",
    "errorMessage" : "ERRORMESSAGE_VALUE"
  }, {
    "fileName" : "FILENAME_VALUE",
    "relativePath" : "RELATIVEPATH_VALUE",
    "resourceURL" : "RESOURCEURL_VALUE",
    "thumbnailURL" : "THUMBNAILURL_VALUE",
    "errorMessage" : "ERRORMESSAGE_VALUE"
  }, {
    "fileName" : "FILENAME_VALUE",
    "relativePath" : "RELATIVEPATH_VALUE",
    "resourceURL" : "RESOURCEURL_VALUE",
    "thumbnailURL" : "THUMBNAILURL_VALUE",
    "errorMessage" : "ERRORMESSAGE_VALUE"
  } ],
  "hasMore" : false,
  "limit" : 20,
  "offset" : 0,
  "count" : 3
}

Back to Top