Skip to content

submissions_metadata_objects_metadata_list

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

List the information related to all the submission metadata items.

metadata_objects_pk
required
string format: uuid

Submission metadata object ID

submission_pk
required
string format: uuid

Submission ID

X-Workspace
required
string format: uuid

Workspace ID

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.

Media typeapplication/json
object
count
required
integer
next
string format: uri
nullable
previous
string format: uri
nullable
results
required
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"
}