You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Add

Add a new CoExtendedAttribute.

Request Format

Method

POST

URL

/co_extended_attributes.<format>

Request Body

CoExtendedAttribute Request

Response Format

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of CoExtendedAttribute

CoExtendedAttribute added

400 Bad Request

 

CoExtendedAttribute 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

403 Name In Use

 

An extended attribute already exists with the specified name in the specified CO

500 Database Error

 

The underlying RDBMS was unable to perform a supporting operation.

500 Other Error

 

Unknown error

Delete

Remove a CoExtendedAttribute.

Request Format

Method

DELETE

URL

/co_extended_attributes/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 Deleted

 

CoExtendedAttribute deleted

400 Invalid Fields

 

id not provided

401 Unauthorized

 

Authentication required

404 Identifier Unknown

 

id not found

500 Database Error

 

The underlying RDBMS was unable to perform a supporting operation.

500 Other Error

 

Unknown error

Edit

Edit an existing CoExtendedAttribute.

Request Format

Method

POST

URL

/co_extended_attributes/<id>.<format>

Request Body

CoExtendedAttribute Request

Response Format

HTTP Status

Response Body

Description

200 OK

 

CoExtendedAttribute updated

400 Bad Request

 

CoExtendedAttribute 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

403 Name In Use

 

An extended attribute already exists with the specified name in the specified CO

404 Identifier Unknown

 

id not found

500 Database Error

 

The underlying RDBMS was unable to perform a supporting operation.

500 Other Error

 

Unknown error

View (all)

Retrieve all existing CoExtendedAttributes.

Request Format

Method

GET

URL

/co_extended_attributes.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoExtendedAttribute Response

CoExtendedAttribute returned

401 Unauthorized

 

Authentication required

500 Other Error

 

Unknown error

View (per CO)

Retrieve CoExtendedAttributes attached to a CO.

Request Format

Method

GET

URL

/co_extended_attributes.<format>?coid=<id>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoExtendedAttribute Response

CoExtendedAttribute returned

401 Unauthorized

 

Authentication required

404 CO Unknown

 

id not found

500 Other Error

 

Unknown error

View (one)

Retrieve an existing CoExtendedAttribute.

Request Format

Method

GET

URL

/co_extended_attributes/<id>.<format>

Request Body

 

Response Format

HTTP Status

Response Body

Description

200 OK

CoExtendedAttribute Response

CoExtendedAttribute returned

401 Unauthorized

 

Authentication required

404 CoExtendedAttribute 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.
  • (warning) This API manages the definition of Extended Attributes. The values for instantiated Extended Attributes are managed via the CoPersonRole API.

See Also

  • No labels