Jump to

• Request
• Response
• Examples

Get history of content by doc ID

get

/km/api/v1/content/docId/{docId}/history

This method returns list of ContentHistory objects associated with all the versions of the LATEST version of the document specified by document Id. User can override the default user locale by passing the 'langpref' URL parameter. As a note, the URL parameter, 'contentState', will be ignored. A ContentHistory Object represents an action performed on a given document.

This service accepts action filter list to filter history by action type. To filter by multipe values filter values should be separted by colon (:).

Possible values for this parameter are :

• CREATED
• EDITED
• GSR_EDITED
• APPROVED
• REJECTED
• PUBLISHED
• PENDING_PUBLISHED
• GSR_PUBLISHED
• UNPUBLISHED
• LOCALIZED
• REVERTED
• MOD_CATEGORY
• MOD_SITE_VIS
• MOD_USER_VIS
• LOCALIZATION_REQUESTED
• LOCALIZATION_CLEARED
• METADATA_CHANGED
• WORKFLOWCOMMENT_ADDED

NOTE:Values for this parameter are case sensetive. If this parameter is not passed unfiltered results will be returned.

Example URIs

The example URIs for this method are as follows:

• http://<IM_REST_API_HOST>/km/api/latest/content/docId/{docId}/history

  The request returns list of ContentHistory objects associated with the specified document.

• http://<IM_REST_API_HOST>/km/api/latest/content/docId/{docId}/history?action=EDITED:CREATED

  The request returns list of ContentHistory objects associated with the specified content object.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• docId: string
  The document identifier

Query Parameters

• action(optional): string
  To filter history by action type.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK.

Body ()

Root Schema : ResultList ContentHistory

Type: object

Title: ResultList ContentHistory

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.
• items(optional): array items
• limit(optional): integer
  Actual paging size used by the server.
• links(optional): array links
• 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.

{
    "title":"ResultList ContentHistory",
    "properties":{
        "hasMore":{
            "description":"Boolean value that is set to true if more resources are available on the server than the subset returned in current page.",
            "type":"boolean"
        },
        "limit":{
            "description":"Actual paging size used by the server.",
            "type":"integer"
        },
        "count":{
            "description":"Number of resource instances returned in the current range.",
            "type":"integer"
        },
        "totalResults":{
            "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.",
            "type":"integer"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/ContentHistory"
            },
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "offset":{
            "description":"Offset value used in the current page. ",
            "type":"integer"
        }
    },
    "type":"object"
}

Nested Schema : items

Type: array

Show Source

• Array of: object ContentHistory
  Title: ContentHistory

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

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

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

Nested Schema : ContentHistory

Type: object

Title: ContentHistory

Show Source

• action(optional): string
  It tells what action has been performed on each history
• comments(optional): string
  Comments of the ContentHistory object
• content(optional): object ContentKey
  Title: ContentKey
• dateAdded(optional): string(date-time)
  The date when the ContentHistory object was created or added
• dateModified(optional): string(date-time)
  The date when the ContentHistory object was last modified.
• links(optional): array links
• previousWorkflowStepId(optional): string
  PreviousWorkflowStepId of the ContentHistory object
• recordId(optional): string
  The unique record ID of the ContentHistory object.
• userInformationId(optional): string
  UserInformationId of the ContentHistory object
• userName(optional): string
  UserName of the ContentHistory object
• workflowName(optional): string
  WorkflowName of the ContentHistory object
• workflowStepId(optional): string
  WorkflowStepId of the ContentHistory object
• workflowStepName(optional): string
  WorkflowStepName of the ContentHistory object

{
    "title":"ContentHistory",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the ContentHistory object.",
            "type":"string"
        },
        "content":{
            "description":"contentKeyBO of the content",
            "$ref":"#/definitions/ContentKey"
        },
        "dateModified":{
            "description":"The date when the ContentHistory object was last modified.",
            "format":"date-time",
            "type":"string"
        },
        "previousWorkflowStepId":{
            "description":"PreviousWorkflowStepId of the ContentHistory object",
            "type":"string"
        },
        "workflowName":{
            "description":"WorkflowName of the ContentHistory object",
            "type":"string"
        },
        "workflowStepName":{
            "description":"WorkflowStepName of the ContentHistory object",
            "type":"string"
        },
        "action":{
            "description":"It tells what action has been performed on each history",
            "type":"string"
        },
        "dateAdded":{
            "description":"The date when the ContentHistory object was created or added",
            "format":"date-time",
            "type":"string"
        },
        "userName":{
            "description":"UserName of the ContentHistory object",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "workflowStepId":{
            "description":"WorkflowStepId of the ContentHistory object",
            "type":"string"
        },
        "comments":{
            "description":"Comments of the ContentHistory object",
            "type":"string"
        },
        "userInformationId":{
            "description":"UserInformationId of the ContentHistory object",
            "type":"string"
        }
    }
}

Nested Schema : ContentKey

Type: object

Title: ContentKey

Show Source

• allTranslations(optional): array allTranslations

  This field will return list of all translated content that the user can view

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

• answerId(optional): integer

  The unique identifier that enables mapping between an answer and the content.

• articleStatus(optional): object ArticleStatusKey
  Title: ArticleStatusKey
• dateModified(optional): string(date-time)

  The date when the content was last modified in the Oracle Knowledge Repository.

• displayEndDate(optional): string(date-time)

  The date when the service stops the display of the document to the end users.

• displayReviewDate(optional): string(date-time)

  The date when the document requires a review by an author capable of performing the review.

• displayStartDate(optional): string(date-time)

  The date when the document will be available to display to end-users.

• documentId(optional): string

  The unique identifier of a document that indicates the content type in which the content is saved.

• latestContent(optional): object ContentKey
  Title: ContentKey
• links(optional): array links
• locale(optional): object LocaleKey
  Title: LocaleKey
• publishedContent(optional): object ContentKey
  Title: ContentKey
• rating(optional): object DataForm
  Title: DataForm
• ratingsAggregate(optional): object AggregateFormResults
  Title: AggregateFormResults
• recordId(optional): string

  The unique identifier of the document. This ID is same in all versions in all locales of the document.

• schemaAttributes(optional): array schemaAttributes

  This field will return list of schema attributes associated with the content type of this content.

  This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.

• title(optional): string

  The tittle of the document.

• version(optional): string
  Version of the Content object
• versionId(optional): string

  The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.

{
    "title":"ContentKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the document. This ID is same in all versions in all locales of the document.</p>",
            "type":"string"
        },
        "dateModified":{
            "description":"<p>The date when the content was last modified in the Oracle Knowledge Repository.</p>",
            "format":"date-time",
            "type":"string"
        },
        "locale":{
            "description":"<p>The locale of the version of the document. The locale code represents the language and country associated with the Locale object. The following subfield can be used with locale query parameter: </p> <ul> <li>locale.recordId : The unique identifier of the Locale object. For example, to request an article in the Spanish-Spain locale, submit a call using the URI: <br /><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=locale.recordId eq 'es_ES'</code></li> </ul>",
            "$ref":"#/definitions/LocaleKey"
        },
        "allTranslations":{
            "items":{
                "$ref":"#/definitions/ContentKey"
            },
            "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>",
            "type":"array"
        },
        "schemaAttributes":{
            "items":{
                "$ref":"#/definitions/SchemaAttribute"
            },
            "description":"<p>This field will return list of schema attributes associated with the content type of this content. </p> <p>This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.</p>",
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "latestContent":{
            "description":"<p>Latest BO for this document.</p>",
            "$ref":"#/definitions/ContentKey"
        },
        "version":{
            "description":"Version of the Content object",
            "type":"string"
        },
        "displayReviewDate":{
            "description":"<p>The date when the document requires a review by an author capable of performing the review.</p>",
            "format":"date-time",
            "type":"string"
        },
        "title":{
            "description":"<p>The tittle of the document.</p>",
            "type":"string"
        },
        "ratingsAggregate":{
            "description":"<p>The aggregate form results. This includes the average rating, the total responses, and the specific rating values for this article.",
            "$ref":"#/definitions/AggregateFormResults"
        },
        "displayStartDate":{
            "description":"<p>The date when the document will be available to display to end-users.</p>",
            "format":"date-time",
            "type":"string"
        },
        "displayEndDate":{
            "description":"<p>The date when the service stops the display of the document to the end users.</p>",
            "format":"date-time",
            "type":"string"
        },
        "articleStatus":{
            "description":"<p>The article status.</p> <ul> <p>The service response matches any Content object (PUBLISHED by default) with article status specified in the request if you pass the<code> articleStatus.refKey</code> parameter.</p> <p>Example URIs for the articleStatus parameter are as follows:</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+eq+'DRAFT'</code></li> <p style='text-indent:100px;'>OR</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')</code></li>    <br/>    <p>The following example URIs returns Content objects whose contentState is LATEST:</p> <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'</code></li> </br>       <p>The following example URI returns Content objects with no article status assigned:</p>    <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'</code></li>    </br>       <p>The following example URI returns Content objects with no article status assigned and Content objects with the Draft article status assigned:</p>    <li><code>http://&lt;IM_REST_API_HOST&gt;/km/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')</code></li>    </br>       <p>If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.</p>    <br/>    <p>If there is no Content object that matches specified articleStatus query, response will include status of 200 OK with no records.</p>  </ul>",
            "$ref":"#/definitions/ArticleStatusKey"
        },
        "versionId":{
            "description":"<p>The unique identifier of the specific version of a document in a specific locale. You cannot use this field in queries made using q query parameter.</p>",
            "type":"string"
        },
        "answerId":{
            "description":"<p>The unique identifier that enables mapping between an answer and the content.</p>",
            "type":"integer"
        },
        "rating":{
            "description":"<p>Determined whether it is a 5 star or Y/N type of rating <ul> <li>CUSTOM(0)</li> <li>YES(1)</li> <li>YES_NO(2)</li> <li>THREE_STARS(3)</li> <li>FIVE_STARS(4)</li> </ul>.",
            "$ref":"#/definitions/DataForm"
        },
        "documentId":{
            "description":"<p>The unique identifier of a document that indicates the content type in which the content is saved.</p>",
            "type":"string"
        },
        "publishedContent":{
            "description":"<p>Published BO for this document.</p>",
            "$ref":"#/definitions/ContentKey"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

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

Nested Schema : allTranslations

Type: array

This field will return list of all translated content that the user can view

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

Show Source

• Array of: object ContentKey
  Title: ContentKey

{
    "items":{
        "$ref":"#/definitions/ContentKey"
    },
    "description":"<p>This field will return list of all translated content that the user can view </p> <p>This field will only be populated if allTranslations query parameter is passed in with value true.</p>",
    "type":"array"
}

Nested Schema : ArticleStatusKey

Type: object

Title: ArticleStatusKey

Show Source

• links(optional): array links
• name(optional): string

  The localized name of the ArticleStatus object. The name field can only be used for sorting.

• recordId(optional): string

  The unique identifier of the ArticleStatus object.

• referenceKey(optional): string

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

{
    "title":"ArticleStatusKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the ArticleStatus object.</p>",
            "type":"string"
        },
        "referenceKey":{
            "description":"<p>The reference key for the ArticleStatus object. <br/>ArticleStatus objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>",
            "type":"string"
        },
        "name":{
            "description":"<p>The localized name of the ArticleStatus object. The name field can only be used for sorting.</p>",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

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

Nested Schema : LocaleKey

Type: object

Title: LocaleKey

Show Source

• links(optional): array links
• recordId(optional): string

  The unique identifier of the Locale object.

{
    "title":"LocaleKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier of the Locale object.</p>",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

Nested Schema : DataForm

Type: object

Title: DataForm

Show Source

• dateAdded(optional): string(date-time)
  The date when the DataForm object was created or added
• dateModified(optional): string(date-time)
  The date when the DataForm object was last modified.
• displayEndDate(optional): string(date-time)
  DisplayEndDate of the DataForm object
• displayStartDate(optional): string(date-time)
  DisplayStartDate of the DataForm object
• emailContent(optional): boolean
  EmailContent of the DataForm object
• links(optional): array links
• name(optional): string
  The name of the data form. The name field can only be used for sorting.
• questions(optional): array questions
  To Many Relationship to Question
• ratingType(optional): integer
  Determined whether it is a 5 star or Y/N type of rating

  • CUSTOM(0)
  • YES(1)
  • YES_NO(2)
  • THREE_STARS(3)
  • FIVE_STARS(4)
• recordId(optional): string
  The unique record ID of the DataForm object.
• referenceKey(optional): string
  The reference key for the DataForm object. DataForm objects support multiple languages. This field can be used to identify the associated objects for all languages.
• user(optional): object UserKey
  Title: UserKey
• views(optional): array views
  To Many Relationship to View

{
    "title":"DataForm",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataForm object.",
            "type":"string"
        },
        "dateModified":{
            "description":"The date when the DataForm object was last modified.",
            "format":"date-time",
            "type":"string"
        },
        "displayStartDate":{
            "description":"DisplayStartDate of the DataForm object",
            "format":"date-time",
            "type":"string"
        },
        "referenceKey":{
            "description":"The reference key for the DataForm object. DataForm objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "emailContent":{
            "description":"EmailContent of the DataForm object",
            "type":"boolean"
        },
        "views":{
            "items":{
                "$ref":"#/definitions/ViewKey"
            },
            "description":"To Many Relationship to View",
            "type":"array"
        },
        "name":{
            "description":"The name of the data form.  The name field can only be used for sorting.",
            "type":"string"
        },
        "displayEndDate":{
            "description":"DisplayEndDate of the DataForm object",
            "format":"date-time",
            "type":"string"
        },
        "dateAdded":{
            "description":"The date when the DataForm object was created or added",
            "format":"date-time",
            "type":"string"
        },
        "ratingType":{
            "description":"Determined whether it is a 5 star or Y/N type of rating <ul> <li>CUSTOM(0)</li> <li>YES(1)</li> <li>YES_NO(2)</li> <li>THREE_STARS(3)</li> <li>FIVE_STARS(4)</li> </ul>",
            "type":"integer"
        },
        "questions":{
            "items":{
                "$ref":"#/definitions/DataFormQuestion"
            },
            "description":"To Many Relationship to Question",
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "user":{
            "description":"Relationship to User",
            "$ref":"#/definitions/UserKey"
        }
    }
}

Nested Schema : AggregateFormResults

Type: object

Title: AggregateFormResults

Show Source

• links(optional): array links
• questions(optional): array questions
  To Many Relationship to AggregateQuestionResult
• recordId(optional): string
  The unique record ID of the AggregateFormResults object.
• referenceKey(optional): string
  The reference key for the AggregateFormResults object. AggregateFormResults objects support multiple languages. This field can be used to identify the associated objects for all languages.
• totalResponses(optional): integer
  TotalResponses of the AggregateFormResults object

{
    "title":"AggregateFormResults",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the AggregateFormResults object.",
            "type":"string"
        },
        "totalResponses":{
            "description":"TotalResponses of the AggregateFormResults object",
            "type":"integer"
        },
        "referenceKey":{
            "description":"The reference key for the AggregateFormResults object. AggregateFormResults objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "questions":{
            "items":{
                "$ref":"#/definitions/AggregateQuestionResult"
            },
            "description":"To Many Relationship to AggregateQuestionResult",
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

Nested Schema : schemaAttributes

Type: array

This field will return list of schema attributes associated with the content type of this content.

This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.

Show Source

• Array of: object SchemaAttribute
  Title: SchemaAttribute

{
    "items":{
        "$ref":"#/definitions/SchemaAttribute"
    },
    "description":"<p>This field will return list of schema attributes associated with the content type of this content. </p> <p>This field will only be populated if additionalFields query parameter is passed in with value schemaAttributes.</p>",
    "type":"array"
}

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

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

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.

{
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "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"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "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"
        },
        "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"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "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"
    ],
    "type":"object"
}

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

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

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

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

Nested Schema : questions

Type: array

To Many Relationship to Question

Show Source

• Array of: object DataFormQuestion
  Title: DataFormQuestion

{
    "items":{
        "$ref":"#/definitions/DataFormQuestion"
    },
    "description":"To Many Relationship to Question",
    "type":"array"
}

Nested Schema : UserKey

Type: object

Title: UserKey

Show Source

• email(optional): string
  Email of the User object
• externalId(optional): integer
  The ExternalId is the Id of the corresponding User from an external system. It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.
• externalType(optional): string
  The ExternalType is the type of the corresponding User from an external system. It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system.
• links(optional): array links
• name(optional): string
  User's full name
• recordId(optional): string
  The unique record ID of the User object.

{
    "title":"UserKey",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the User object.",
            "type":"string"
        },
        "externalType":{
            "description":"The ExternalType is the type of the corresponding User from an external system.  It, along with ExternalId, can be used to bridge the gap between a User from this system and a User from an external system.",
            "type":"string"
        },
        "email":{
            "description":"Email of the User object",
            "type":"string"
        },
        "name":{
            "description":"User's full name",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "externalId":{
            "description":"The ExternalId is the Id of the corresponding User from an external system.  It, along with ExternalType, can be used to bridge the gap between a User from this system and a User from an external system.",
            "type":"integer"
        }
    }
}

Nested Schema : views

Type: array

To Many Relationship to View

Show Source

• Array of: object ViewKey
  Title: ViewKey

{
    "items":{
        "$ref":"#/definitions/ViewKey"
    },
    "description":"To Many Relationship to View",
    "type":"array"
}

Nested Schema : DataFormQuestion

Type: object

Title: DataFormQuestion

Show Source

• answers(optional): array answers
  To Many Relationship to Answer
• dataForm(optional): object DataFormKey
  Title: DataFormKey
• dateAdded(optional): string(date-time)
  The date when the DataFormQuestion object was created or added
• dateModified(optional): string(date-time)
  The date when the DataFormQuestion object was last modified.
• isMasterIdentifier(optional): boolean
  IsMasterIdentifier of the DataFormQuestion object
• links(optional): array links
• name(optional): string
  Name of the DataFormQuestion object
• recordId(optional): string
  The unique record ID of the DataFormQuestion object.
• referenceKey(optional): string
  The reference key for the DataFormQuestion object. DataFormQuestion objects support multiple languages. This field can be used to identify the associated objects for all languages.
• required(optional): boolean
  Required of the DataFormQuestion object
• sortOrder(optional): integer
  SortOrder of the DataFormQuestion object
• specialTypeIndicator(optional): integer
  SpecialTypeIndicator of the DataFormQuestion object

{
    "title":"DataFormQuestion",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataFormQuestion object.",
            "type":"string"
        },
        "dateModified":{
            "description":"The date when the DataFormQuestion object was last modified.",
            "format":"date-time",
            "type":"string"
        },
        "isMasterIdentifier":{
            "description":"IsMasterIdentifier of the DataFormQuestion object",
            "type":"boolean"
        },
        "specialTypeIndicator":{
            "description":"SpecialTypeIndicator of the DataFormQuestion object",
            "type":"integer"
        },
        "referenceKey":{
            "description":"The reference key for the DataFormQuestion object. DataFormQuestion objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "sortOrder":{
            "description":"SortOrder of the DataFormQuestion object",
            "type":"integer"
        },
        "name":{
            "description":"Name of the DataFormQuestion object",
            "type":"string"
        },
        "answers":{
            "items":{
                "$ref":"#/definitions/DataFormAnswer"
            },
            "description":"To Many Relationship to Answer",
            "type":"array"
        },
        "dataForm":{
            "description":"Relationship to Rating",
            "$ref":"#/definitions/DataFormKey"
        },
        "dateAdded":{
            "description":"The date when the DataFormQuestion object was created or added",
            "format":"date-time",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "required":{
            "description":"Required of the DataFormQuestion object",
            "type":"boolean"
        }
    }
}

Nested Schema : answers

Type: array

To Many Relationship to Answer

Show Source

• Array of: object DataFormAnswer
  Title: DataFormAnswer

{
    "items":{
        "$ref":"#/definitions/DataFormAnswer"
    },
    "description":"To Many Relationship to Answer",
    "type":"array"
}

Nested Schema : DataFormKey

Type: object

Title: DataFormKey

Show Source

• links(optional): array links
• recordId(optional): string
  The unique record ID of the DataForm object.
• referenceKey(optional): string
  The reference key for the DataForm object. DataForm objects support multiple languages. This field can be used to identify the associated objects for all languages.

{
    "title":"DataFormKey",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataForm object.",
            "type":"string"
        },
        "referenceKey":{
            "description":"The reference key for the DataForm object. DataForm objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

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

Nested Schema : DataFormAnswer

Type: object

Title: DataFormAnswer

Show Source

• dataFormQuestion(optional): object DataFormQuestionKey
  Title: DataFormQuestionKey
• dateAdded(optional): string(date-time)
  The date when the DataFormAnswer object was created or added
• dateModified(optional): string(date-time)
  The date when the DataFormAnswer object was last modified.
• defaultAnswer(optional): boolean
  DefaultAnswer of the DataFormAnswer object
• links(optional): array links
• name(optional): string
  Name of the DataFormAnswer object
• numberValue(optional): integer
  NumberValue of the DataFormAnswer object
• recordId(optional): string
  The unique record ID of the DataFormAnswer object.
• referenceKey(optional): string
  The reference key for the DataFormAnswer object. DataFormAnswer objects support multiple languages. This field can be used to identify the associated objects for all languages.
• sortOrder(optional): integer
  SortOrder of the DataFormAnswer object

{
    "title":"DataFormAnswer",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataFormAnswer object.",
            "type":"string"
        },
        "dateModified":{
            "description":"The date when the DataFormAnswer object was last modified.",
            "format":"date-time",
            "type":"string"
        },
        "referenceKey":{
            "description":"The reference key for the DataFormAnswer object. DataFormAnswer objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "sortOrder":{
            "description":"SortOrder of the DataFormAnswer object",
            "type":"integer"
        },
        "numberValue":{
            "description":"NumberValue of the DataFormAnswer object",
            "type":"integer"
        },
        "name":{
            "description":"Name of the DataFormAnswer object",
            "type":"string"
        },
        "dateAdded":{
            "description":"The date when the DataFormAnswer object was created or added",
            "format":"date-time",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "defaultAnswer":{
            "description":"DefaultAnswer of the DataFormAnswer object",
            "type":"boolean"
        },
        "dataFormQuestion":{
            "description":"Relationship to Question",
            "$ref":"#/definitions/DataFormQuestionKey"
        }
    }
}

Nested Schema : DataFormQuestionKey

Type: object

Title: DataFormQuestionKey

Show Source

• links(optional): array links
• recordId(optional): string
  The unique record ID of the DataFormQuestion object.
• referenceKey(optional): string
  The reference key for the DataFormQuestion object. DataFormQuestion objects support multiple languages. This field can be used to identify the associated objects for all languages.

{
    "title":"DataFormQuestionKey",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the DataFormQuestion object.",
            "type":"string"
        },
        "referenceKey":{
            "description":"The reference key for the DataFormQuestion object. DataFormQuestion objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

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

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

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

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

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

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

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

Nested Schema : ViewKey

Type: object

Title: ViewKey

Show Source

• links(optional): array links
• name(optional): string
  Localized name of the view
• recordId(optional): string
  GUID of the SITE table containing the view definition
• referenceKey(optional): string
  Non localized reference key for the view
• stripeCD(optional): string

  Stripe of a view

{
    "title":"ViewKey",
    "properties":{
        "recordId":{
            "description":"GUID of the SITE table containing the view definition",
            "type":"string"
        },
        "referenceKey":{
            "description":"Non localized reference key for the view",
            "type":"string"
        },
        "name":{
            "description":"Localized name of the view",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "stripeCD":{
            "description":"<p>Stripe of a view</p>",
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

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

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

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

Nested Schema : questions

Type: array

To Many Relationship to AggregateQuestionResult

Show Source

• Array of: object AggregateQuestionResult
  Title: AggregateQuestionResult

{
    "items":{
        "$ref":"#/definitions/AggregateQuestionResult"
    },
    "description":"To Many Relationship to AggregateQuestionResult",
    "type":"array"
}

Nested Schema : AggregateQuestionResult

Type: object

Title: AggregateQuestionResult

Show Source

• answers(optional): array answers
  To Many Relationship to AggregateAnswerResult
• averageResponse(optional): number
  AverageResponse of the AggregateQuestionResult object
• name(optional): string
  Localized display name for the Question
• recordId(optional): string
  The unique record ID of the AggregateQuestionResult object.
• referenceKey(optional): string
  The reference key for the AggregateQuestionResult object. AggregateQuestionResult objects support multiple languages. This field can be used to identify the associated objects for all languages.
• totalResponses(optional): integer
  TotalResponses of the AggregateQuestionResult object

{
    "title":"AggregateQuestionResult",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the AggregateQuestionResult object.",
            "type":"string"
        },
        "totalResponses":{
            "description":"TotalResponses of the AggregateQuestionResult object",
            "type":"integer"
        },
        "referenceKey":{
            "description":"The reference key for the AggregateQuestionResult object. AggregateQuestionResult objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "name":{
            "description":"Localized display name for the Question",
            "type":"string"
        },
        "answers":{
            "items":{
                "$ref":"#/definitions/AggregateAnswerResult"
            },
            "description":"To Many Relationship to AggregateAnswerResult",
            "type":"array"
        },
        "averageResponse":{
            "description":"AverageResponse of the AggregateQuestionResult object",
            "type":"number"
        }
    }
}

Nested Schema : answers

Type: array

To Many Relationship to AggregateAnswerResult

Show Source

• Array of: object AggregateAnswerResult
  Title: AggregateAnswerResult

{
    "items":{
        "$ref":"#/definitions/AggregateAnswerResult"
    },
    "description":"To Many Relationship to AggregateAnswerResult",
    "type":"array"
}

Nested Schema : AggregateAnswerResult

Type: object

Title: AggregateAnswerResult

Show Source

• name(optional): string
  Localized display name for the Answer
• recordId(optional): string
  The unique record ID of the AggregateAnswerResult object.
• referenceKey(optional): string
  The reference key for the AggregateAnswerResult object. AggregateAnswerResult objects support multiple languages. This field can be used to identify the associated objects for all languages.
• totalResponses(optional): integer
  TotalResponses of the AggregateAnswerResult object

{
    "title":"AggregateAnswerResult",
    "properties":{
        "recordId":{
            "description":"The unique record ID of the AggregateAnswerResult object.",
            "type":"string"
        },
        "totalResponses":{
            "description":"TotalResponses of the AggregateAnswerResult object",
            "type":"integer"
        },
        "referenceKey":{
            "description":"The reference key for the AggregateAnswerResult object. AggregateAnswerResult objects support multiple languages. This field can be used to identify the associated objects for all languages.",
            "type":"string"
        },
        "name":{
            "description":"Localized display name for the Answer",
            "type":"string"
        }
    }
}

Nested Schema : SchemaAttribute

Type: object

Title: SchemaAttribute

Show Source

• allowMultipleNodes(optional): boolean
  Flag indicating if multiple nodes are allowed of this type @since 8.3
• allowPreselectedUserGroupChange(optional): boolean
  Enable editors to modify preselected user group restrictions @since 8.3
• children(optional): array children
  List of child nodes of the current element
• counter(optional): integer
  This attribute contains the current value of the ContentType DOC ID counter. This value should not be changed after content is added to the ContentType
• counterPrefix(optional): string
  This attribute contains the prefix that is appended to the front of the DOC ID counter
• dateAdded(optional): string(date-time)
  This attribute represents the timestamp when the SchemaAttribute definition was first created
• dateModified(optional): string(date-time)
  This attribute represents the timestamp when the SchemaAttribute definition was last modified
• description(optional): string
  Localized help text for the attribute. This text is displayed in the authoring view
• enableAttributeLevelSearch(optional): boolean
  Flag indicating whether this field should be configured for attribute level searching - i.e. where TITLE='xyz'. This field was previously called searchable @since 8.3
• enableFullTextSearch(optional): boolean
  Flag indicating whether this field should be included in the full text index. This field was previously called indexable @since 8.3
• includeInMasterIdentifier(optional): boolean
  Flag indicating whether this field should be appended to the master identifier of the document
• isNode(optional): boolean
  Flag indicating if this element is a node @since 8.3
• isRequired(optional): boolean
  Make attribute a required field @since 8.3
• links(optional): array links
• localizedAttributes(optional): array localizedAttributes
  List of LocalizedAttributes of this SchemaAttribute name and description in various Locales
• name(optional): string
  Localized name of the attribute. This need NOT be unique within the Schema.
• readOnly(optional): boolean
  Flag indicating whether this field is editable
• recordId(optional): string
  Unique identifier for the SchemaAttribute object
• referenceKey(optional): string
  Non localized name of the attribute. SchemaAttribute's referenceKey need NOT be unique within its Schema. But its xpath will be unique within its Schema.
• requireWorkflowApproval(optional): boolean
  Attribute requires workflow approval if workflow is enabled
• schemaAttributeUserGroupList(optional): array schemaAttributeUserGroupList
  List of user groups that can be used to secure this attribute. This should be a subset of the list of user groups assigned to the ContentType
• schemaAttrType(optional):
  Allowed Values: [ "TEXT_AREA", "WYSIWYG_EDIT", "TEXT_FIELD", "FILE", "BOOLEAN", "LIST", "COUNTER", "DATE", "DATETIME", "TIME", "INTEGER", "FLOAT" ]

  Enumerated type representing the type of attribute - i.e. text field, rich text area
• securedFileResource(optional): boolean
  Flag indicating if this attribute (file types only) should be marked as secure - i.e. stored in the ~secure folder near the content XML file
• secureWithUserGroups(optional): boolean
  Restrict attribute to selected user groups
• securityRegex(optional): string
  The regular expression used to validate the field against security attacks.
• sortOrder(optional): integer
  Display order of the schema attributes within the edit form
• textHeight(optional): string
  Specifies the text height for text areas and rich text fields
• textWidth(optional): string
  Specifies the max length for text fields
• userGroupSelectionRequired(optional): boolean
  User groups are required for attribute
• wysiwygType(optional):
  Allowed Values: [ "BASIC", "MEDIUM", "FULL" ]

  Type of WYSIWYG rich text field - i.e. FULL, BASIC, MEDIUM @since 8.3
• xpath(optional): string
  The XPATH of this attribute within the schema. This is unique within the Schema.

{
    "title":"SchemaAttribute",
    "properties":{
        "recordId":{
            "description":"Unique identifier for the SchemaAttribute object",
            "type":"string"
        },
        "textHeight":{
            "description":"Specifies the text height for text areas and rich text fields",
            "type":"string"
        },
        "dateModified":{
            "description":"This attribute represents the timestamp when the SchemaAttribute definition was last modified",
            "format":"date-time",
            "type":"string"
        },
        "wysiwygType":{
            "description":"Type of WYSIWYG rich text field - i.e. FULL, BASIC, MEDIUM          @since 8.3",
            "enum":[
                "BASIC",
                "MEDIUM",
                "FULL"
            ]
        },
        "includeInMasterIdentifier":{
            "description":"Flag indicating whether this field should be appended to the master identifier of the document",
            "type":"boolean"
        },
        "allowMultipleNodes":{
            "description":"Flag indicating if multiple nodes are allowed of this type          @since 8.3",
            "type":"boolean"
        },
        "dateAdded":{
            "description":"This attribute represents the timestamp when the SchemaAttribute definition was first created",
            "format":"date-time",
            "type":"string"
        },
        "children":{
            "items":{
                "$ref":"#/definitions/SchemaAttribute"
            },
            "description":"List of child nodes of the current element",
            "type":"array"
        },
        "securedFileResource":{
            "description":"Flag indicating if this attribute (file types only) should be marked as secure - i.e. stored in the ~secure folder near the content XML file",
            "type":"boolean"
        },
        "xpath":{
            "description":"The XPATH of this attribute within the schema. This is unique within the Schema.",
            "type":"string"
        },
        "description":{
            "description":"Localized help text for the attribute. This text is displayed in the authoring view",
            "type":"string"
        },
        "name":{
            "description":"Localized name of the attribute. This need NOT be unique within the Schema.",
            "type":"string"
        },
        "secureWithUserGroups":{
            "description":"Restrict attribute to selected user groups",
            "type":"boolean"
        },
        "userGroupSelectionRequired":{
            "description":"User groups are required for attribute",
            "type":"boolean"
        },
        "securityRegex":{
            "description":"The regular expression used to validate the field against security attacks.",
            "type":"string"
        },
        "sortOrder":{
            "description":"Display order of the schema attributes within the edit form",
            "type":"integer"
        },
        "counter":{
            "description":"This attribute contains the current value of the ContentType DOC ID counter. This value should not be changed after content is added to the ContentType",
            "type":"integer"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "counterPrefix":{
            "description":"This attribute contains the prefix that is appended to the front of the DOC ID counter",
            "type":"string"
        },
        "textWidth":{
            "description":"Specifies the max length for text fields",
            "type":"string"
        },
        "allowPreselectedUserGroupChange":{
            "description":"Enable editors to modify preselected user group restrictions          @since 8.3",
            "type":"boolean"
        },
        "localizedAttributes":{
            "items":{
                "$ref":"#/definitions/LocalizedAttributes"
            },
            "description":"List of LocalizedAttributes of this SchemaAttribute name and description in various Locales",
            "type":"array"
        },
        "isNode":{
            "description":"Flag indicating if this element is a node          @since 8.3",
            "type":"boolean"
        },
        "readOnly":{
            "description":"Flag indicating whether this field is editable",
            "type":"boolean"
        },
        "enableFullTextSearch":{
            "description":"Flag indicating whether this field should be included in the full text index. This field was previously           called indexable          @since 8.3",
            "type":"boolean"
        },
        "isRequired":{
            "description":"Make attribute a required field          @since 8.3",
            "type":"boolean"
        },
        "referenceKey":{
            "description":"Non localized name of the attribute. SchemaAttribute's referenceKey need NOT be unique within its Schema.  But its xpath will be unique within its Schema.",
            "type":"string"
        },
        "schemaAttributeUserGroupList":{
            "items":{
                "$ref":"#/definitions/SchemaAttributeUserGroup"
            },
            "description":"List of user groups that can be used to secure this attribute. This should be a subset of the list of user groups assigned to the ContentType",
            "type":"array"
        },
        "requireWorkflowApproval":{
            "description":"Attribute requires workflow approval if workflow is enabled",
            "type":"boolean"
        },
        "schemaAttrType":{
            "description":"Enumerated type representing the type of attribute - i.e. text field, rich text area",
            "enum":[
                "TEXT_AREA",
                "WYSIWYG_EDIT",
                "TEXT_FIELD",
                "FILE",
                "BOOLEAN",
                "LIST",
                "COUNTER",
                "DATE",
                "DATETIME",
                "TIME",
                "INTEGER",
                "FLOAT"
            ]
        },
        "enableAttributeLevelSearch":{
            "description":"Flag indicating whether this field should be configured for attribute level searching - i.e. where TITLE='xyz'. This field          was previously called searchable          @since 8.3",
            "type":"boolean"
        }
    }
}

Nested Schema : children

Type: array

List of child nodes of the current element

Show Source

• Array of: object SchemaAttribute
  Title: SchemaAttribute

{
    "items":{
        "$ref":"#/definitions/SchemaAttribute"
    },
    "description":"List of child nodes of the current element",
    "type":"array"
}

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

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

Nested Schema : localizedAttributes

Type: array

List of LocalizedAttributes of this SchemaAttribute name and description in various Locales

Show Source

• Array of: object LocalizedAttributes
  Title: LocalizedAttributes

{
    "items":{
        "$ref":"#/definitions/LocalizedAttributes"
    },
    "description":"List of LocalizedAttributes of this SchemaAttribute name and description in various Locales",
    "type":"array"
}

Nested Schema : schemaAttributeUserGroupList

Type: array

List of user groups that can be used to secure this attribute. This should be a subset of the list of user groups assigned to the ContentType

Show Source

• Array of: object SchemaAttributeUserGroup
  Title: SchemaAttributeUserGroup

{
    "items":{
        "$ref":"#/definitions/SchemaAttributeUserGroup"
    },
    "description":"List of user groups that can be used to secure this attribute. This should be a subset of the list of user groups assigned to the ContentType",
    "type":"array"
}

Nested Schema : LocalizedAttributes

Type: object

Title: LocalizedAttributes

Show Source

• description(optional): string
  Localized description in the above Locale
• localeId(optional): string
  RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.
• name(optional): string
  Localized Name in the above Locale

{
    "title":"LocalizedAttributes",
    "properties":{
        "localeId":{
            "description":"RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.",
            "type":"string"
        },
        "description":{
            "description":"Localized description in the above Locale",
            "type":"string"
        },
        "name":{
            "description":"Localized Name in the above Locale",
            "type":"string"
        }
    }
}

Nested Schema : SchemaAttributeUserGroup

Type: object

Title: SchemaAttributeUserGroup

Show Source

• defaultValue(optional): boolean
  Flag indiacting whether the user group should be selected by default
• recordId(optional): string
  GUID from the XMLSCHEMAATTRIBUTEUSERGROUP table
• userGroup(optional): object UserGroupKey
  Title: UserGroupKey

{
    "title":"SchemaAttributeUserGroup",
    "properties":{
        "recordId":{
            "description":"GUID from the XMLSCHEMAATTRIBUTEUSERGROUP table",
            "type":"string"
        },
        "userGroup":{
            "description":"Reference to the user group associated with this schema attribute",
            "$ref":"#/definitions/UserGroupKey"
        },
        "defaultValue":{
            "description":"Flag indiacting whether the user group should be selected by default",
            "type":"boolean"
        }
    }
}

Nested Schema : UserGroupKey

Type: object

Title: UserGroupKey

Show Source

• externalId(optional): integer

  The unique identifier of the corresponding userGroup from an external system. You can use the External ID with the ExternalType parameter to connect user groups in the internal and the the external systems.

• externalType(optional): string

  The ExternalType is the type of the corresponding userGroup from an external system.

• links(optional): array links
• name(optional): string

  The localized name of the user group. The name field can only be used for sorting.

• recordId(optional): string

  The unique identifier from the TAG table that represent a userGroups resource

• referenceKey(optional): string

  The non localized name of the user group

• stripeCD(optional): string

  Stripe for UserGroup

{
    "title":"UserGroupKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier from the TAG table that represent a userGroups resource</p>",
            "type":"string"
        },
        "externalType":{
            "description":"<p>The ExternalType is the type of the corresponding userGroup from an external system.</p>",
            "type":"string"
        },
        "referenceKey":{
            "description":"<p>The non localized name of the user group</p>",
            "type":"string"
        },
        "name":{
            "description":"<p>The localized name of the user group.  The name field can only be used for sorting.</p>",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "stripeCD":{
            "description":"<p>Stripe for UserGroup</p>",
            "type":"string"
        },
        "externalId":{
            "description":"<p>The unique identifier of the corresponding userGroup from an external system. You can use the External ID with the ExternalType parameter to connect user groups in the internal and the the external systems.</p>",
            "type":"integer"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object instanceLink
  Metadata describing link description objects that MAY appear in the JSON instance representation.

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

Back to Top

Examples

The following example shows how to get a list of ContentHistory objects associated with all the versions of the latest version of the document specified by document Id:

curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/content/docId/{docId}/history" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json"

Example of Response Body

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

{
  ""items"": [
    {
      ""content"": {
        ""recordId"": ""27BA7D089309424D86657C14C4B637A6"",
        ""versionId"": ""30EB204D1ED04E57A912F0289816D68B"",
        ""documentId"": ""FAQ1"",
        ""title"": ""Q query  Testing --update2"",
        ""version"": ""3.0"",
        ""answerId"": 1000018,
        ""locale"": {
          ""recordId"": ""en_US""
        },
        ""dateModified"": ""2018-11-13T15:21:22+0530"",
        ""links"": [
          {
            ""rel"": ""canonical"",
            ""href"": ""https://<IM_REST_API_HOST>/km/api/latest/content/27BA7D089309424D86657C14C4B637A6"",
            ""mediaType"": ""application/json, application/xml"",
            ""method"": ""GET""
          }
        ]
      },
      ""action"": ""Edited"",
      ""dateAdded"": ""2018-11-13T15:21:22+0530"",
      ""dateModified"": ""2018-11-13T15:21:22+0530"",
      ""userInformationId"": 2,
      ""userName"": ""Default Administrator"",
      ""recordId"": ""5676AEA24A1F49BFA6893384B38EB4D5"",
      ""links"": [
        {
          ""rel"": ""canonical"",
          ""href"": ""https://<IM_REST_API_HOST>/km/api/latest/content/27BA7D089309424D86657C14C4B637A6/history/5676AEA24A1F49BFA6893384B38EB4D5"",
          ""mediaType"": ""application/json, application/xml"",
          ""method"": ""GET""
        }
      ]
    },
    {
      ""content"": {
        ""recordId"": ""27BA7D089309424D86657C14C4B637A6"",
        ""versionId"": ""3B5049724B604F21A4F2235E142BA46F"",
        ""documentId"": ""FAQ1"",
        ""title"": ""Q query  Testing --update"",
        ""version"": ""2.0"",
        ""answerId"": 1000018,
        ""locale"": {
          ""recordId"": ""en_US""
        },
        ""dateModified"": ""2018-11-13T15:21:22+0530"",
        ""links"": [
          {
            ""rel"": ""canonical"",
            ""href"": ""https://<IM_REST_API_HOST>/km/api/latest/content/27BA7D089309424D86657C14C4B637A6"",
            ""mediaType"": ""application/json, application/xml"",
            ""method"": ""GET""
          }
        ]
      },
      ""action"": ""Published"",
      ""dateAdded"": ""2018-11-13T15:13:13+0530"",
      ""dateModified"": ""2018-11-13T15:13:13+0530"",
      ""userInformationId"": 2,
      ""userName"": ""Default Administrator"",
      ""recordId"": ""E33ABEFE25B24A7BAA01EC23AE4A1F45"",
      ""links"": [
        {
          ""rel"": ""canonical"",
          ""href"": ""https://<IM_REST_API_HOST>/km/api/latest/content/27BA7D089309424D86657C14C4B637A6/history/E33ABEFE25B24A7BAA01EC23AE4A1F45"",
          ""mediaType"": ""application/json, application/xml"",
          ""method"": ""GET""
        }
      ]
    },
}
  ],
  ""hasMore"": false,
  ""limit"": 20,
  ""offset"": 0,
  ""links"": [
    {
      ""rel"": ""canonical"",
      ""href"": ""https://<IM_REST_API_HOST>/km/api/latest/content/docId/FAQ1/history?limit=20&offset=0&_=1543215215508"",
      ""mediaType"": ""application/json, application/xml"",
      ""method"": ""GET""
    }
  ],
  ""count"": 2
}	

Back to Top