Entity State Workflow

class labstep.entities.entityStateWorkflow.model.EntityStateWorkflow(data, user)

Represents a series of states an entity must go through, including who needs to sign / be assigned at each stage.

edit(name=OPTIONAL, extraParams={})

Edit an existing EntityStateWorkflow.

Parameters:: name (str) – The new name of the EntityStateWorkflow.
Returns:: An object representing the edited EntityStateWorkflow.
Return type:: EntityStateWorkflow

Example

my_entity_state_workflow = user.getEntityStateWorkflow(17000)
my_entity_state_workflow.edit(name='A New EntityStateWorkflow Name')

newEntityState(name, color='#0057dd', type='unstarted', extraParams={})

Add an EntityState to an EntityStateWorkflow.

Parameters:

name (str) – The name of the EntityState.
color in HEX value(str) – The color of the EntityState.
type(str) – The type of the EntityState. It can be one of the following: ‘unstarted’, ‘started’, and ‘complete’.

Returns:

An object representing the EntityState.

Return type:

EntityState

Example

my_entity_state_workflow = user.getEntityStateWorkflow(17000)
my_entity_state_workflow.newEntityState(name='A New EntityState Name')

getEntityState(entity_state_id)

Get an EntityState in an EntityStateWorkflow.

Parameters:: entity_state_id(int) – The ID of the EntityState.
Returns:: An object representing the EntityState.
Return type:: EntityState

Example

my_entity_state_workflow = user.getEntityStateWorkflow(17000)
my_entity_state_workflow.getEntityState(17000)

getEntityStates(count=OPTIONAL, search_query=OPTIONAL, extraParams={})

Get all EntityStates in an EntityStateWorkflow.

Parameters:

count(int) – The number of EntityStates to return.
search_query(str) – The search query to filter EntityStates.

Returns:

An object representing the EntityState.

Return type:

EntityState

Example

my_entity_state_workflow = user.getEntityStateWorkflow(17000)
my_entity_state_workflow.getEntityStates()

Entity State

class labstep.entities.entityState.model.EntityState(data, user)

Represents an Entity State Workflow on Labstep.

edit(name=OPTIONAL, color=OPTIONAL, state_type=OPTIONAL, extraParams={})

Edit an existing EntityState.

Parameters:

name (str) – The new name of the EntityState.
color in HEX vaue(str) – The new color of the EntityState.
type(str) – The new type of the EntityState. It can be one of the following: ‘unstarted’, ‘started’, and ‘complete’.

Returns:

An object representing the edited EntityState.

Return type:

EntityState

Example

my_entity_state_workflow = user.getEntityStateWorkflow(17000)
my_entity_state = my_entity_state_workflow.getEntityState(17000)
my_entity_state.edit(name='A New EntityState Name')

addRoleRequirement(collaborator_role_id, number_required=1, extraParams={})

Create a new RoleRequirement.

Parameters:

collaborator_rol_id (int) – ID of the collaborator role.
number_required(int) – Number of collaborators required.

Returns:

An object representing the edited CollaboratorRoleRequirement.

Return type:

CollaboratorRoleRequirement

Example

my_entity_state_workflow = user.getEntityStateWorkflow(17000)
collaborator_role = workspace.getCollaboratorRole(17000)
my_entity_state = my_entity_state_workflow.getEntityStates()
my_entity_state[0].addRoleRequirement(entity_user_role_id=collaborator_role.id,
                                      number_required=2
                                      )

getCollaboratorRoleRequirements()

Get all RoleRequirements of an EntityState.

Returns:: A list of objects representing CollaboratorRoleRequirements.
Return type:: List[CollaboratorRoleRequirement]

Example

my_entity_state = entityWorkflow.getEntityState(17000)
role_requirements = my_entity_state.getCollaboratorRoleRequirements()

Collaborator Role Requirement

class labstep.entities.collaboratorRoleRequirement.model.CollaboratorRoleRequirement(data, user)

Represents a requirement for a particular Collaborator role to be assigned at a particular state an the EntityStateWorkflow.

edit(number_required=OPTIONAL, collaborator_role_id=OPTIONAL, auto_assign=OPTIONAL, extraParams={})

Edit an existing CollaboratorRoleRequirement.

Parameters:: number_required (int) – The new number of CollaboratorRoleRequirement.
Returns:: An object representing the edited CollaboratorRoleRequirement.
Return type:: CollaboratorRoleRequirement

Example

my_entity_state_workflow = user.getEntityStateWorkflow(17000)
my_entity_state = my_entity_state_workflow.newEntityState(name='A New EntityState Name')
collaborator_requirements=my_entity_state.addRoleRequirement(collaborator_role_id=17000, number_required=4)
collaborator_requirements.edit(number_required=2)

getSignatureRequirement()

Get a SignatureRequirement of a Collaborator Role Requirement.

Returns:: An object representing the SignatureRequirement.
Return type:: SignatureRequirement

Example

my_entity_state_workflow = user.getEntityStateWorkflow(17000)
my_entity_state = my_entity_state_workflow.newEntityState(name='A New EntityState Name')
collaborator_req=my_entity_state.addRoleRequirement(collaborator_role_id=17000,
                                                             number_required=2
                                                             )
signature_requirement = collaborator_req.getSignatureRequirement()

setSignatureRequirement(statement=OPTIONAL, days_to_sign=OPTIONAL, reject_entity_state_id=OPTIONAL, extraParams={})

Set SignatureRequirement of a Collaborator Role Requirement.

Parameters:

required (bool) – If the SignatureRequirement is required.
default_statement (str) – The default statement of the SignatureRequirement.
days_to_sign(int) – The days to sign of the SignatureRequirement.
reject_entity_state_id(int) – The ID of the entity state on reject of the SignatureRequirement.

Returns:

An object representing the edited SignatureRequirement.

Return type:

SignatureRequirement

Example

my_entity_state_workflow = user.getEntityStateWorkflow(17000)
my_entity_state = my_entity_state_workflow.newEntityState(name='A New EntityState Name')
collaborator_requirements=my_entity_state.addRoleRequirement(collaborator_role_id=17000, number_required=2)
my_signature_requirement = collaborator_requirements.setSignatureRequirement(default_statement='A New SignatureRequirement Default Statement')

Signature Requirement

class labstep.entities.signatureRequirement.model.SignatureRequirement(data, user)

Represents a Signature Requirement on Labstep.

edit(statement=OPTIONAL, days_to_sign=OPTIONAL, reject_entity_state_id=OPTIONAL, extraParams={})

Edit an existing SignatureRequirement.

Parameters:

default_statement (str) – The new default statement of the SignatureRequirement.
days_to_sign(int) – The new days to sign of the SignatureRequirement.
reject_entity_state_id(int) – The entity state ID on reject of the SignatureRequirement.

Returns:

An object representing the edited SignatureRequirement.

Return type:

SignatureRequirement

Example

my_entity_state_workflow = user.getEntityStateWorkflow(17000)
collaborator_role = workspace.getCollaboratorRole(17000)
my_entity_state = my_entity_state_workflow.getEntityStates()
collaboratorRoleRequirement = my_entity_state[0].addRoleRequirement(entity_user_role_id=collaborator_role.id, number_required=2)
my_signature_requirements = collaboratorRoleRequirement.getSignatureRequirements()
my_signature_requirements.edit(statement='A New SignatureRequirement Default Statement')

disableSignatureRequirement(extraParams={})

Disable an existing SignatureRequirement.

Returns:: An object representing the edited SignatureRequirement.
Return type:: SignatureRequirement

Example

my_entity_state_workflow = user.getEntityStateWorkflow(17000)
collaborator_role = workspace.getCollaboratorRole(17000)
my_entity_state = my_entity_state_workflow.getEntityStates()
collaboratorRoleRequirement = my_entity_state[0].addRoleRequirement(entity_user_role_id=collaborator_role.id, number_required=2)
my_signature_requirements = collaboratorRoleRequirement.getSignatureRequirements()
my_signature_requirements.disableSignatureRequirement()