Jump to

• Request
• Response

Find by ID

get

/km/api/v1/repositories/{id}

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

Example URIs

The example URIs for this method are as follows:

• http://<IM_REST_API_HOST>/km/api/latest/repositories/{id}

  This method returns the Repository object having the specified ID parameter in the FULL mode.

• http://<IM_REST_API_HOST>/km/api/latest/repositories/{id}?mode=KEY

  This method returns the Repository object having the specified ID parameter in KEY mode.

Request

Path Parameters

• id: 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 : Repository

Match All

Show Source

• allOf RepositoryData
• object Repository-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/RepositoryData"
        },
        {
            "properties":{
                "availableLocales":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LocaleKey"
                    },
                    "description":"List of locales supported by the repository"
                },
                "defaultLocale":{
                    "$ref":"#/definitions/LocaleKey",
                    "description":"The default locale used by the repository"
                },
                "extendedProperties":{
                    "type":"string",
                    "description":"The extended repository properties for the repository. This attribute is expecting an XML structure using the Repository reference key as the root          element and a node containing each extended property and value inside it"
                },
                "categoriesAssignedToView":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/CategoryKey"
                    },
                    "description":"Categories allowed by the repository view"
                },
                "userSchema":{
                    "$ref":"#/definitions/SchemaKey",
                    "description":"Schema definition for the extended properties defined for users          @since 8.3"
                },
                "viewSchema":{
                    "$ref":"#/definitions/SchemaKey",
                    "description":"Schema definition for the extended properties defined for repositories/views          @since 8.3"
                }
            }
        }
    ]
}

Nested Schema : RepositoryData

Match All

Show Source

• allOf RepositoryKey
• object RepositoryData-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/RepositoryKey"
        },
        {
            "properties":{
                "autoAssignWorkflowWhenApproved":{
                    "type":"boolean",
                    "description":"Flag indicating whether workflow tasks should be assigned automatically"
                },
                "autoAssignInitialWorkflow":{
                    "type":"boolean",
                    "description":"Flag indicating whether the initial workflow step should be automatically assigned"
                },
                "autoAssignWorkflowWhenRejected":{
                    "type":"boolean",
                    "description":"Flag indicating whether the workflow task should be automatically assigned when the doc is rejected"
                },
                "autoAssignTranslationTask":{
                    "type":"boolean",
                    "description":"Flag indicating whether translation tasks should be automatically assigned"
                },
                "dateAdded":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Timestamp when the repository was originally created"
                },
                "dateModified":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Timestamp when the repository definition was last modified"
                },
                "name":{
                    "type":"string",
                    "description":"Localized display name of the repository"
                },
                "objectId":{
                    "type":"string",
                    "description":"A decimal representation of the hierarchy of the repository. Root repositories do not have any decimals"
                },
                "restrictTaskCats":{
                    "type":"boolean",
                    "description":"Filter tasks so users are only made aware of tasks matching their skill category"
                },
                "usersCanSelfAdminCategories":{
                    "type":"boolean",
                    "description":"Allow Users to self-administer categories"
                },
                "usersCanSelfAdminLocales":{
                    "type":"boolean",
                    "description":"Allow Users to self-administer locales"
                },
                "usersCanSelfAdminTeams":{
                    "type":"boolean",
                    "description":"Allow Users to self-administer teams"
                },
                "filterTasksForUsersMatchingSkills":{
                    "type":"boolean",
                    "description":"Require at least one matching skill category from every top-level category branch"
                },
                "taskPreFix":{
                    "type":"string",
                    "description":"A character string prepended to the task identifer"
                }
            }
        }
    ]
}

Nested Schema : RepositoryKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"GUID of the repository from the SITE table"
                },
                "referenceKey":{
                    "type":"string",
                    "description":"non localized name of the repository"
                }
            }
        }
    ]
}

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

Type: object

Show Source

• recordId(optional): string
  GUID of the repository from the SITE table
• referenceKey(optional): string
  non localized name of the repository

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"GUID of the repository from the SITE table"
        },
        "referenceKey":{
            "type":"string",
            "description":"non localized name of the repository"
        }
    }
}

Nested Schema : RepositoryData-allOf[1]

Type: object

Show Source

• autoAssignInitialWorkflow(optional): boolean
  Flag indicating whether the initial workflow step should be automatically assigned
• autoAssignTranslationTask(optional): boolean
  Flag indicating whether translation tasks should be automatically assigned
• autoAssignWorkflowWhenApproved(optional): boolean
  Flag indicating whether workflow tasks should be assigned automatically
• autoAssignWorkflowWhenRejected(optional): boolean
  Flag indicating whether the workflow task should be automatically assigned when the doc is rejected
• dateAdded(optional): string(date-time)
  Timestamp when the repository was originally created
• dateModified(optional): string(date-time)
  Timestamp when the repository definition was last modified
• filterTasksForUsersMatchingSkills(optional): boolean
  Require at least one matching skill category from every top-level category branch
• name(optional): string
  Localized display name of the repository
• objectId(optional): string
  A decimal representation of the hierarchy of the repository. Root repositories do not have any decimals
• restrictTaskCats(optional): boolean
  Filter tasks so users are only made aware of tasks matching their skill category
• taskPreFix(optional): string
  A character string prepended to the task identifer
• usersCanSelfAdminCategories(optional): boolean
  Allow Users to self-administer categories
• usersCanSelfAdminLocales(optional): boolean
  Allow Users to self-administer locales
• usersCanSelfAdminTeams(optional): boolean
  Allow Users to self-administer teams

{
    "properties":{
        "autoAssignWorkflowWhenApproved":{
            "type":"boolean",
            "description":"Flag indicating whether workflow tasks should be assigned automatically"
        },
        "autoAssignInitialWorkflow":{
            "type":"boolean",
            "description":"Flag indicating whether the initial workflow step should be automatically assigned"
        },
        "autoAssignWorkflowWhenRejected":{
            "type":"boolean",
            "description":"Flag indicating whether the workflow task should be automatically assigned when the doc is rejected"
        },
        "autoAssignTranslationTask":{
            "type":"boolean",
            "description":"Flag indicating whether translation tasks should be automatically assigned"
        },
        "dateAdded":{
            "type":"string",
            "format":"date-time",
            "description":"Timestamp when the repository was originally created"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time",
            "description":"Timestamp when the repository definition was last modified"
        },
        "name":{
            "type":"string",
            "description":"Localized display name of the repository"
        },
        "objectId":{
            "type":"string",
            "description":"A decimal representation of the hierarchy of the repository. Root repositories do not have any decimals"
        },
        "restrictTaskCats":{
            "type":"boolean",
            "description":"Filter tasks so users are only made aware of tasks matching their skill category"
        },
        "usersCanSelfAdminCategories":{
            "type":"boolean",
            "description":"Allow Users to self-administer categories"
        },
        "usersCanSelfAdminLocales":{
            "type":"boolean",
            "description":"Allow Users to self-administer locales"
        },
        "usersCanSelfAdminTeams":{
            "type":"boolean",
            "description":"Allow Users to self-administer teams"
        },
        "filterTasksForUsersMatchingSkills":{
            "type":"boolean",
            "description":"Require at least one matching skill category from every top-level category branch"
        },
        "taskPreFix":{
            "type":"string",
            "description":"A character string prepended to the task identifer"
        }
    }
}

Nested Schema : Repository-allOf[1]

Type: object

Show Source

• availableLocales(optional): array availableLocales
  List of locales supported by the repository
• categoriesAssignedToView(optional): array categoriesAssignedToView
  Categories allowed by the repository view
• defaultLocale(optional): LocaleKey
• extendedProperties(optional): string
  The extended repository properties for the repository. This attribute is expecting an XML structure using the Repository reference key as the root element and a node containing each extended property and value inside it
• userSchema(optional): SchemaKey
• viewSchema(optional): SchemaKey

{
    "properties":{
        "availableLocales":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LocaleKey"
            },
            "description":"List of locales supported by the repository"
        },
        "defaultLocale":{
            "$ref":"#/definitions/LocaleKey",
            "description":"The default locale used by the repository"
        },
        "extendedProperties":{
            "type":"string",
            "description":"The extended repository properties for the repository. This attribute is expecting an XML structure using the Repository reference key as the root          element and a node containing each extended property and value inside it"
        },
        "categoriesAssignedToView":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CategoryKey"
            },
            "description":"Categories allowed by the repository view"
        },
        "userSchema":{
            "$ref":"#/definitions/SchemaKey",
            "description":"Schema definition for the extended properties defined for users          @since 8.3"
        },
        "viewSchema":{
            "$ref":"#/definitions/SchemaKey",
            "description":"Schema definition for the extended properties defined for repositories/views          @since 8.3"
        }
    }
}

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

Type: array

List of locales supported by the repository

Show Source

• Array of: LocaleKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LocaleKey"
    },
    "description":"List of locales supported by the repository"
}

Nested Schema : categoriesAssignedToView

Type: array

Categories allowed by the repository view

Show Source

• Array of: CategoryKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CategoryKey"
    },
    "description":"Categories allowed by the repository view"
}

Nested Schema : LocaleKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique identifier of the Locale object.</p>"
                }
            }
        }
    ]
}

Nested Schema : SchemaKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

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

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

Nested Schema : CategoryKey

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

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

{
    "allOf":[
        {
            "$ref":"#/definitions/singularResource"
        },
        {
            "properties":{
                "recordId":{
                    "type":"string",
                    "description":"<p>The unique record ID of the Category object.</p>"
                },
                "referenceKey":{
                    "type":"string",
                    "description":"<p>The reference key for the Category object. Category objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>"
                },
                "objectId":{
                    "type":"string",
                    "description":"The hierarchichal position of the category"
                },
                "name":{
                    "type":"string",
                    "description":"<p>The name of the category.</p>"
                },
                "externalId":{
                    "type":"integer",
                    "description":"<p>The unique identifier used while integrating the repository data with the external system.</p>"
                },
                "externalType":{
                    "type":"string",
                    "description":"<p>The type of the category used while integrating the repository data with the external system. Valid options are PRODUCT and CATEGORY.</p>"
                },
                "responseLocale":{
                    "type":"string",
                    "description":"<p>This is a custom field that will get populated if a name is translated into the default locale when the translated name is not found.</p>"
                },
                "description":{
                    "type":"string",
                    "description":"Description of the Category object"
                },
                "childrenCount":{
                    "type":"integer",
                    "description":"<p>This field will return number of immediate children a category has.</p> <p>This field will only be populated if childrenCount query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY</li> </ul>"
                },
                "parents":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/CategoryKey"
                    },
                    "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>"
                }
            }
        }
    ]
}

Nested Schema : CategoryKey-allOf[1]

Type: object

Show Source

• childrenCount(optional): integer

  This field will return number of immediate children a category has.

  This field will only be populated if childrenCount query parameter is passed in with value true.

  Example URIs for the this parameter are as follows:

  • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?childrenCount=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY
• description(optional): string
  Description of the Category object
• externalId(optional): integer

  The unique identifier used while integrating the repository data with the external system.

• externalType(optional): string

  The type of the category used while integrating the repository data with the external system. Valid options are PRODUCT and CATEGORY.

• name(optional): string

  The name of the category.

• objectId(optional): string
  The hierarchichal position of the category
• parents(optional): array parents

  This field will return all parents of category.

  This field will only be populated if withParents query parameter is passed in with value true.

  Example URIs for the this parameter are as follows:

  • http://<IM_REST_API_HOST>/km/api/categories/{id}?withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY
• recordId(optional): string

  The unique record ID of the Category object.

• referenceKey(optional): string

  The reference key for the Category object. Category objects support multiple languages. This field can be used to identify the associated objects for all languages.

• responseLocale(optional): string

  This is a custom field that will get populated if a name is translated into the default locale when the translated name is not found.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique record ID of the Category object.</p>"
        },
        "referenceKey":{
            "type":"string",
            "description":"<p>The reference key for the Category object. Category objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>"
        },
        "objectId":{
            "type":"string",
            "description":"The hierarchichal position of the category"
        },
        "name":{
            "type":"string",
            "description":"<p>The name of the category.</p>"
        },
        "externalId":{
            "type":"integer",
            "description":"<p>The unique identifier used while integrating the repository data with the external system.</p>"
        },
        "externalType":{
            "type":"string",
            "description":"<p>The type of the category used while integrating the repository data with the external system. Valid options are PRODUCT and CATEGORY.</p>"
        },
        "responseLocale":{
            "type":"string",
            "description":"<p>This is a custom field that will get populated if a name is translated into the default locale when the translated name is not found.</p>"
        },
        "description":{
            "type":"string",
            "description":"Description of the Category object"
        },
        "childrenCount":{
            "type":"integer",
            "description":"<p>This field will return number of immediate children a category has.</p> <p>This field will only be populated if childrenCount query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY</li> </ul>"
        },
        "parents":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CategoryKey"
            },
            "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>"
        }
    }
}

Nested Schema : parents

Type: array

This field will return all parents of category.

This field will only be populated if withParents query parameter is passed in with value true.

Example URIs for the this parameter are as follows:

• http://<IM_REST_API_HOST>/km/api/categories/{id}?withParents=true&mode=KEY
• http://<IM_REST_API_HOST>/km/api/categories?withParents=true&mode=KEY
• http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY
• http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY

Show Source

• Array of: CategoryKey

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CategoryKey"
    },
    "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>"
}

Nested Schema : LocaleKey-allOf[1]

Type: object

Show Source

• recordId(optional): string

  The unique identifier of the Locale object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"<p>The unique identifier of the Locale object.</p>"
        }
    }
}

Nested Schema : SchemaKey-allOf[1]

Type: object

Show Source

• recordId(optional): string
  unique identfier of the schema object.

{
    "properties":{
        "recordId":{
            "type":"string",
            "description":"unique identfier of the schema object."
        }
    }
}

Back to Top