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
Response
Supported Media Types
- application/json
200 Response
OK.
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: additionalPropertiesField 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: additionalPropertiesField 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.
Nested Schema : defaultValue
Type:
object
defaultValue for field.
Nested Schema : properties
Type:
object
Additional Properties Allowed
Show Source
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
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.
304 Response
Not modified.
400 Response
Bad request.
403 Response
Forbidden.
500 Response
Internal server error.