Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

REST: Entity IDs to URIs endpoint #242

Merged
merged 2 commits into from
Jun 14, 2024
Merged

Conversation

martastain
Copy link
Member

@martastain martastain commented Jun 14, 2024

Implements [POST] /api/projects/{projectName}/uris endpoint, which returns a list of AYON URIs for a given list of Entity IDs.
Entity IDs must be of the same entity type and belong to the same project.

Any assignee to the project can resolve URIs.

Specs

Request payload is a JSON with the following fields:

entityType

Enum: folder product version representation task workfile

ids

Array of strings (Entity IDs) - entity ID may, but does not need to be hyphenated

Example

So a request like:

{
    "entityType": "representation",
    "ids": ["40680ada-fcbc-11ee-9ea5-0242ac140004"]
}

Returns:

{
    "uris": [
        {
            "id": "40680adafcbc11ee9ea50242ac140004",
            "uri": "ayon+entity://demo_Commercial/shots/sh010&product=workfileCompositing&version=v001&representation=ma"
        }
    ]
}

@martastain martastain linked an issue Jun 14, 2024 that may be closed by this pull request
@martastain martastain added the type: feature Adding something new and exciting to the product label Jun 14, 2024
@martastain martastain changed the title REST: add URIs endpoint REST: Entity IDs to URIs endpoint Jun 14, 2024
@martastain martastain requested a review from antirotor June 14, 2024 14:57
@martastain martastain marked this pull request as ready for review June 14, 2024 14:57
Copy link
Member

@antirotor antirotor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

works like a charm

@martastain martastain merged commit 5519527 into develop Jun 14, 2024
@martastain martastain deleted the 215-endpoint-entity-id-to-uri branch June 24, 2024 06:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature Adding something new and exciting to the product
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Endpoint: Entity ID to URI
2 participants