Production
The first thing you do when you have registered your user, is to create or manage a Production. The production can be considered as the workspace you will operate in.
In the context of a production, you can:
-
Organize your clips into collections and categories;
-
Manage the team that can access this material, with the ability to give each member a role, determining what they can do in the production;
-
Configure the metadata fields (Custom Fields / Form Fields);
-
Configure the workflows that should operate on your material;
-
And much more.
Property Reference
Some of the more important properties are
-
idis the production id -
nameis the title of the workspace -
hasAvatarindicates if a workspace image is configred. If so, it can be requested at/api/production/{productionId}/avatar, which returns the image directly.
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
activeSecurityClasses |
✘ |
Set of string |
Enum: |
|
activeStatus |
✘ |
String |
Enum: Active, Archived, |
|
created |
✘ |
Date |
The time when this resource was created |
date-time |
createdBy |
✘ |
String |
The request or process that created this resource |
|
creatorId |
✘ |
Long |
The id of the user who created this resource |
int64 |
deleted |
✘ |
Date |
When the production was deleted |
date-time |
deliveryDate |
✘ |
Date |
date-time |
|
deliveryRequestFormFieldsDefinition |
✘ |
FormFieldsDefinition |
||
deliveryRequests |
✘ |
List of DeliveryRequest |
||
description |
✘ |
String |
The description of the production |
|
editorialObjects |
✘ |
List of EditorialObject |
||
hasAvatar |
✘ |
Boolean |
||
id |
✔ |
Long |
The id of this resource |
int64 |
invitationState |
✘ |
String |
The current state of the invitation that ties the current user to this production |
Enum: PENDING, ACCEPTED, PENDING_AWAITING_2FA, ACCEPTED_AWAITING_2FA, EXPIRED, |
lastActivity |
✘ |
Date |
The time in which the last activity was registered for this production |
date-time |
lastTouched |
✘ |
Date |
The time in which the last modify activity was registered for this production |
date-time |
lastUpdated |
✘ |
Date |
The time when this resource was last updated |
date-time |
modifiedBy |
✔ |
String |
The request or process responsible for the last update of this resource |
|
name |
✔ |
String |
The name of the production |
|
objectType |
✘ |
String |
The data model type or class name of this resource |
|
productionFormFieldValues |
✘ |
Object |
||
productionFormFieldsDefinition |
✘ |
FormFieldsDefinition |
||
serviceIntegrations |
✘ |
List of ServiceIntegration |
The service integrations that are declared in this production |
|
settings |
✘ |
ProductionSetting |
||
subscription |
✘ |
Subscription |
||
subscriptionId |
✘ |
Long |
The id of the subscription where this production belongs to |
int64 |
subscriptionStatus |
✘ |
String |
The status of the subscription where this production belongs to |
Enum: trialing, trial_ended, assessing, active, soft_failure, past_due, suspended, canceled, unpaid, expired, delayed_cancel, unlinked, |
subtitle |
✘ |
String |
A secondary title for the production |
|
systemSettings |
✘ |
SystemSetting |
||
tentative |
✘ |
Boolean |
If the current user has not yet accepted the invitation to this production, this will be set to false |
|
usages |
✘ |
List of BillingUsage |
The billing usages of this production |
|
version |
✔ |
Long |
The version of this resource, used for Optimistic Locking |
int64 |