Skip to content

submissions_metadata_objects_list

GET
/api/submissions/{submission_pk}/metadata_objects
curl --request GET \
--url 'https://example.com/api/submissions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/metadata_objects?include_metadata=false' \
--header 'Authorization: Bearer <token>' \
--header 'X-Workspace: 2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'

List the information related to all the submission metadata objects.

submission_pk
required
string format: uuid
X-Workspace
required
string format: uuid

Workspace ID

include_metadata
boolean

When true, each metadata object in the page includes a metadata_items array with the same item shape as GET /api/submissions/{id}/metadata_objects/{moid}/metadata (full unpaginated field list per metadata object). The existing metadata {count, related} field is unchanged.

ordering
string

Which field to use when ordering the results.

p
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

search
string

A search term.

type
string

Type of the metadata object

Media typeapplication/json
object
count
required
integer
next
string format: uri
nullable
previous
string format: uri
nullable
results
required
Array<object>

OpenAPI response for metadata object list items.

Documents the optional metadata_items array returned when include_metadata=true.

object
id
required
string format: uuid
submission
required
string format: uuid
summary_fields
required

Return summary information for an object.

Parameters

obj : SubmissionMetadataObject The object for which metadata is being retrieved. Expected to have submission, id, and metadata attributes.

Returns

dict A dictionary containing the summary fields and their values.

object
key
additional properties
type
required
string
metadata
required

Return the number of metadata of an object, and where to list them.

Parameters

obj : SubmissionMetadataObject The object for which metadata is being retrieved. Expected to have submission and id attributes.

Returns

dict The count of metadata and the link to their list.

object
key
additional properties
completeness
required
nullable
cross_validation
required
nullable
is_valid
required

Determine whether the metadata object is valid based on completeness and cross-validation fields.

Parameters

obj : SubmissionMetadataObject The object for which the validity is being determined.

Returns

bool True if valid, False otherwise.

boolean
associations
required

Retrieve information about the associations linked to a given metadata object.

Parameters

obj : SubmissionMetadataObject The metadata object for which to retrieve association information. Expected to have an associations GenericRelation to SubmissionAssociationObject.

Returns

dict A dictionary containing:

  • “count” (int): the number of SubmissionAssociations this metadata object participates in.
  • “related” (str): the URL to retrieve the detailed list of associated SubmissionAssociations.
object
key
additional properties
external_identifiers
required

Retrieve external identifiers linked to this metadata object.

Parameters

obj : SubmissionMetadataObject The metadata object.

Returns

list[dict] Serialized external identifiers.

Array<object>
object
key
additional properties
metadata_items

Present only when include_metadata=true. Same item shape as GET /api/submissions/{id}/metadata_objects/{moid}/metadata (full unpaginated field list per metadata object).

Array<object>

Serializer for the submission metadata.

object
id
required
string format: uuid
submission
required
string format: uuid
submission_metadata_object
required
string format: uuid
field
required

Get the field information for the submission metadata.

Parameters

obj : SubmissionMetadata The submission metadata object.

Returns

dict The field information.

object
key
additional properties
value
required
object
value
nullable
source
required

Get source information from the source_metadata if it exists.

Parameters

obj : SubmissionMetadataValue SubmissionMetadataValue instance

Returns

dict or None Source information including object type, id, and name if available None if no source_metadata exists

object
key
additional properties
candidate_values
required
Array<object>

Serializer for the SubmissionMetadataValue model.

object
value
nullable
source
required

Get source information from the source_metadata if it exists.

Parameters

obj : SubmissionMetadataValue SubmissionMetadataValue instance

Returns

dict or None Source information including object type, id, and name if available None if no source_metadata exists

object
key
additional properties
is_valid
required
boolean
validation_errors
required
nullable
created_by
required

Return the interactor information of the object’s creator.

Parameters

obj : SubmissionMetadata The object containing the creator information.

Returns

dict The interactor information of the creator.

object
key
additional properties
created_time
required
string format: date-time
last_edited_by
required

Return information about the last interactor who edited the object.

Parameters

obj : SubmissionMetadata The object containing the last editor information.

Returns

dict The interactor information of the last editor.

object
key
additional properties
last_edited_time
required
string format: date-time

Example

{
"count": 123,
"next": "http://api.example.org/accounts/?p=4",
"previous": "http://api.example.org/accounts/?p=2"
}
Media typeapplication/json
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
message
string

Example

{
"code": "uri_validation_error",
"message": "Invalid URI parameters. Check the `details` property for more details.",
"details": [
{
"parameter": "<parameter_name>",
"code": "invalid",
"message": "\"<parameter_value>\" is not a valid UUID."
}
]
}
Media typeapplication/json
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
message
string

Example

{
"code": "forbidden",
"message": "You do not have permission to perform this operation. Check the `details` property for more details.",
"details": [
{
"parameter": "submission",
"code": "not_allowed",
"message": "You are not a member of this submission."
}
]
}
Media typeapplication/json
object
code
required
string
>= 1 characters
message
required
string
>= 1 characters
details
required
Array<object>
object
parameter
string
nullable
code
string
nullable
message
string

Example

{
"code": "object_not_found",
"message": "Object not found. Check the `details` property for more details.",
"details": [
{
"parameter": "<id>",
"code": "does_not_exist",
"message": "\"<id>\" does not exist."
}
]
}