Jump to

• Request
• Response

ListTagDefaults

get

/20160918/tagDefaults

Lists the tag defaults for tag definitions in the specified compartment.

Request

Supported Media Types

• application/json

Query Parameters

• compartmentId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment.
• id: string
  Minimum Length: 1

  Maximum Length: 255

  A filter to only return resources that match the specified OCID exactly.
• lifecycleState: string
  A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.

  Default Value: 100
• page: string
  Minimum Length: 1

  Maximum Length: 512

  For list pagination. The value of the opc-next-page response header from the previous List call.

  Default Value: oracle.doceng.json.BetterJsonNull@2c07545f
• tagDefinitionId: string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the tag definition.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The list of tag default values.

Headers

• opc-next-page: string
  For list pagination. When this header appears in the response, additional pages of results remain. Use this value as the page parameter to get the next page of items.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object TagDefaultSummary
  Summary information for the specified tag default.

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

Nested Schema : TagDefaultSummary

Type: object

Summary information for the specified tag default.

Show Source

• compartmentId(required): string
  The OCID of the compartment. The tag default will apply to all new resources that are created in the compartment.
• id(required): string
  The OCID of the tag default.
• isRequired(required): boolean
  If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked. If the isRequired flag is set to true, the value is set during resource creation. If the isRequired flag is set to false, the value you enter is set during resource creation.
• lifecycleState: string
  Allowed Values: [ "ACTIVE" ]

  The tag default's current state. After creating a TagDefault, make sure its lifecycleState is ACTIVE before using it.
• locks: array locks
  Locks associated with this resource.
• tagDefinitionId(required): string
  The OCID of the tag definition. The tag default will always assign a default value for this tag definition.
• tagDefinitionName(required): string
  The name used in the tag definition. This field is informational in the context of the tag default.
• tagNamespaceId(required): string
  The OCID of the tag namespace that contains the tag definition.
• timeCreated(required): string(date-time)
  Date and time the TagDefault object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
• value(required): string
  The default value for the tag definition. This will be applied to all new resources created in the compartment.

{
    "description":"Summary information for the specified tag default.",
    "required":[
        "id",
        "compartmentId",
        "tagNamespaceId",
        "tagDefinitionId",
        "tagDefinitionName",
        "value",
        "timeCreated",
        "isRequired"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The OCID of the tag default."
        },
        "compartmentId":{
            "type":"string",
            "description":"The OCID of the compartment. The tag default will apply to all new resources that are created in the compartment."
        },
        "tagNamespaceId":{
            "type":"string",
            "description":"The OCID of the tag namespace that contains the tag definition."
        },
        "tagDefinitionId":{
            "type":"string",
            "description":"The OCID of the tag definition. The tag default will always assign a default value for this tag definition."
        },
        "tagDefinitionName":{
            "type":"string",
            "description":"The name used in the tag definition. This field is informational in the context of the tag default."
        },
        "value":{
            "type":"string",
            "description":"The default value for the tag definition. This will be applied to all new resources created in the compartment."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Date and time the TagDefault object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z "
        },
        "lifecycleState":{
            "type":"string",
            "enum":[
                "ACTIVE"
            ],
            "description":"The tag default's current state. After creating a TagDefault, make sure its lifecycleState is ACTIVE before using it."
        },
        "isRequired":{
            "type":"boolean",
            "description":"If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt). If no value is set, resource creation is blocked. If the isRequired flag is set to true, the value is set during resource creation. If the isRequired flag is set to false, the value you enter is set during resource creation."
        },
        "locks":{
            "description":"Locks associated with this resource.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResourceLock"
            }
        }
    },
    "x-example":"{   \"id\": \"ocid1.tagdefault.<var>unique_ID</var>\",   \"compartmentId\": \"ocid1.compartment.<var>unique_ID</var>\",   \"tagNamespaceId\": \"ocid1.namespace.<var>unique_ID</var>\",   \"tagDefinitionId\": \"ocid1.tagdefinition.<var>unique_ID</var>\",   \"tagDefinitionName\": \"Finance\",   \"value\": \"W123\",   \"timeCreated\": \"2018-11-22T19:00:00.000Z\",   \"lifecycleState\": \"ACTIVE\",   \"isRequired\": \"false\" } ",
    "type":"object"
}

Nested Schema : locks

Type: array

Locks associated with this resource.

Show Source

• Array of: object ResourceLock
  Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource.

{
    "description":"Locks associated with this resource.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ResourceLock"
    }
}

Nested Schema : ResourceLock

Type: object

Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource.

Show Source

• compartmentId: string
  The compartment OCID of the lock.
• isActive: boolean
  Indicates if the lock is active or not. For example, if there are mutliple FULL locks, the first-created FULL lock will be effective.
• message: string
  A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
• relatedResourceId: string
  The OCID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
• timeCreated: string(date-time)
  When the lock was created.
• type(required): string
  Allowed Values: [ "FULL", "DELETE" ]

  Type of the lock.

{
    "description":"Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource. A delete lock prevents deleting the resource.",
    "type":"object",
    "x-obmcs-splat":{
        "resourceKind":"lock"
    },
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "description":"Type of the lock.",
            "type":"string",
            "enum":[
                "FULL",
                "DELETE"
            ]
        },
        "compartmentId":{
            "description":"The compartment OCID of the lock.",
            "type":"string"
        },
        "relatedResourceId":{
            "description":"The OCID of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.",
            "type":"string"
        },
        "message":{
            "description":"A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.",
            "type":"string"
        },
        "timeCreated":{
            "description":"When the lock was created.",
            "type":"string",
            "format":"date-time"
        },
        "isActive":{
            "type":"boolean",
            "description":"Indicates if the lock is active or not. For example, if there are mutliple FULL locks, the first-created FULL lock will be effective."
        }
    }
}

Example Response (application-json)

[   {     "id": "ocid1.tagdefault.aaaaaaaasexampleuniqueID",     "compartmentId": "ocid1.compartment.aaaaaaaaexampleuniqueID",     "tagNamespaceId": "ocid1.namespace.aaaaaaaaexampleuniqueID",     "tagDefinitionId": "ocid1.tagdefinition.aaaaaaaaexampleuniqueID",     "tagDefinitionName": "Finance",     "value": "W123",     "timeCreated": "2018-11-22T19:00:00.000Z",     "lifecycleState": "ACTIVE",     "isRequired": "true"   },   {     "id": "ocid1.tagdefault.aaaaaaaasexampleuniqueID",     "compartmentId": "ocid1.compartment.aaaaaaaaexampleuniqueID",     "tagNamespaceId": "ocid1.namespace.aaaaaaaaexampleuniqueID",     "tagDefinitionId": "ocid1.tagdefinition.aaaaaaaasexampleuniqueID",     "tagDefinitionName": "Operations",     "value": "Dept42",     "timeCreated": "2018-11-22T20:00:00.000Z",     "lifecycleState": "ACTIVE",     "isRequired": "false"   } ] 

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Default Response

An error has occurred.

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing..

  Example: UnknownError
• message(required): string
  A human-readable error string.

  Example: error validating payload

{
    "type":"object",
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "example":"UnknownError",
            "description":"A short error code that defines the error, meant for programmatic parsing.."
        },
        "message":{
            "type":"string",
            "example":"error validating payload",
            "description":"A human-readable error string."
        }
    }
}

Back to Top