Workflow APIs
Get Workflows (GET)
Returns all workflow definitions.
Route
|
URI |
/api/v1/Workflow/GetWorkflows |
|
Method |
GET |
|
Result |
JSON – Array of WorkflowModel |
Parameters
None
Response Structure
Returns array of WorkflowModel objects, each containing:
-
WorkflowId: Unique identifier
-
Name: Workflow name
-
Description: Workflow description
-
ApprovalSteps: Sequence of approval steps
-
IsActive: Whether workflow is active
-
ResourceFilters: Filters for which resources this applies to
Example
GET http://localhost/api/v1/Workflow/GetWorkflows
Example Response
[
{
"WorkflowId": "123e4567-e89b-12d3-a456-426614174000",
"Name": "IT Resource Approval",
"Description": "Standard approval workflow for IT resources",
"ApprovalSteps": [
{
"StepNumber": 1,
"ApproverType": "Manager",
"ApproverIdentifier": "DirectManager",
"IsRequired": true,
"AllowModification": false
},
{
"StepNumber": 2,
"ApproverType": "DataOwner",
"ApproverIdentifier": "ResourceOwner",
"IsRequired": true,
"AllowModification": true
}
],
"IsActive": true,
"ResourceFilters": [
{"ResourceType": "AD", "Pattern": "*"}
]
}
]
Insert Workflow (POST)
Creates a new workflow definition.
Route
|
URI |
/api/v1/Workflow/InsertWorkflow |
|
Method |
POST |
|
Result |
JSON – WorkflowCreationResult |
Request Payload
WorkflowModel object:
|
Property |
Type |
Mandatory |
Description |
|---|---|---|---|
|
Name |
string |
Yes |
Workflow name |
|
Description |
string |
No |
Workflow description |
|
ApprovalSteps |
ApprovalStepModel[] |
Yes |
Sequence of approval steps |
|
IsActive |
bool |
Yes |
Whether workflow is active |
|
ResourceFilters |
ResourceFilterModel[] |
No |
Filters for applicable resources |
Response Structure
WorkflowCreationResult containing:
-
WorkflowId: Guid of the created workflow
-
Success: Boolean indicating creation success
-
Message: Status or error message
Example Request
POST http://localhost/api/v1/Workflow/InsertWorkflow
Content-Type: application/json
{
"Name": "IT Resource Approval",
"Description": "Standard approval workflow for IT resources",
"ApprovalSteps": [
{
"StepNumber": 1,
"ApproverType": "Manager",
"ApproverIdentifier": "DirectManager",
"IsRequired": true,
"AllowModification": false
}
],
"IsActive": true,
"ResourceFilters": []
}
Example Response
{
"WorkflowId": "123e4567-e89b-12d3-a456-426614174000",
"Success": true,
"Message": "Workflow created successfully"
}
Update Workflow (PUT)
Updates an existing workflow definition.
Route
|
URI |
/api/v1/Workflow/UpdateWorkflow |
|
Method |
PUT |
|
Result |
JSON – WorkflowUpdateResult |
Request Payload
WorkflowModel object:
|
Property |
Type |
Mandatory |
Description |
|---|---|---|---|
|
WorkflowId |
Guid |
Yes |
Existing workflow identifier |
|
Name |
string |
Yes |
Workflow name |
|
Description |
string |
No |
Workflow description |
|
ApprovalSteps |
ApprovalStepModel[] |
Yes |
Sequence of approval steps |
|
IsActive |
bool |
Yes |
Whether workflow is active |
|
ResourceFilters |
ResourceFilterModel[] |
No |
Filters for applicable resources |
Response Structure
WorkflowUpdateResult containing:
-
Success: Boolean indicating update success
-
Message: Status or error message
Example Request
PUT http://localhost/api/v1/Workflow/UpdateWorkflow
Content-Type: application/json
{
"WorkflowId": "123e4567-e89b-12d3-a456-426614174000",
"Name": "Updated IT Resource Approval",
"Description": "Modified approval workflow",
"ApprovalSteps": [
{
"StepNumber": 1,
"ApproverType": "Manager",
"ApproverIdentifier": "DirectManager",
"IsRequired": true,
"AllowModification": false
}
],
"IsActive": true,
"ResourceFilters": []
}
Example Response
{
"Success": true,
"Message": "Workflow updated successfully"
}
Delete Workflow (DELETE)
Deletes a workflow definition.
Route
|
URI |
/api/v1/Workflow/DeleteWorkflow |
|
Method |
DELETE |
|
Result |
JSON – WorkflowDeletionResult |
Parameters
Workflow Identifier.
Example
DELETE http://localhost/api/v1/Workflow/DeleteWorkflow?workflowId=guid
{
"Success": true
}
Get Atomic Approvers (GET)
Returns atomic approval roles configuration.
Route
|
URI |
/api/v1/Workflow/AtomicApprovalRoles |
|
Method |
GET |
|
Result |
JSON – Array of AtomicApprovalRole |
Parameters
None
Example
GET http://localhost/api/v1/Workflow/AtomicApprovalRoles
[
{
"Type": "DataOwnerApprover",
"dataOwnerOrganizationId": null,
"dataOwnerOrganizationName": null,
"displayName": null,
"displayResourceName": "LegacyDataOwnerApprovalRoleDefinition_DisplayResourceName"
},
{
"Type": "AidManAdminApprover",
"displayResourceName": "AidManAdminApprover"
},
{
"Type": "ManagerApprover",
"displayResourceName": "ManagerApprover"
},
{
"Type": "DefinedByPreviousApprover",
"displayResourceName": "DefinedByPreviousApprover"
},
{
"Type": "DataOwnerOfResourceApprover",
"displayResourceName": "DataOwnerApprover"
}
]
Get Data Owners (GET)
Returns data owner approval roles.
Route
|
URI |
/api/v1/workflow/dataOwnerapprovalroles |
|
Method |
GET |
|
Result |
JSON – Array of DataOwnerApprovalRole |
Parameters
None
Example
GET http://localhost/api/v1/workflow/dataOwnerapprovalroles
[
{
"Type": "DataOwnerApprover",
"dataOwnerOrganizationId": "fc1f754b-b547-4bca-a722-da658a590627",
"dataOwnerOrganizationName": "Company Name",
"displayName": "Company Name",
"displayResourceName": "LegacyDataOwnerApprovalRoleDefinition_DisplayResourceName"
},
{
"Type": "DataOwnerApprover",
"dataOwnerOrganizationId": "72e0b15a-7944-4929-8d71-c0cae6aac493",
"dataOwnerOrganizationName": "ewaf",
"displayName": "ewaf",
"displayResourceName": "LegacyDataOwnerApprovalRoleDefinition_DisplayResourceName"
}
]
Is Approver Allowed To Modify Order (GET)
Checks if the current approver is allowed to modify an order.
Route
|
URI |
/api/v1/Workflow/IsApproverAllowedToModifyOrder |
|
Method |
GET |
|
Result |
JSON – bool |
Parameters
|
Name |
Type |
Mandatory |
Description |
|
orderId |
Guid |
Yes |
The order identifier |
Example
GET http://localhost/api/v1/Workflow/IsApproverAllowedToModifyOrder?orderId=guid
Get Order Configuration (GET)
Returns workflow order configuration settings.
Route
|
URI |
/api/v1/Workflow/Configuration |
|
Method |
GET |
|
Result |
JSON – OrderConfigurationModel |
Parameters
None
Example
GET http://localhost/api/v1/Workflow/Configuration
{
"Type": "Container",
"label": "Configuration",
"templates": [
{
"key": "BaseConfiguration",
"value": {
"Type": "CollapsibleContainer",
"isCollapsed": false,
"label": "General Settings",
"templates": [
{
"key": "grantMaAdminEmail",
"value": {
"Type": "TextField",
"postfixText": null,
"dynamicQuery": null,
"dynamicResultWasSet": false,
"isRequired": true,
"constraints": {
"$type": "pn.formTemplates.resourceTemplates.TextInputConstraints, pn.formTemplates",
"isDirty": false,
"creationRule": null,
"maxLength": 254,
"forbiddenChars": null,
"isRequired": true,
"validationRule": "^(?!\\.)(\"([^\"\\\\\\r]|\\\\[\"\\r\\\\])*\"|([-0-9$%&!#a-z'*+/=?^_`{|}~]|(?<!\\.)\\.)*)(?<!\\.)@[0-9a-z][\\w\\.-]*[0-9a-z]\\.[a-z][a-z\\.]*[a-z]$",
"validationInformation": "Email address not valid!",
"allowOnlyDefinedValues": false,
"definedValues": null,
"uniquenessConstraint": null
},
"summary": null,
"value": null,
"defaultValue": null,
"description": null,
"customError": null,
"allowApply": true,
"label": "The administrator email address for GrantMA is",
"isEnabled": true,
"isEnabledRule": null,
"parsedIsEnabledRule": null,
"customAttributes": null,
"isHidden": false,
"isVisibleRule": null,
"parsedIsVisibleRule": null
}
}
],
"summary": null,
"customAttributes": null,
"isHidden": false,
"isVisibleRule": null,
"parsedIsVisibleRule": null
}
}
],
"summary": null,
"customAttributes": null,
"isHidden": false,
"isVisibleRule": null,
"parsedIsVisibleRule": null
}
Get Workflows (GET)
Returns all stored workflow definitions.
Route
|
URI |
/api/v1/Workflow |
|
Method |
GET |
|
Result |
JSON – IRequestWorkflow[] |
Parameters
None
Example
GET http://localhost/api/v1/Workflow
Update Workflow (PUT)
Updates a <see cref="IRequestWorkflow"/>.
Route
|
URI |
/api/v1/Workflow |
|
Method |
PUT |
|
Result |
JSON – IRequestWorkflow |
Parameters
None
Example
PUT http://localhost/api/v1/Workflow
Insert Workflow (POST)
Creates a <see cref="IRequestWorkflow"/>.
Route
|
URI |
/api/v1/Workflow |
|
Method |
POST |
|
Result |
JSON – IRequestWorkflow |
Parameters
None
Example
POST http://localhost/api/v1/Workflow
Delete Workflow (DELETE)
Deletes a <see cref="IRequestWorkflow"/> specified by the given <paramref name="id"/>.
Route
|
URI |
/api/v1/Workflow |
|
Method |
DELETE |
|
Result |
JSON – void |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
id |
Guid |
Yes |
|
Example
DELETE http://localhost/api/v1/Workflow
Get Atomic Approval Role Definitions (GET)
Gets the atomic approval role definitions, no additional parameters are necessary/>.
Route
|
URI |
/api/v1/Workflow/AtomicApprovalRoles |
|
Method |
GET |
|
Result |
JSON – IApprovalRoleDefinition[] |
Parameters
None
Example
GET http://localhost/api/v1/Workflow/AtomicApprovalRoles
Get Config (GET)
Get Configration in form of IFormTemplate for GrantMA.
Route
|
URI |
/api/v1/Workflow/Configuration |
|
Method |
GET |
|
Result |
JSON – IFormTemplate |
Parameters
None
Example
GET http://localhost/api/v1/Workflow/Configuration
Set Config (POST)
Save Configuration in form of IFormTemplate for Analyze.
Route
|
URI |
/api/v1/Workflow/Configuration |
|
Method |
POST |
|
Result |
JSON – ChangeResult |
Parameters
None
Response Structure Returns ChangeResult object containing:
-
Success: bool value
-
Data: object value
-
ResponseId: Guid? value
-
ErrorDetails: ExternalInterfaceException value
Example
POST http://localhost/api/v1/Workflow/Configuration
Example Response
{ "Success": true, "Data": {}, "ResponseId": "123e4567-e89b-12d3-a456-426614174000", "ErrorDetails": {} }
Get Ancestors (GET)
Get Children for a given Node via Urikey
Route
|
URI |
/api/v1/Workflow/Dataowner/Ancestors |
|
Method |
GET |
|
Result |
JSON – ResourceOwnerConfigurationResourceModel[] |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
uriKey |
string |
No |
|
Response Structure Returns ResourceOwnerConfigurationResourceModel[] object containing:
-
Resource: LightResourceModel value
-
HasChildren: Indicates if the resource has children.
-
HasConfigurationEntry: Indicates if the resource is associated with a <see cref="ResourceOwnerConfigurationEntryModel"/>.
-
DescendantHasConfigurationEntry: Indicates if a descendant of this resource is associated with a <see cref="ResourceOwnerConfigurationEntryModel"/>.
Example
GET http://localhost/api/v1/Workflow/Dataowner/Ancestors
Example Response
{ "Resource": {}, "HasChildren": true, "HasConfigurationEntry": true, "DescendantHasConfigurationEntry": true }
Get Children (GET)
Get Children for a given Node via Urikey
Route
|
URI |
/api/v1/Workflow/Dataowner/Children |
|
Method |
GET |
|
Result |
JSON – ResourceOwnerConfigurationResourceModel[] |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
uriKey |
string |
No |
|
Response Structure Returns ResourceOwnerConfigurationResourceModel[] object containing:
-
Resource: LightResourceModel value
-
HasChildren: Indicates if the resource has children.
-
HasConfigurationEntry: Indicates if the resource is associated with a <see cref="ResourceOwnerConfigurationEntryModel"/>.
-
DescendantHasConfigurationEntry: Indicates if a descendant of this resource is associated with a <see cref="ResourceOwnerConfigurationEntryModel"/>.
Example
GET http://localhost/api/v1/Workflow/Dataowner/Children
Example Response
{ "Resource": {}, "HasChildren": true, "HasConfigurationEntry": true, "DescendantHasConfigurationEntry": true }
Get Data Owner Config (GET)
Get Configuration of all DataOwner
Route
|
URI |
/api/v1/Workflow/Dataowner/Config |
|
Method |
GET |
|
Result |
JSON – ResourceOwnerConfigurationModel |
Parameters
None
Response Structure Returns ResourceOwnerConfigurationModel object containing:
-
EntriesByResource: Dictionary<string /* uriKey */, ResourceOwnerConfigurationEntryModel> value
-
ResourceNodes: Dictionary<string /* uriKey*/, ResourceOwnerConfigurationResourceModel> value
-
EntriesByTechnology: Dictionary<ResourceType, ResourceOwnerConfigurationEntryModel> value
-
TechnologyNodes: Dictionary<ResourceType, ResourceTypeModel> value
-
RootEntry: ResourceOwnerConfigurationEntryModel value
Example
GET http://localhost/api/v1/Workflow/Dataowner/Config
Example Response
{ "EntriesByResource": {}, "ResourceNodes": {}, "EntriesByTechnology": {}, "TechnologyNodes": {}, "RootEntry": {} }
Is Resource Owner Config Enabled (GET)
See <see cref="IOpenResourceOwnerConfigurationService.IsEnabled"/>.
Route
|
URI |
/api/v1/Workflow/Dataowner/IsEnabled |
|
Method |
GET |
|
Result |
JSON – bool |
Parameters
None
Example
GET http://localhost/api/v1/Workflow/Dataowner/IsEnabled
Add Data Owner To Resource (POST)
Adds data owners (<paramref name="accountsWithUri"/>) to the specified resource node and returns the updated (or newly created) entry.
Route
|
URI |
/api/v1/Workflow/Dataowner/Resource/add |
|
Method |
POST |
|
Result |
JSON – ResourceOwnerConfigurationEntryModel |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
accountsWithUri |
AccountsWithUriKey |
No |
|
Response Structure Returns ResourceOwnerConfigurationEntryModel object containing:
-
DataOwners: AccountModel[] value
-
ErrorMessages: string[] value
Example
POST http://localhost/api/v1/Workflow/Dataowner/Resource/add
Example Response
{ "DataOwners": {}, "ErrorMessages": {} }
Remove Data Owner From Resource (POST)
Removes data owners (<paramref name="accountsWithUriKey"/>) to the specified resource node and returns the updated (or newly created) entry.
Route
|
URI |
/api/v1/Workflow/Dataowner/Resource/delete |
|
Method |
POST |
|
Result |
JSON – ResourceOwnerConfigurationEntryModel |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
accountsWithUriKey |
AccountsWithUriKey |
No |
|
Response Structure Returns ResourceOwnerConfigurationEntryModel object containing:
-
DataOwners: AccountModel[] value
-
ErrorMessages: string[] value
Example
POST http://localhost/api/v1/Workflow/Dataowner/Resource/delete
Example Response
{ "DataOwners": {}, "ErrorMessages": {} }
Add Data Owner To Root (POST)
Adds data owners (<paramref name="accounts"/>) to the root node and returns the updated (or newly created) entry.
Route
|
URI |
/api/v1/Workflow/Dataowner/Root/add |
|
Method |
POST |
|
Result |
JSON – ResourceOwnerConfigurationEntryModel |
Request Payload
AccountModel[] object:
|
Property |
Type |
Mandatory |
Description |
|---|---|---|---|
|
ResourceTypeGuid |
Guid |
Yes |
|
|
SerializedAccountId |
string |
Yes |
|
|
UriKey |
string |
Yes |
|
|
DisplayName |
string |
No |
|
|
Provider |
TechnologyProvider |
No |
|
|
IsGroup |
bool |
No |
|
|
Sid |
string |
No |
|
|
Guid |
Guid? |
No |
|
|
Description |
string |
No |
|
|
Attributes |
KeyValuePair<string, string>[] |
No |
|
|
ExtendedAttributes |
KeyValuePair<string, string>[] |
No |
|
|
Children |
string[] |
No |
|
|
TypeId |
int |
No |
|
Response Structure Returns ResourceOwnerConfigurationEntryModel object containing:
-
DataOwners: AccountModel[] value
-
ErrorMessages: string[] value
Example
POST http://localhost/api/v1/Workflow/Dataowner/Root/add Content-Type: application/json
{
"ResourceTypeGuid":
"123e4567-e89b-12d3-a456-426614174000",
"SerializedAccountId": "sample",
"UriKey": "sample",
"DisplayName": "sample",
"Provider": {},
"IsGroup": true,
"Sid": "sample",
"Guid": "123e4567-e89b-12d3-a456-426614174000",
"Description": "sample",
"Attributes": {},
"ExtendedAttributes": {},
"Children": {},
"TypeId": 1
}
Example Response
{ "DataOwners": {}, "ErrorMessages": {} }
Remove Data Owner From Root (POST)
Removes data owners (<paramref name="accounts"/>) to the root node and returns the updated (or newly created) entry.
Route
|
URI |
/api/v1/Workflow/Dataowner/Root/delete |
|
Method |
POST |
|
Result |
JSON – ResourceOwnerConfigurationEntryModel |
Request Payload
AccountModel[] object:
|
Property |
Type |
Mandatory |
Description |
|---|---|---|---|
|
ResourceTypeGuid |
Guid |
Yes |
|
|
SerializedAccountId |
string |
Yes |
|
|
UriKey |
string |
Yes |
|
|
DisplayName |
string |
No |
|
|
Provider |
TechnologyProvider |
No |
|
|
IsGroup |
bool |
No |
|
|
Sid |
string |
No |
|
|
Guid |
Guid? |
No |
|
|
Description |
string |
No |
|
|
Attributes |
KeyValuePair<string, string>[] |
No |
|
|
ExtendedAttributes |
KeyValuePair<string, string>[] |
No |
|
|
Children |
string[] |
No |
|
|
TypeId |
int |
No |
|
Response Structure Returns ResourceOwnerConfigurationEntryModel object containing:
-
DataOwners: AccountModel[] value
-
ErrorMessages: string[] value
Example
POST http://localhost/api/v1/Workflow/Dataowner/Root/delete Content-Type: application/json
{
"ResourceTypeGuid":
"123e4567-e89b-12d3-a456-426614174000",
"SerializedAccountId": "sample",
"UriKey": "sample",
"DisplayName": "sample",
"Provider": {},
"IsGroup": true,
"Sid": "sample",
"Guid": "123e4567-e89b-12d3-a456-426614174000",
"Description": "sample",
"Attributes": {},
"ExtendedAttributes": {},
"Children": {},
"TypeId": 1
}
Example Response
{ "DataOwners": {}, "ErrorMessages": {} }
Get Technology Nodes (GET)
Get all TechnologyNodes directly under the root nodes
Route
|
URI |
/api/v1/Workflow/Dataowner/Roots |
|
Method |
GET |
|
Result |
JSON – ResourceTypeModel[] |
Parameters
None
Response Structure Returns ResourceTypeModel[] object containing:
-
DisplayName: Gets or sets the localized display name.
-
ResourceType: ResourceType value
-
TypeId: Gets or sets the type ID (for displaying an icon).
Example
GET http://localhost/api/v1/Workflow/Dataowner/Roots
Example Response
{ "DisplayName": "sample", "ResourceType": {}, "TypeId": 1 }
Get Technology Roots (GET)
Get technology roots for a given ResourceType Id
Route
|
URI |
/api/v1/Workflow/Dataowner/Roots/{type} |
|
Method |
GET |
|
Result |
JSON – ResourceOwnerConfigurationResourceModel[] |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
type |
string |
Yes |
|
Response Structure Returns ResourceOwnerConfigurationResourceModel[] object containing:
-
Resource: LightResourceModel value
-
HasChildren: Indicates if the resource has children.
-
HasConfigurationEntry: Indicates if the resource is associated with a <see cref="ResourceOwnerConfigurationEntryModel"/>.
-
DescendantHasConfigurationEntry: Indicates if a descendant of this resource is associated with a <see cref="ResourceOwnerConfigurationEntryModel"/>.
Example
GET http://localhost/api/v1/Workflow/Dataowner/Roots/{type}
Example Response
{ "Resource": {}, "HasChildren": true, "HasConfigurationEntry": true, "DescendantHasConfigurationEntry": true }
Add Data Owner To Technology (POST)
Adds data owners (<paramref name="accounts"/>) to the specified technology node and returns the updated (or newly created) entry.
Route
|
URI |
/api/v1/Workflow/Dataowner/Technology/{typeId}/add |
|
Method |
POST |
|
Result |
JSON – ResourceOwnerConfigurationEntryModel |
Request Payload
AccountModel[] object:
|
Property |
Type |
Mandatory |
Description |
|---|---|---|---|
|
ResourceTypeGuid |
Guid |
Yes |
|
|
SerializedAccountId |
string |
Yes |
|
|
UriKey |
string |
Yes |
|
|
DisplayName |
string |
No |
|
|
Provider |
TechnologyProvider |
No |
|
|
IsGroup |
bool |
No |
|
|
Sid |
string |
No |
|
|
Guid |
Guid? |
No |
|
|
Description |
string |
No |
|
|
Attributes |
KeyValuePair<string, string>[] |
No |
|
|
ExtendedAttributes |
KeyValuePair<string, string>[] |
No |
|
|
Children |
string[] |
No |
|
|
TypeId |
int |
No |
|
Response Structure Returns ResourceOwnerConfigurationEntryModel object containing:
-
DataOwners: AccountModel[] value
-
ErrorMessages: string[] value
Example
POST http://localhost/api/v1/Workflow/Dataowner/Technology/{typeId}/add Content-Type: application/json
{
"ResourceTypeGuid": "123e4567-e89b-12d3-a456-426614174000",
"SerializedAccountId": "sample",
"UriKey": "sample",
"DisplayName": "sample",
"Provider": {},
"IsGroup": true,
"Sid": "sample",
"Guid": "123e4567-e89b-12d3-a456-426614174000",
"Description": "sample",
"Attributes": {},
"ExtendedAttributes": {},
"Children": {},
"TypeId": 1
}
Example Response
{ "DataOwners": {}, "ErrorMessages": {} }
Remove Data Owner From Technology (POST)
Removes data owners (<paramref name="accounts"/>) to the specified technology node and returns the updated (or newly created) entry.
Route
|
URI |
/api/v1/Workflow/Dataowner/Technology/{typeId}/delete |
|
Method |
POST |
|
Result |
JSON – ResourceOwnerConfigurationEntryModel |
Request Payload
AccountModel[] object:
|
Property |
Type |
Mandatory |
Description |
|---|---|---|---|
|
ResourceTypeGuid |
Guid |
Yes |
|
|
SerializedAccountId |
string |
Yes |
|
|
UriKey |
string |
Yes |
|
|
DisplayName |
string |
No |
|
|
Provider |
TechnologyProvider |
No |
|
|
IsGroup |
bool |
No |
|
|
Sid |
string |
No |
|
|
Guid |
Guid? |
No |
|
|
Description |
string |
No |
|
|
Attributes |
KeyValuePair<string, string>[] |
No |
|
|
ExtendedAttributes |
KeyValuePair<string, string>[] |
No |
|
|
Children |
string[] |
No |
|
|
TypeId |
int |
No |
|
Response Structure Returns ResourceOwnerConfigurationEntryModel object containing:
-
DataOwners: AccountModel[] value
-
ErrorMessages: string[] value
Example
POST http://localhost/api/v1/Workflow/Dataowner/Technology/{typeId}/delete Content-Type: application/json
{
"ResourceTypeGuid": "123e4567-e89b-12d3-a456-426614174000",
"SerializedAccountId": "sample",
"UriKey": "sample",
"DisplayName": "sample",
"Provider": {},
"IsGroup": true,
"Sid": "sample",
"Guid": "123e4567-e89b-12d3-a456-426614174000",
"Description": "sample",
"Attributes": {},
"ExtendedAttributes": {},
"Children": {},
"TypeId": 1
}
Example Response
{ "DataOwners": {}, "ErrorMessages": {} }
Get (GET)
Gets the atomic approval role definitions, no additional parameters are necessary/>.
Route
|
URI |
/api/v1/Workflow/DataOwnerApprovalRoles |
|
Method |
GET |
|
Result |
JSON – IApprovalRoleDefinition[] |
Parameters
None
Example
GET http://localhost/api/v1/Workflow/DataOwnerApprovalRoles
Is Workflow In Data Owner Configuration (GET)
See <see cref="IOpenWorkflowDefinitionService{TIdentity}.IsWorkflowInDataOwnerConfiguration"/>.
Route
|
URI |
/api/v1/Workflow/GetWorkflows/{id} |
|
Method |
GET |
|
Result |
JSON – bool |
Parameters
|
Name |
Type |
Mandatory |
Description |
|---|---|---|---|
|
id |
Guid |
Yes |
|
Example
GET http://localhost/api/v1/Workflow/GetWorkflows/{id}
Is Approver Allowed To Modify Order (GET)
Indicates if approvers should be able to modify order details.
Route
|
URI |
/api/v1/Workflow/IsApproverAllowedToModifyOrder |
|
Method |
GET |
|
Result |
JSON – bool |
Parameters
None
Example
GET http://localhost/api/v1/Workflow/IsApproverAllowedToModifyOrder
Is Order Search Enabled (GET)
Indicates if the search box should be displayed on the order (new request) page.
Route
|
URI |
/api/v1/Workflow/IsOrderSearchEnabled |
|
Method |
GET |
|
Result |
JSON – bool |
Parameters
None
Example
GET http://localhost/api/v1/Workflow/IsOrderSearchEnabled