This API was removed in Registry v4.0.0.

Add

Add a new AttributeEnumeration.

Request Format

Method

POST

URL

/attribute_enumerations.<format>

Request Body

AttributeEnumeration Request

Response Format

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of AttributeEnumeration

AttributeEnumeration added

400 Bad Request


AttributeEnumeration Request not provided in POST body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

401 Unauthorized


Authentication required

403 CO Does Not Exist
The specified CO does not exist

500 Other Error


Unknown error


Delete

Remove an AttributeEnumeration.

Request Format

Method

DELETE

URL

/attribute_enumerations/<id>.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 Deleted


AttributeEnumeration deleted

400 Invalid Fields


id not provided

401 Unauthorized


Authentication required

404 AttributeEnumeration Unknown


id not found

500 Other Error


Unknown error


Edit

Edit an existing AttributeEnumeration.

Request Format

Method

PUT

URL

/attribute_enumerations/<id>.<format>

Request Body

AttributeEnumeration Request 

Response Format

HTTP Status

Response Body

Description

200 OK


AttributeEnumeration updated

400 Bad Request


AttributeEnumeration Request not provided in POST body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

401 Unauthorized


Authentication required

403 CO Does Not Exist
The specified CO does not exist

404 AttributeEnumeration Unknown


id not found

500 Other Error


Unknown error


View (all)

Retrieve all existing AttributeEnumerations.

Request Format

Method

GET

URL

/attribute_enumerations.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

AttributeEnumeration Response 

AttributeEnumerations returned

401 Unauthorized


Authentication required

500 Other Error


Unknown error


View (per CO, per attribute)

Retrieve AttributeEnumeration attached to a CO and/or attribute.

Request Format

Method

GET

URL

/attribute_enumerations.<format>?coid=<id>[&attribute=<attribute>]

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

AttributeEnumeration Response

AttributeEnumerations returned

401 Unauthorized


Authentication required

404 CO Unknown


id not found

404 Attribute Unknown
attribute not found

500 Other Error


Unknown error


View (one)

Retrieve an existing AttributeEnumeration.

Request Format

Method

GET

URL

/attribute_enumerations/<id>.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

AttributeEnumeration Response

AttributeEnumeration returned

401 Unauthorized


Authentication required

404 AttributeEnumeration Unknown


id not found

500 Other Error


Unknown error


Notes

  • Response format requested is ignored where response is only via HTTP status, but must still be provided.

See Also

  • No labels