AssembleEffectiveTagSet

get

/20160918/tagDefaults/actions/assembleEffectiveTagSet

Assembles tag defaults in the specified compartment and any parent compartments to determine the tags to apply. Tag defaults from parent compartments do not override tag defaults referencing the same tag in a compartment lower down the hierarchy. This set of tag defaults includes all tag defaults from the current compartment back to the root compartment.

Request

Supported Media Types
Query Parameters
Back to Top

Response

Supported Media Types

200 Response

The list of tag defaults.
Headers
  • 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.
  • 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
Nested Schema : TagDefaultSummary
Type: object
Summary information for the specified tag default.
Show Source
  • The OCID of the compartment. The tag default will apply to all new resources that are created in the compartment.
  • The OCID of the tag default.
  • 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.
  • Allowed Values: [ "ACTIVE" ]
    The tag default's current state. After creating a TagDefault, make sure its lifecycleState is ACTIVE before using it.
  • locks
    Locks associated with this resource.
  • The OCID of the tag definition. The tag default will always assign a default value for this tag definition.
  • The name used in the tag definition. This field is informational in the context of the tag default.
  • The OCID of the tag namespace that contains the tag definition.
  • Date and time the TagDefault object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
  • The default value for the tag definition. This will be applied to all new resources created in the compartment.
Nested Schema : locks
Type: array
Locks associated with this resource.
Show Source
  • 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.
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
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
  • 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

401 Response

Unauthorized
Headers
  • 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

404 Response

Not Found
Headers
  • 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

429 Response

Too Many Requests
Headers
  • 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

500 Response

Internal Server Error
Headers
  • 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

Default Response

An error has occurred.
Headers
  • 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
Back to Top