ModelRequirements Controller

The ModelRequirements controller manages rules that govern the readiness state of mediacontainers within AdmiralCloud. These requirements act as quality gates that must be satisfied before a mediacontainer becomes eligible for publication.

The controller enables creating and managing validation rules for mediacontainers. These rules can enforce various requirements, such as:

Mandatory metadata fields that must be populated
Minimum content length requirements for specific metadata fields
Required number of tags
Specific metadata attributes that must be present

When a mediacontainer is evaluated against its model requirements, it can only be released for publication when all defined rules are satisfied. This ensures that all published content meets predetermined quality standards.

Reference

Find modelRequirement

Find all model requirements.

GET/v5/modelRequirement

Request Parameters

Field	Type	Required	Description
event	string	✗	Returns all model requirement definitions for the given event
type	string	✗	Returns all model requirement definitions for the given mediacontainer type ≡ allowed values: videoimageaudiodocumentdropsiteprivatecollectiongroupcollectionpressareacollaborationmediahubdownloadlinkpinboardcollectionadditionalMediaavatarimportedSubtitlelogowatermarkaudioWatermarkcontactPicturewelcomeBackgroundfaceimportedTags

Response

Field	Type	Description
definitions	array	Definitions for this model requirement
└ identifier	string	TBA
└ model	string	TBA
└ modelQuery	object	TBA
└ required	boolean	TBA
└ conditions	array	TBA
└ placeholderText	array	TBA
└ infoText	array	TBA
event	string	Event of the model requirement
flag	integer	If flag = 0 the modelRequirement is active, flag 1 means it is deactivated/deleted ≡ allowed values: 01
id	integer	Id of the model requirement
lastEditorId	integer	Id of the user who did the last changes on this model requirement
securityGroupId	integer	Limit model requirements check to the given securityGroupId
settings	object	Settings for this model requirement – currently not used
└ colors	object	Colors
└ required	hexColor	TBA
└ recommended	hexColor	TBA
└ fulfilled	hexColor	TBA
title	string	Title for this model requirement definitions
type	string	Optional type of the model requirement ≡ allowed values: videoimageaudiodocumentdropsiteprivatecollectiongroupcollectionpressareacollaborationmediahubdownloadlinkpinboardcollectionadditionalMediaavatarimportedSubtitlelogowatermarkaudioWatermarkcontactPicturewelcomeBackgroundfaceimportedTags

Create modelRequirement

Create a new model requirement. You can create requirements for all types of mediacontainers or limit the requirement to a given type or securitygroup. If you don’t set securitygroups or types the requirement will be active for all types of mediacontainers.

POST/v5/modelRequirement

Request Parameters

Field	Type	Required	Description
definitions	array	✓	Definitions for this model requirement
└ identifier	string	✓	TBA
└ model	string	✓	TBA
└ modelQuery	object	✓	TBA
└ required	boolean	✓	TBA
└ conditions	array	✓	TBA
└ placeholderText	array	✓	TBA
└ infoText	array	✓	TBA
event	string	✓	Which event to trigger if model requirements are fulfilled.
securityGroupId	integer	✗	Limit model requirements check to the given securityGroupId
settings	object	✗	Settings for this model requirement – currently not used
└ colors	object	✗	Colors
└ required	hexColor	✓	TBA
└ recommended	hexColor	✓	TBA
└ fulfilled	hexColor	✓	TBA
title	string	✓	Title for this model requirement definitions
type	string	✗	Limit model requirements for that mediacontainer type. ≡ allowed values: videoimageaudiodocumentdropsiteprivatecollectiongroupcollectionpressareacollaborationmediahubdownloadlinkpinboardcollectionadditionalMediaavatarimportedSubtitlelogowatermarkaudioWatermarkcontactPicturewelcomeBackgroundfaceimportedTags

Response

Field	Type	Description
definitions	array	Definitions for this model requirement
└ identifier	string	TBA
└ model	string	TBA
└ modelQuery	object	TBA
└ required	boolean	TBA
└ conditions	array	TBA
└ placeholderText	array	TBA
└ infoText	array	TBA
event	string	Event of the model requirement
flag	integer	If flag = 0 the modelRequirement is active, flag 1 means it is deactivated/deleted ≡ allowed values: 01
id	integer	Id of the model requirement
lastEditorId	integer	Id of the user who did the last changes on this model requirement
securityGroupId	integer	Limit model requirements check to the given securityGroupId
settings	object	Settings for this model requirement – currently not used
└ colors	object	Colors
└ required	hexColor	TBA
└ recommended	hexColor	TBA
└ fulfilled	hexColor	TBA
title	string	Title for this model requirement definitions
type	string	Optional type of the model requirement ≡ allowed values: videoimageaudiodocumentdropsiteprivatecollectiongroupcollectionpressareacollaborationmediahubdownloadlinkpinboardcollectionadditionalMediaavatarimportedSubtitlelogowatermarkaudioWatermarkcontactPicturewelcomeBackgroundfaceimportedTags

Update modelRequirement

Updates an existing model requirement

PUT/v5/modelRequirement/:id

Request Parameters

Field	Type	Required	Description
definitions	array	✗	Definitions for this model requirement
└ identifier	string	✓	TBA
└ model	string	✓	TBA
└ modelQuery	object	✓	TBA
└ required	boolean	✓	TBA
└ conditions	array	✓	TBA
└ placeholderText	array	✓	TBA
└ infoText	array	✓	TBA
id	integer	✓	Id of the model requirement
securityGroupId	integer	✗	Limit model requirements check to the given securityGroupId
settings	object	✗	Settings for this model requirement – currently not used
└ colors	object	✗	Colors
└ required	hexColor	✓	TBA
└ recommended	hexColor	✓	TBA
└ fulfilled	hexColor	✓	TBA
title	string	✗	Title for this model requirement definitions
type	string	✗	≡ allowed values: videoimageaudiodocumentdropsiteprivatecollectiongroupcollectionpressareacollaborationmediahubdownloadlinkpinboardcollectionadditionalMediaavatarimportedSubtitlelogowatermarkaudioWatermarkcontactPicturewelcomeBackgroundfaceimportedTags

Response

Field	Type	Description
definitions	array	Definitions for this model requirement
└ identifier	string	TBA
└ model	string	TBA
└ modelQuery	object	TBA
└ required	boolean	TBA
└ conditions	array	TBA
└ placeholderText	array	TBA
└ infoText	array	TBA
event	string	Event of the model requirement
flag	integer	If flag = 0 the modelRequirement is active, flag 1 means it is deactivated/deleted ≡ allowed values: 01
id	integer	Id of the model requirement
lastEditorId	integer	Id of the user who did the last changes on this model requirement
securityGroupId	integer	Limit model requirements check to the given securityGroupId
settings	object	Settings for this model requirement – currently not used
└ colors	object	Colors
└ required	hexColor	TBA
└ recommended	hexColor	TBA
└ fulfilled	hexColor	TBA
title	string	Title for this model requirement definitions
type	string	Optional type of the model requirement ≡ allowed values: videoimageaudiodocumentdropsiteprivatecollectiongroupcollectionpressareacollaborationmediahubdownloadlinkpinboardcollectionadditionalMediaavatarimportedSubtitlelogowatermarkaudioWatermarkcontactPicturewelcomeBackgroundfaceimportedTags

Destroy modelRequirement

Deletes an existing model requirement.

DELETE/v5/modelRequirement/:id

Request Parameters

Field	Type	Required	Description
id	integer	✓	Id of the model requirement to destroy

Response

Field	Type	Description
definitions	array	Definitions for this model requirement
└ identifier	string	TBA
└ model	string	TBA
└ modelQuery	object	TBA
└ required	boolean	TBA
└ conditions	array	TBA
└ placeholderText	array	TBA
└ infoText	array	TBA
event	string	Event of the model requirement
flag	integer	If flag = 0 the modelRequirement is active, flag 1 means it is deactivated/deleted ≡ allowed values: 01
id	integer	Id of the model requirement
lastEditorId	integer	Id of the user who did the last changes on this model requirement
securityGroupId	integer	Limit model requirements check to the given securityGroupId
settings	object	Settings for this model requirement – currently not used
└ colors	object	Colors
└ required	hexColor	TBA
└ recommended	hexColor	TBA
└ fulfilled	hexColor	TBA
title	string	Title for this model requirement definitions
type	string	Optional type of the model requirement ≡ allowed values: videoimageaudiodocumentdropsiteprivatecollectiongroupcollectionpressareacollaborationmediahubdownloadlinkpinboardcollectionadditionalMediaavatarimportedSubtitlelogowatermarkaudioWatermarkcontactPicturewelcomeBackgroundfaceimportedTags

API

Reference

Find modelRequirement

Create modelRequirement

Update modelRequirement

Destroy modelRequirement

Related Articles