Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

BatchGetAttributesMetadata

Gets the attribute metadata.

Request Syntax


GET /v2/domains/domainIdentifier/entities/entityType/entityIdentifier/attributes-metadata?attributeIdentifier=attributeIdentifiers&entityRevision=entityRevision HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

attributeIdentifiers

The attribute identifier.

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

domainIdentifier

The domain ID where you want to get the attribute metadata.

Pattern: dzd[-_][a-zA-Z0-9_-]{1,36}

Required: Yes

entityIdentifier

The entity ID for which you want to get attribute metadata.

Pattern: [a-zA-Z0-9_-]{1,36}

Required: Yes

entityRevision

The entity revision for which you want to get attribute metadata.

Length Constraints: Minimum length of 1. Maximum length of 64.

entityType

The entity type for which you want to get attribute metadata.

Valid Values: ASSET | LISTING

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "attributes": [ 
      { 
         "attributeIdentifier": "string",
         "forms": [ 
            { 
               "content": "string",
               "formName": "string",
               "typeName": "string",
               "typeRevision": "string"
            }
         ]
      }
   ],
   "errors": [ 
      { 
         "attributeIdentifier": "string",
         "code": "string",
         "message": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

attributes

The results of the BatchGetAttributesMetadata action.

Type: Array of BatchGetAttributeOutput objects

errors

The errors generated when the BatchGetAttributesMetadata action is invoked.

Type: Array of AttributeError objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400