API docs by Redocly

LockitNetwork API (1.2.0)

Download OpenAPI specification:

E-mail: [email protected] License: Apache 2.0

project

Project Info

Fetch all projects of the authorized user

Authorizations:
token_querytoken_headeroauth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fetch project by ID

Authorizations:
token_querytoken_headeroauth2
path Parameters
projectId
required
string

ID of project to return

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "name": "string",
  • "isSeries": true,
  • "isPremium": true,
  • "productionCompany": "string",
  • "created": 0
}

scene

Scene Info

Fetch all episodes of a project

Authorizations:
token_querytoken_headeroauth2
path Parameters
projectId
required
string

ID of project

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fetch episode by ID

Authorizations:
token_querytoken_headeroauth2
path Parameters
projectId
required
string

ID of project

episodeId
required
string

ID of episode

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "episodeNumber": 0,
  • "episodeName": "string",
  • "scheduledRunningTime": 0,
  • "created": 0
}

Fetch all scenes of an episode

Authorizations:
token_querytoken_headeroauth2
path Parameters
projectId
required
string

ID of project

episodeId
required
string

ID of episode

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fetch scene by ID

Authorizations:
token_querytoken_headeroauth2
path Parameters
projectId
required
string

ID of project

episodeId
required
string

ID of episode

sceneId
required
string

ID of scene

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "episode": "string",
  • "number": 0,
  • "additional": "string",
  • "content": "string",
  • "comment": "string",
  • "dayNight": "string",
  • "inOut": "string",
  • "sets": [
    ],
  • "motherScene": "string",
  • "scheduledDay": "string",
  • "cancelledDay": "string",
  • "additionalDay": "string",
  • "state": "string",
  • "editorsRT": 0
}

Modify a scene

Authorizations:
token_querytoken_headeroauth2
path Parameters
projectId
required
string

ID of project

episodeId
required
string

ID of episode

sceneId
required
string

ID of scene

Request Body schema: application/json
required

The scene modifier to apply

object (ValueModifier)

Describes how an existing value should be modified. Currently there are only 2 options:

  • unchanged (leaves the value unchanged): {"type": "unchanged"}
  • replace (unconditionally replace the value with a new one): {"type": "replace", "value": "newValue (any type)"}
object (ValueModifier)

Describes how an existing value should be modified. Currently there are only 2 options:

  • unchanged (leaves the value unchanged): {"type": "unchanged"}
  • replace (unconditionally replace the value with a new one): {"type": "replace", "value": "newValue (any type)"}

Responses

Request samples

Content type
application/json
{
  • "editorsRT": {
    },
  • "comment": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "episode": "string",
  • "number": 0,
  • "additional": "string",
  • "content": "string",
  • "comment": "string",
  • "dayNight": "string",
  • "inOut": "string",
  • "sets": [
    ],
  • "motherScene": "string",
  • "scheduledDay": "string",
  • "cancelledDay": "string",
  • "additionalDay": "string",
  • "state": "string",
  • "editorsRT": 0
}

Fetch all scenes of a project (over all episodes)

Authorizations:
token_querytoken_headeroauth2
path Parameters
projectId
required
string

ID of project

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fetch scene by ID

Authorizations:
token_querytoken_headeroauth2
path Parameters
projectId
required
string

ID of project

sceneId
required
string

ID of scene

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "episode": "string",
  • "number": 0,
  • "additional": "string",
  • "content": "string",
  • "comment": "string",
  • "dayNight": "string",
  • "inOut": "string",
  • "sets": [
    ],
  • "motherScene": "string",
  • "scheduledDay": "string",
  • "cancelledDay": "string",
  • "additionalDay": "string",
  • "state": "string",
  • "editorsRT": 0
}

Modify a scene

Authorizations:
token_querytoken_headeroauth2
path Parameters
projectId
required
string

ID of project

sceneId
required
string

ID of scene

Request Body schema: application/json
required

The scene modifier to apply

object (ValueModifier)

Describes how an existing value should be modified. Currently there are only 2 options:

  • unchanged (leaves the value unchanged): {"type": "unchanged"}
  • replace (unconditionally replace the value with a new one): {"type": "replace", "value": "newValue (any type)"}
object (ValueModifier)

Describes how an existing value should be modified. Currently there are only 2 options:

  • unchanged (leaves the value unchanged): {"type": "unchanged"}
  • replace (unconditionally replace the value with a new one): {"type": "replace", "value": "newValue (any type)"}

Responses

Request samples

Content type
application/json
{
  • "editorsRT": {
    },
  • "comment": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "episode": "string",
  • "number": 0,
  • "additional": "string",
  • "content": "string",
  • "comment": "string",
  • "dayNight": "string",
  • "inOut": "string",
  • "sets": [
    ],
  • "motherScene": "string",
  • "scheduledDay": "string",
  • "cancelledDay": "string",
  • "additionalDay": "string",
  • "state": "string",
  • "editorsRT": 0
}

day

Shooting Day Info

Fetch all shooting days of a project

Authorizations:
token_querytoken_headeroauth2
path Parameters
projectId
required
string

ID of project

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fetch a shooting day

Authorizations:
token_querytoken_headeroauth2
path Parameters
projectId
required
string

ID of project

dayId
required
string

ID of shooting day

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "day": 0,
  • "prefix": "string",
  • "suffix": "string",
  • "date": {
    }
}

Match clips of a shooting day

Authorizations:
token_querytoken_headeroauth2
path Parameters
projectId
required
string

ID of project

dayId
required
string

ID of shooting day

query Parameters
onlyMatches
boolean

Flag, whether to only respond with matched clips. If false (default), unmatched clips are retured. All values containing the substring "true" are considered true.

Request Body schema: application/json
required

The clip file names to match against

Array
string

Responses

Request samples

Content type
application/json
Example
[
  • "A001_C001_1234.R3D",
  • "A001_C002_1234.R3D",
  • "A002_C001_1234.R3D"
]

Response samples

Content type
application/json
{
  • "matched": {
    },
  • "unmatched": [
    ]
}

Fetch the progress report of a shooting day

Returns the progress report ("Tagesbericht") of a single shooting day as structured data: scene and slate progress, cast presence, work times, material consumption, shooting ratios and the per-episode shooting state.

All values are unformatted. Running times and durations are second counts; times of day are seconds since midnight of the shooting day's local date and may exceed 24 hours for overnight shoots. Page counts are eighths of a page. Dates are LocalDate objects.

Requires a premium project and the progress-report access right.

Authorizations:
token_querytoken_headeroauth2
path Parameters
projectId
required
string

ID of project

dayId
required
string

ID of shooting day

Responses

Response samples

Content type
application/json
{
  • "project": {
    },
  • "day": {
    },
  • "crew": [
    ],
  • "locations": [
    ],
  • "locationsSummary": "string",
  • "setsSummary": "string",
  • "comment": "string",
  • "dayComments": [
    ],
  • "cast": [
    ],
  • "slates": {
    },
  • "scenes": {
    },
  • "breaks": [
    ],
  • "material": {
    },
  • "departments": {
    },
  • "statistics": {
    },
  • "progress": {
    },
  • "logbook": [
    ]
}

clipMatch

Clip Match (Metadata Merge)

Match clips of a shooting day

Authorizations:
token_querytoken_headeroauth2
path Parameters
projectId
required
string

ID of project

dayId
required
string

ID of shooting day

query Parameters
onlyMatches
boolean

Flag, whether to only respond with matched clips. If false (default), unmatched clips are retured. All values containing the substring "true" are considered true.

Request Body schema: application/json
required

The clip file names to match against

Array
string

Responses

Request samples

Content type
application/json
Example
[
  • "A001_C001_1234.R3D",
  • "A001_C002_1234.R3D",
  • "A002_C001_1234.R3D"
]

Response samples

Content type
application/json
{
  • "matched": {
    },
  • "unmatched": [
    ]
}

progressReport

Progress Report (Tagesbericht)

Fetch the progress report of a shooting day

Returns the progress report ("Tagesbericht") of a single shooting day as structured data: scene and slate progress, cast presence, work times, material consumption, shooting ratios and the per-episode shooting state.

All values are unformatted. Running times and durations are second counts; times of day are seconds since midnight of the shooting day's local date and may exceed 24 hours for overnight shoots. Page counts are eighths of a page. Dates are LocalDate objects.

Requires a premium project and the progress-report access right.

Authorizations:
token_querytoken_headeroauth2
path Parameters
projectId
required
string

ID of project

dayId
required
string

ID of shooting day

Responses

Response samples

Content type
application/json
{
  • "project": {
    },
  • "day": {
    },
  • "crew": [
    ],
  • "locations": [
    ],
  • "locationsSummary": "string",
  • "setsSummary": "string",
  • "comment": "string",
  • "dayComments": [
    ],
  • "cast": [
    ],
  • "slates": {
    },
  • "scenes": {
    },
  • "breaks": [
    ],
  • "material": {
    },
  • "departments": {
    },
  • "statistics": {
    },
  • "progress": {
    },
  • "logbook": [
    ]
}

annotation

Annotations: JSON values that API clients store on a project's entities under a scope and a key, readable by every caller with access to the project

List a project's annotations in bulk

Lists the project's annotations, oldest write first, a page at a time. Poll with updatedSince to pick up changes.

Authorizations:
token_querytoken_headeroauth2
path Parameters
projectId
required
string

ID of project

query Parameters
type
string (AnnotatedEntityType)
Enum: "project" "episode" "scene" "slate" "shot" "take" "cameraTake" "clip" "day"

Only annotations of entities of this type

key
string

Only annotations with this key

scope
string

Scope to read, as for a single annotation; * reads every scope. Defaults to the OAuth client's ID for OAuth callers and to user for API-token callers.

updatedSince
string <date-time>
Example: updatedSince=2026-10-13T08:00:00Z

Only annotations written at or after this ISO-8601 time

limit
integer [ 1 .. 1000 ]
Default: 500

The largest number of annotations on the page

after
string

The next cursor of the previous page

Responses

Response samples

Content type
application/json
{
  • "annotations": [
    ],
  • "next": "string"
}

Read an entity's annotations

Lists the entity's annotations in the request's scope, or in every scope for scope=*, ordered by scope, then key.

Authorizations:
token_querytoken_headeroauth2
path Parameters
projectId
required
string

ID of project

type
required
string (AnnotatedEntityType)
Enum: "project" "episode" "scene" "slate" "shot" "take" "cameraTake" "clip" "day"

Type of the annotated entity

entityId
required
string

ID of the annotated entity; for project, the project's own ID

query Parameters
scope
string

Scope to read, as for a single annotation; * reads every scope. Defaults to the OAuth client's ID for OAuth callers and to user for API-token callers.

Responses

Response samples

Content type
application/json
{
  • "annotations": [
    ]
}

Read one annotation

Answers the annotation's JSON value as the body.

Authorizations:
token_querytoken_headeroauth2
path Parameters
projectId
required
string

ID of project

type
required
string (AnnotatedEntityType)
Enum: "project" "episode" "scene" "slate" "shot" "take" "cameraTake" "clip" "day"

Type of the annotated entity

entityId
required
string

ID of the annotated entity; for project, the project's own ID

key
required
string^[A-Za-z0-9._:-]{1,255}$

Key of the annotation: 1 to 255 characters of A-Z, a-z, 0-9, ., _, - and :, compared case-sensitively

query Parameters
scope
string

Scope of the annotation: 1 to 127 characters without control characters, compared case-sensitively. Defaults to the OAuth client's ID for OAuth callers and to user for API-token callers. * is reserved.

Responses

Response samples

Content type
application/json
{
  • "look": {
    }
}

Write an annotation

Stores the body, any JSON value, as the annotation, replacing what the slot held. Writers own nothing: every caller holding the annotations access right may overwrite or delete any annotation, and the latest write wins. Every caller with access to the project can read every annotation, so annotations must not hold secrets.

Authorizations:
token_querytoken_headeroauth2
path Parameters
projectId
required
string

ID of project

type
required
string (AnnotatedEntityType)
Enum: "project" "episode" "scene" "slate" "shot" "take" "cameraTake" "clip" "day"

Type of the annotated entity

entityId
required
string

ID of the annotated entity; for project, the project's own ID

key
required
string^[A-Za-z0-9._:-]{1,255}$

Key of the annotation: 1 to 255 characters of A-Z, a-z, 0-9, ., _, - and :, compared case-sensitively

query Parameters
scope
string

Scope of the annotation: 1 to 127 characters without control characters, compared case-sensitively. Defaults to the OAuth client's ID for OAuth callers and to user for API-token callers. * is reserved.

Request Body schema: application/json
required

The value: any JSON text, including a string, number, boolean or null. Its compacted form may hold at most 65,536 bytes in UTF-8. Numbers are kept as written.

any

Responses

Request samples

Content type
application/json
Example
{
  • "look": {
    },
  • "gain": 1.5
}

Response samples

Content type
application/json
{
  • "scope": "string",
  • "key": "string",
  • "value": null,
  • "updated": "2026-10-13T08:00:00.000Z"
}

Delete an annotation

Authorizations:
token_querytoken_headeroauth2
path Parameters
projectId
required
string

ID of project

type
required
string (AnnotatedEntityType)
Enum: "project" "episode" "scene" "slate" "shot" "take" "cameraTake" "clip" "day"

Type of the annotated entity

entityId
required
string

ID of the annotated entity; for project, the project's own ID

key
required
string^[A-Za-z0-9._:-]{1,255}$

Key of the annotation: 1 to 255 characters of A-Z, a-z, 0-9, ., _, - and :, compared case-sensitively

query Parameters
scope
string

Scope of the annotation: 1 to 127 characters without control characters, compared case-sensitively. Defaults to the OAuth client's ID for OAuth callers and to user for API-token callers. * is reserved.

Responses

Response samples

Content type
application/json
{
  • "problems": [
    ]
}

user

Fetch user info

Authorizations:
token_querytoken_headeroauth2

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "email": "string",
  • "login": "string"
}