Jump to

• Request
• Response

List All Archived fields of a Type

get

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

List all archived fields 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 : TypeSubResourceListArchivedFields

Type: object

ArchivedFields

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/TypeField"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ArchivedFields"
}

Nested Schema : data

Type: array

Show Source

• Array of: object TypeField
  FieldInAggrType.

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Link of the resource.

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

Nested Schema : TypeField

Type: object

FieldInAggrType.

Show Source

• apiName(optional): string
  API Name of the field.
• archivedBy(optional): string
  Archived by.
• archivedDate(optional): object date
  date
• datatype(optional): string
  Allowed Values: [ "number", "long", "decimal", "text", "largetext", "reference", "datetime", "boolean" ]

  Data Type Enum. It is a required property in the get response and post/put request.
• defaultValue(optional): object defaultValue
  defaultValue for field.
• description(optional): string
  Description of the field.
• id(optional): string
  id of the field. It is a required property in the get response and put request whereas it is not required in the post request.
• isSystemField(optional): boolean
  Is the field provided by the system.
• name(optional): string
  name of the field. It is a required property in the get response and post/put request.
• properties(optional): object properties
  Additional Properties Allowed: additionalProperties

  Field specific properties. The field publishingDependency is specific for media and reference.
• required(optional): boolean
  Required or optional value for the Field. It is a required property in the get response and post/put request.
• settings(optional): object settings
  Additional Properties Allowed: additionalProperties

  Field specific settings.
• valuecount(optional): string
  Allowed Values: [ "single", "list" ]

  Value count as a single or list. It is a required property in the get response and post/put request.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the field. It is a required property in the get response and put request whereas it is not required in the post request."
        },
        "name":{
            "type":"string",
            "description":"name of the field. It is a required property in the get response and post/put request."
        },
        "apiName":{
            "type":"string",
            "description":"API Name of the field."
        },
        "description":{
            "type":"string",
            "description":"Description of the field."
        },
        "datatype":{
            "type":"string",
            "description":"Data Type Enum. It is a required property in the get response and post/put request.",
            "enum":[
                "number",
                "long",
                "decimal",
                "text",
                "largetext",
                "reference",
                "datetime",
                "boolean"
            ]
        },
        "required":{
            "type":"boolean",
            "description":"Required or optional value for the Field. It is a required property in the get response and post/put request."
        },
        "valuecount":{
            "type":"string",
            "description":"Value count as a single or list. It is a required property in the get response and post/put request.",
            "enum":[
                "single",
                "list"
            ]
        },
        "defaultValue":{
            "type":"object",
            "description":"defaultValue for field."
        },
        "isSystemField":{
            "type":"boolean",
            "description":"Is the field provided by the system."
        },
        "properties":{
            "type":"object",
            "example":"{caas-translation: {inheritFromMaster: false}, publishingDependency: optional}",
            "description":"Field specific properties. The field publishingDependency is specific for media and reference.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "settings":{
            "type":"object",
            "description":"Field specific settings.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "archivedBy":{
            "type":"string",
            "description":"Archived by."
        },
        "archivedDate":{
            "description":"date and time Field archivedAt",
            "$ref":"#/definitions/date"
        }
    },
    "description":"FieldInAggrType."
}

Nested Schema : date

Type: object

date

Show Source

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

Nested Schema : defaultValue

Type: object

defaultValue for field.

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "example":"{caas-translation: {inheritFromMaster: false}, publishingDependency: optional}",
    "description":"Field specific properties. The field publishingDependency is specific for media and reference.",
    "additionalProperties":{
        "type":"object"
    }
}

Field specific properties. The field publishingDependency is specific for media and reference.

Example:

{caas-translation: {inheritFromMaster: false}, publishingDependency: optional}

Nested Schema : settings

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "description":"Field specific settings.",
    "additionalProperties":{
        "type":"object"
    }
}

Field specific settings.

Nested Schema : additionalProperties

Type: object

Nested Schema : additionalProperties

Type: object

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