Jump to

• Request
• Response

Get a content type

get

/contentTypes/{id}

Request

Path Parameters

• id(required): string
  The unique identifier of the ContentType object.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : ContentTypeKeyBO

Type: object

Documentation for BO mode: ContentTypeKeyBO

Show Source

• articleGroup: object Type of articles
  Title: Type of articles

  Read Only: true

  Article group identify type of article this conten type will have.

  The valid values are:

  • ARTICLE
  • REUSABLE_ARTICLE
• contentSourceType: string
  Title: content source Type

  Read Only: true

  contentSourceType to distinguish if it is a content type for external content
• description: string
  Title: Description

  Maximum Length: 255

  The description for the ContentType object. Content Types support multiple languages. This field identifies the object associated with the language specified by the user.
• family: string
  Title: Family

  Read Only: true

  The Fusion family that this content type belongs to
• links: array Links
  Title: Links

  Read Only: true

  REST API canonical and/or collection links for this Singular Resource
• name(required): string
  Title: Name

  Minimum Length: 1

  Maximum Length: 255

  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.
• namespaceFromStripe: string
• product: string
  Title: Product

  Read Only: true

  The Fusion product that this content type belongs to
• recordId: string
  Title: Record Id

  Read Only: true

  The unique identifier of the ContentType object.
• referenceKey(required): string
  Title: Reference Key

  Minimum Length: 1

  Maximum Length: 255

  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.
• stripeCd(required): string
  Title: Stripe Cd

  Maximum Length: 100

  Lookup code that indicates the stripe code.
• usageCode: string
  Title: Usage Code

  Read Only: true

  Maximum Length: 30

  Lookup code that indicates the product usage code.
• workflow: object Workflow
  Title: Workflow

  The workflow definition that the author can use while content authoring in a content type.

{
    "description":"Documentation for BO mode: ContentTypeKeyBO",
    "required":[
        "referenceKey",
        "name",
        "stripeCd"
    ],
    "type":"object",
    "properties":{
        "recordId":{
            "title":"Record Id",
            "description":"The unique identifier of the ContentType object.",
            "type":"string",
            "readOnly":true
        },
        "referenceKey":{
            "title":"Reference Key",
            "description":"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.",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false
        },
        "name":{
            "title":"Name",
            "description":"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. ",
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "readOnly":false
        },
        "description":{
            "title":"Description",
            "description":"The description for the ContentType object. Content Types support multiple languages. This field identifies the object associated with the language specified by the user.",
            "maxLength":255,
            "type":"string",
            "readOnly":false
        },
        "stripeCd":{
            "title":"Stripe Cd",
            "description":"Lookup code that indicates the stripe code.",
            "maxLength":100,
            "type":"string",
            "readOnly":false
        },
        "usageCode":{
            "title":"Usage Code",
            "description":"Lookup code that indicates the product usage code.",
            "maxLength":30,
            "type":"string",
            "readOnly":true
        },
        "workflow":{
            "title":"Workflow",
            "description":"The workflow definition that the author can use while content authoring in a content type.",
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkflowKeyBO"
                }
            ],
            "readOnly":false
        },
        "articleGroup":{
            "title":"Type of articles",
            "description":"<p>Article group identify type of article this conten type will have.</p><p>The valid values are:</p><ul><li>ARTICLE</li><li>REUSABLE_ARTICLE</li>",
            "enum":[
                "ARTICLE",
                "REUSABLE_ARTICLE"
            ],
            "type":"object",
            "readOnly":true
        },
        "links":{
            "title":"Links",
            "description":"REST API canonical and/or collection links for this Singular Resource",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            },
            "readOnly":true
        },
        "contentSourceType":{
            "title":"content source Type",
            "description":"contentSourceType to distinguish if it is a content type for external content",
            "type":"string",
            "readOnly":true
        },
        "namespaceFromStripe":{
            "type":"string"
        },
        "family":{
            "title":"Family",
            "description":"The Fusion family that this content type belongs to",
            "type":"string",
            "readOnly":true
        },
        "product":{
            "title":"Product",
            "description":"The Fusion product that this content type belongs to",
            "type":"string",
            "readOnly":true
        }
    }
}

Nested Schema : Type of articles

Type: object

Title: Type of articles

Read Only: true

Article group identify type of article this conten type will have.

The valid values are:

• ARTICLE
• REUSABLE_ARTICLE

Allowed Values: [ "ARTICLE", "REUSABLE_ARTICLE" ]

Nested Schema : Links

Type: array

Title: Links

Read Only: true

REST API canonical and/or collection links for this Singular Resource

Show Source

• Array of: object Link

{
    "title":"Links",
    "description":"REST API canonical and/or collection links for this Singular Resource",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    },
    "readOnly":true
}

Nested Schema : Workflow

Type: object

Title: Workflow

The workflow definition that the author can use while content authoring in a content type.

Match All

The workflow definition that the author can use while content authoring in a content type.

Show Source

• object WorkflowKeyBO

{
    "title":"Workflow",
    "description":"The workflow definition that the author can use while content authoring in a content type.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkflowKeyBO"
        }
    ],
    "readOnly":false
}

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

Nested Schema : WorkflowKeyBO

Type: object

Show Source

• enabled: boolean
• links: array links
• name: string
  Maximum Length: 255
• recordId: string
• referenceKey: string
  Minimum Length: 0

  Maximum Length: 100
• workflowVersion: integer (int32)

{
    "type":"object",
    "properties":{
        "recordId":{
            "type":"string"
        },
        "referenceKey":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "name":{
            "maxLength":255,
            "type":"string"
        },
        "workflowVersion":{
            "format":"int32",
            "type":"integer"
        },
        "enabled":{
            "type":"boolean"
        },
        "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"
    }
}

Back to Top