/metadata

Description

The metadata endpoint can be used to view, create, update, and delete the metadata for a project.

get
List All Metadata

https://api.next.tech/v1/projects/:uid/metadata
List all metadata for a project.
Request
Response
Request
Path Parameters
uid
required
string
The UUID of the project to retrieve metadata from. Example: 69aceb37-dda0-4905-8217-afbdd9003dc3
Response
200: OK
The response includes all metadata for the project.
[
{
"key": "user_id",
"value": "10"
},
{
"key": "course_id",
"value": "101"
}
]

get
Retrieve a Metadata

https://api.next.tech/v1/projects/:uid/metadata/:key
Retrieve the project metadata for the specified metadata key.
Request
Response
Request
Path Parameters
uid
required
string
The UUID of the project to retrieve the metadata from. Example: 69aceb37-dda0-4905-8217-afbdd9003dc3
key
required
string
The metadata's key.
Response
200: OK
A single metadata object.
{
"created_at": 1595896418,
"updated_at": 1595896418,
"id": 82,
"key": "user_id",
"value": "10"
}

post
Create a Metadata

https://api.next.tech/v1/projects/:uid/metadata
Create a new metadata key/value pair for a project.
Request
Response
Request
Path Parameters
uid
required
string
The UUID of the project to create metadata for. Example: 69aceb37-dda0-4905-8217-afbdd9003dc3
Body Parameters
metadata[key]
required
string
The key for the new metadata.
metadata[value]
required
string
The value for the new metadata.
Response
200: OK
The response includes all metadata for the project.
[
{
"created_at": 1595896418,
"updated_at": 1595896418,
"id": 82,
"key": "user_id",
"value": "10"
},
{
"created_at": 1595896418,
"updated_at": 1595896418,
"id": 83,
"key": "course_id",
"value": "101"
}
]

put
Overwrite All Metadata

https://api.next.tech/v1/projects/:uid/metadata
Overwrites the project's current metadata with the specified metadata. One or more key/value pairs can be provided. All of the existing metadata key/value pairs for the project will be deleted if the new metadata is created successfully.
Request
Response
Request
Path Parameters
uid
required
string
The UUID of the project to create the metadata for. Example: 69aceb37-dda0-4905-8217-afbdd9003dc3
Body Parameters
metadata[][key]
required
string
The key for the new metadata.
metadata[][value]
required
string
The value for the new metadata.
Response
200: OK
The response contains all of the project's metadata, which will be the same as all of the metadata provided in this PUT request.
[
{
"created_at": 1595896418,
"updated_at": 1595896418,
"id": 82,
"key": "user_id",
"value": "10"
},
{
"created_at": 1595896418,
"updated_at": 1595896418,
"id": 83,
"key": "course_id",
"value": "101"
}
]

put
Update a Metadata

https://api.next.tech/v1/projects/:uid/metadata/:key
Update the value for the project's metadata with the specified key.
Request
Response
Request
Path Parameters
uid
required
string
The UUID of the project to update the metadata for. Example: 69aceb37-dda0-4905-8217-afbdd9003dc3
key
required
string
The key of the metadata to update.
Body Parameters
metadata[][value]
required
string
The new value for the metadata with the specified key.
Response
200: OK
The response contains all the project's metadata.
[
{
"created_at": 1595896418,
"updated_at": 1595896418,
"id": 82,
"key": "user_id",
"value": "10"
},
{
"created_at": 1595896418,
"updated_at": 1595896418,
"id": 83,
"key": "course_id",
"value": "101"
}
]

delete
Delete All Metadata

https://api.next.tech/v1/projects/:uid/metadata
Delete all the metadata for a project.
Request
Response
Request
Path Parameters
uid
required
string
The UUID of the project to delete the metadata for. Example: 69aceb37-dda0-4905-8217-afbdd9003dc3
Response
204: No Content
An empty response is returned.
{}

delete
Delete a Metadata

https://api.next.tech/v1/projects/:uid/metadata/:key
Delete the project metadata key/value pair with the specified key.
Request
Response
Request
Path Parameters
uid
required
string
The UUID of the project to delete the metadata for. Example: 69aceb37-dda0-4905-8217-afbdd9003dc3
key
required
string
The key of the metadata key/value pair to delete.
Response
204: No Content
An empty response is returned.
{}