Jump to

• Request
• Response

Get the default repository

get

/repositories/default

Use this API to retrieve the ID used in the other repositories apis.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : RepositorySummaryBO

Type: object

Summary returned by the default repository endpoint.

Show Source

• dateAdded: string (date-time)
• dateModified: string (date-time)
• links: array links
• name: string
• objectId: string
• recordId: string
• referenceKey: string

{
    "description":"Summary returned by the default repository endpoint.",
    "type":"object",
    "properties":{
        "recordId":{
            "type":"string"
        },
        "referenceKey":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "objectId":{
            "type":"string"
        },
        "dateAdded":{
            "type":"string",
            "format":"date-time"
        },
        "dateModified":{
            "type":"string",
            "format":"date-time"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• mediaType: string
• method: string
• profile: string
• rel: string
• sinceVersion: string
• templated: boolean

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "templated":{
            "type":"boolean"
        },
        "method":{
            "type":"string"
        },
        "profile":{
            "type":"string",
            "writeOnly":true
        },
        "sinceVersion":{
            "type":"string",
            "writeOnly":true
        }
    }
}

Back to Top