Jump to

• Request
• Response

List All Inplace Previews of a Type

get

/content/management/api/v1.1/types/{name}/inplacePreview

List all Inplace Previews of a Type.

Request

Path Parameters

• name: string
  Type name identifier is case-sensitive and any special characters must be encoded

Query Parameters

• links(optional): string
  This parameter accepts a comma-separated list of link names. By default, this parameter gives all the links applicable. Possible values are: self, canonical, describedby

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : TypeSubResourceListInplacePreviews

Type: object

InplacePreviews

Show Source

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InplacePreview"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"InplacePreviews"
}

Nested Schema : data

Type: array

Show Source

• Array of: object InplacePreview
  InplacePreview

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : InplacePreview

Type: object

InplacePreview

Show Source

• isSiteExternal(optional): boolean
• pageId(optional): string
• pageName(optional): string
• pageUrl(optional): string
• siteId(optional): string
• siteName(optional): string
• typeId(optional): string

{
    "type":"object",
    "properties":{
        "typeId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "pageId":{
            "type":"string"
        },
        "isSiteExternal":{
            "type":"boolean"
        },
        "siteName":{
            "type":"string"
        },
        "pageName":{
            "type":"string"
        },
        "pageUrl":{
            "type":"string"
        }
    },
    "description":"InplacePreview"
}

Nested Schema : Link

Type: object

Link of the resource.

Show Source

• href(optional): string
  The target resource's URI. It could be template URI. It is a required property in the get response.
• mediaType(optional): string
  Media type.
• method(optional): string
  What HTTP method can be used to access the target resource.
• profile(optional): string
  Link to the metadata that describes the target resource.
• rel(optional): string
  Relation type. It is a required property in the get response.
• templated(optional): boolean
  Whether the URI is a template.

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

304 Response

Not modified.

400 Response

Bad request.

403 Response

Forbidden.

500 Response

Internal server error.

Back to Top