mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-06 12:27:48 +00:00
NEROCKET-73 small api fixes for the nerm workflow actions routes
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
post:
|
||||
summary: Create an approval action
|
||||
operationId: createApprovalAction
|
||||
description: Create an approval action. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. Coordinate with workflow_action_performer_notification_email for performer email config. Coordinate with workflow_action_approval_email for approval email config. Coordinate with workflow_action_rejection_email for rejection email config.
|
||||
description: Create an approval action. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. Coordinate with workflow_action_performer_notification_email for performer email config. Coordinate with workflow_action_approval_email for approval email config. Coordinate with workflow_action_rejection_email for rejection email config. These configurations must be created for this action to be successfully setup.
|
||||
tags:
|
||||
- workflow actions
|
||||
requestBody:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
post:
|
||||
summary: Create an auto assign action
|
||||
operationId: createAutoAssignAction
|
||||
description: Create an auto assign action. Coordinate with workflow_action_roles to assign roles.
|
||||
description: Create an auto assign action. Coordinate with workflow_action_roles to assign roles. These configurations must be created for this action to be successfully setup.
|
||||
tags:
|
||||
- workflow actions
|
||||
requestBody:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
post:
|
||||
summary: Create a contributors action
|
||||
operationId: createContributorsAction
|
||||
description: Create a contributors action. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. Coordinate with workflow_action_performer_notification_email for performer email config.
|
||||
description: Create a contributors action. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. Coordinate with workflow_action_performer_notification_email for performer email config. These configurations must be created for this action to be successfully setup.
|
||||
tags:
|
||||
- workflow actions
|
||||
requestBody:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
post:
|
||||
summary: Create a duplicate prevention action
|
||||
operationId: createDuplicatePreventionAction
|
||||
description: Create a duplicate prevention action. Coordinate with duplicatation_prevention_attributes to set up duplicate matching. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. Coordinate with workflow_action_performer_notification_email for performer email config.
|
||||
description: Create a duplicate prevention action. Coordinate with duplicatation_prevention_attributes to set up duplicate matching. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. Coordinate with workflow_action_performer_notification_email for performer email config. These configurations must be created for this action to be successfully setup.
|
||||
tags:
|
||||
- workflow actions
|
||||
requestBody:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
post:
|
||||
summary: Create a fulfillent action
|
||||
summary: Create a fulfillment action
|
||||
operationId: createFulfillmentAction
|
||||
description: Create a fulfillment action. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. Coordinate with workflow_action_performer_notification_email for performer email config.
|
||||
description: Create a fulfillment action. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. Coordinate with workflow_action_performer_notification_email for performer email config. These configurations must be created for this action to be successfully setup.
|
||||
tags:
|
||||
- workflow actions
|
||||
requestBody:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
post:
|
||||
summary: Create an identity proofing action
|
||||
operationId: createIdentityProofingAction
|
||||
description: Create an identity proofing action. Coordinates with identity_proofing_action_configuration for configuration. Coordinates with identity_proofing_action_mappings for mapping.
|
||||
description: Create an identity proofing action. Coordinates with identity_proofing_action_configuration for configuration. Coordinates with identity_proofing_action_mappings for mapping. These configurations must be created for this action to be successfully setup.
|
||||
tags:
|
||||
- workflow actions
|
||||
requestBody:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
post:
|
||||
summary: Create an invitation action
|
||||
operationId: createInvitationAction
|
||||
description: Create an invitation action. Coordinate with workflow_action_pause_action if action is to wait for completion.
|
||||
description: Create an invitation action. Coordinate with workflow_action_pause_action if action is to wait for completion. These configurations must be created for this action to be successfully setup.
|
||||
tags:
|
||||
- workflow actions
|
||||
requestBody:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
post:
|
||||
summary: Create a ldap action
|
||||
operationId: createLdapAction
|
||||
description: Create a ldap action. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role.
|
||||
description: Create a ldap action. Coordinate with workflow_action_performers to set up performers. Coordinate with workflow_action_roles to set up performers by role. These configurations must be created for this action to be successfully setup.
|
||||
tags:
|
||||
- workflow actions
|
||||
requestBody:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
post:
|
||||
summary: Create a REST API action
|
||||
operationId: createRestApiAction
|
||||
description: Create a REST API action. Coordinate with rest_api_action_configuration for configuration. Coordinate with api_configuration_attributes for status mapping attributes.
|
||||
description: Create a REST API action. Coordinate with rest_api_action_configuration for configuration. Coordinate with api_configuration_attributes for status mapping attributes. These configurations must be created for this action to be successfully setup.
|
||||
tags:
|
||||
- workflow actions
|
||||
requestBody:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
post:
|
||||
summary: Create a review action
|
||||
operationId: createReviewAction
|
||||
description: Create a review action. Coordinate with workflow_action_performer_notification_email for performer email config.
|
||||
description: Create a review action. Coordinate with workflow_action_performer_notification_email for performer email config. These configurations must be created for this action to be successfully setup.
|
||||
tags:
|
||||
- workflow actions
|
||||
requestBody:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
post:
|
||||
summary: Create a run workflow action
|
||||
operationId: createRunWorkflowAction
|
||||
description: Create a run workflow action. Coordinate with configuration_profile_attribute.
|
||||
description: Create a run workflow action. Coordinate with configuration_profile_attribute. These configurations must be created for this action to be successfully setup.
|
||||
tags:
|
||||
- workflow actions
|
||||
requestBody:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
post:
|
||||
summary: Create a set attributes action
|
||||
operationId: createSetAttributesAction
|
||||
description: Create a set attributes action. Coordinate with workflow_action_set_attributes for the attribute configuration.
|
||||
description: Create a set attributes action. Coordinate with workflow_action_set_attributes for the attribute configuration. These configurations must be created for this action to be successfully setup.
|
||||
tags:
|
||||
- workflow actions
|
||||
requestBody:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
post:
|
||||
summary: Create a SOAP API action
|
||||
operationId: createSoapApiAction
|
||||
description: Create a SOAP API action. Coordinates with soap_api_action_configuration for configuration. Coordinates with api_configuration_attributes.
|
||||
description: Create a SOAP API action. Coordinates with soap_api_action_configuration for configuration. Coordinates with api_configuration_attributes. These configurations must be created for this action to be successfully setup.
|
||||
tags:
|
||||
- workflow actions
|
||||
requestBody:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
post:
|
||||
summary: Create an unassign action
|
||||
operationId: createUnassignAction
|
||||
description: Create an unassign action. Coordinate with workflow_action_roles to assign roles.
|
||||
description: Create an unassign action. Coordinate with workflow_action_roles to assign roles. These configurations must be created for this action to be successfully setup.
|
||||
tags:
|
||||
- workflow actions
|
||||
requestBody:
|
||||
|
||||
@@ -28,7 +28,7 @@ properties:
|
||||
required: true
|
||||
enum: [hours, days, login attempts, always]
|
||||
description: The token expiration type, coordinates with token_expiration.
|
||||
example: day
|
||||
example: days
|
||||
archived:
|
||||
type: boolean
|
||||
default: false
|
||||
|
||||
@@ -28,7 +28,7 @@ properties:
|
||||
required: true
|
||||
enum: [hours, days, login attempts, always]
|
||||
description: The token expiration type, coordinates with token_expiration.
|
||||
example: day
|
||||
example: days
|
||||
archived:
|
||||
type: boolean
|
||||
default: false
|
||||
|
||||
@@ -17,8 +17,6 @@ properties:
|
||||
description: If the workflow action is archived or not.
|
||||
example: false
|
||||
configuration_attributes:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
@@ -26,11 +24,6 @@ properties:
|
||||
format: uuid
|
||||
description: the id.
|
||||
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
|
||||
workflow_id:
|
||||
type: string
|
||||
format: uuid
|
||||
description: the id of the workflow.
|
||||
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
|
||||
wait_for_completion:
|
||||
type: boolean
|
||||
example: false
|
||||
@@ -54,11 +47,6 @@ properties:
|
||||
format: uuid
|
||||
description: the id of the email attribute.
|
||||
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
|
||||
profile_type_id:
|
||||
type: string
|
||||
format: uuid
|
||||
description: the id of the profile type.
|
||||
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
|
||||
validate_completed_registration:
|
||||
type: boolean
|
||||
example: false
|
||||
@@ -68,8 +56,6 @@ properties:
|
||||
example: false
|
||||
description: If the action should validate against open registrations by email address.
|
||||
workflow_action_email_attributes:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
|
||||
@@ -23,8 +23,6 @@ properties:
|
||||
description: the type of store.
|
||||
example: Local
|
||||
ldap_action_user_roles_attributes:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
@@ -38,8 +36,6 @@ properties:
|
||||
description: the id of the role.
|
||||
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
|
||||
workflow_action_value_builders_attributes:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
@@ -63,8 +59,6 @@ properties:
|
||||
description: the position of the value builder attribute.
|
||||
example: 1
|
||||
workflow_action_directory_groups_attributes:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
|
||||
@@ -31,8 +31,6 @@ properties:
|
||||
description: If the workflow action is archived or not.
|
||||
example: false
|
||||
workflow_action_email_attributes:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
|
||||
@@ -17,8 +17,6 @@ properties:
|
||||
description: If the workflow action is archived or not.
|
||||
example: false
|
||||
configuration_attributes:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
@@ -49,11 +47,6 @@ properties:
|
||||
format: uuid
|
||||
description: the id of the child workflow to run.
|
||||
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
|
||||
email_attribute_id:
|
||||
type: string
|
||||
format: uuid
|
||||
description: the id of the email attribute.
|
||||
example: 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
|
||||
profile_type_id:
|
||||
type: string
|
||||
format: uuid
|
||||
|
||||
Reference in New Issue
Block a user