LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 20:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update to python SDK docs: 13820107626

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-12 19:41:45 +00:00
parent 184517209d
commit 113200f5fe
221 changed files with 8723 additions and 7883 deletions
Download Patch File Download Diff File Expand all files Collapse all files

140
docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md
View File

@@ -69,23 +69,23 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID
try:
# Cancel Workflow Execution by ID
WorkflowsApi(api_client).cancel_workflow_execution(id)
WorkflowsApi(api_client).cancel_workflow_execution(id=id)
# Below is a request that includes all optional parameters
# WorkflowsApi(api_client).cancel_workflow_execution(id)
except Exception as e:
except Exception as e:
print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e)
```
@@ -126,7 +126,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response
@@ -135,19 +134,20 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow
create_external_execute_workflow_request = sailpoint.v3.CreateExternalExecuteWorkflowRequest() # CreateExternalExecuteWorkflowRequest | (optional)
create_external_execute_workflow_request = '''sailpoint.v3.CreateExternalExecuteWorkflowRequest()''' # CreateExternalExecuteWorkflowRequest | (optional)
try:
# Execute Workflow via External Trigger
results =WorkflowsApi(api_client).create_external_execute_workflow(id, )
results = WorkflowsApi(api_client).create_external_execute_workflow(id=id)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request)
print("The response of WorkflowsApi->create_external_execute_workflow:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e)
```
@@ -187,7 +187,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.create_workflow_request import CreateWorkflowRequest
@@ -196,19 +195,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
create_workflow_request = {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} # CreateWorkflowRequest |
create_workflow_request = '''{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}''' # CreateWorkflowRequest |
try:
# Create Workflow
new_create_workflow_request = CreateWorkflowRequest()
new_create_workflow_request.from_json(create_workflow_request)
results =WorkflowsApi(api_client).create_workflow(new_create_workflow_request)
new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request)
results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request)
print("The response of WorkflowsApi->create_workflow:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e)
```
@@ -248,7 +247,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.workflow_o_auth_client import WorkflowOAuthClient
@@ -256,18 +254,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow
try:
# Generate External Trigger OAuth Client
results =WorkflowsApi(api_client).create_workflow_external_trigger(id)
results = WorkflowsApi(api_client).create_workflow_external_trigger(id=id)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).create_workflow_external_trigger(id)
print("The response of WorkflowsApi->create_workflow_external_trigger:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e)
```
@@ -307,23 +306,23 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow
try:
# Delete Workflow By Id
WorkflowsApi(api_client).delete_workflow(id)
WorkflowsApi(api_client).delete_workflow(id=id)
# Below is a request that includes all optional parameters
# WorkflowsApi(api_client).delete_workflow(id)
except Exception as e:
except Exception as e:
print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e)
```
@@ -363,7 +362,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.workflow import Workflow
@@ -371,18 +369,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow
try:
# Get Workflow By Id
results =WorkflowsApi(api_client).get_workflow(id)
results = WorkflowsApi(api_client).get_workflow(id=id)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).get_workflow(id)
print("The response of WorkflowsApi->get_workflow:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e)
```
@@ -423,25 +422,25 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID.
try:
# Get Workflow Execution
results =WorkflowsApi(api_client).get_workflow_execution(id)
results = WorkflowsApi(api_client).get_workflow_execution(id=id)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).get_workflow_execution(id)
print("The response of WorkflowsApi->get_workflow_execution:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e)
```
@@ -482,7 +481,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.workflow_execution_event import WorkflowExecutionEvent
@@ -490,18 +488,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution
try:
# Get Workflow Execution History
results =WorkflowsApi(api_client).get_workflow_execution_history(id)
results = WorkflowsApi(api_client).get_workflow_execution_history(id=id)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).get_workflow_execution_history(id)
print("The response of WorkflowsApi->get_workflow_execution_history:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e)
```
@@ -556,7 +555,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.workflow_execution import WorkflowExecution
@@ -564,6 +562,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow ID.
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
@@ -574,12 +573,12 @@ with ApiClient(configuration) as api_client:
try:
# List Workflow Executions
results =WorkflowsApi(api_client).get_workflow_executions(id, )
results = WorkflowsApi(api_client).get_workflow_executions(id=id)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters)
print("The response of WorkflowsApi->get_workflow_executions:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e)
```
@@ -620,7 +619,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner
@@ -628,6 +626,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
@@ -635,12 +634,12 @@ with ApiClient(configuration) as api_client:
try:
# List Complete Workflow Library
results =WorkflowsApi(api_client).list_complete_workflow_library()
results = WorkflowsApi(api_client).list_complete_workflow_library()
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset)
print("The response of WorkflowsApi->list_complete_workflow_library:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e)
```
@@ -682,7 +681,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.workflow_library_action import WorkflowLibraryAction
@@ -690,6 +688,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
@@ -698,12 +697,12 @@ with ApiClient(configuration) as api_client:
try:
# List Workflow Library Actions
results =WorkflowsApi(api_client).list_workflow_library_actions()
results = WorkflowsApi(api_client).list_workflow_library_actions()
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters)
print("The response of WorkflowsApi->list_workflow_library_actions:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e)
```
@@ -740,7 +739,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.workflow_library_operator import WorkflowLibraryOperator
@@ -748,17 +746,18 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Workflow Library Operators
results =WorkflowsApi(api_client).list_workflow_library_operators()
results = WorkflowsApi(api_client).list_workflow_library_operators()
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).list_workflow_library_operators()
print("The response of WorkflowsApi->list_workflow_library_operators:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e)
```
@@ -800,7 +799,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.workflow_library_trigger import WorkflowLibraryTrigger
@@ -808,6 +806,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
@@ -816,12 +815,12 @@ with ApiClient(configuration) as api_client:
try:
# List Workflow Library Triggers
results =WorkflowsApi(api_client).list_workflow_library_triggers()
results = WorkflowsApi(api_client).list_workflow_library_triggers()
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters)
print("The response of WorkflowsApi->list_workflow_library_triggers:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e)
```
@@ -858,7 +857,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.workflow import Workflow
@@ -866,17 +864,18 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Workflows
results =WorkflowsApi(api_client).list_workflows()
results = WorkflowsApi(api_client).list_workflows()
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).list_workflows()
print("The response of WorkflowsApi->list_workflows:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e)
```
@@ -917,7 +916,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
@@ -926,26 +924,20 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow
[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}] # List[JsonPatchOperation] |
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] |
json_patch_operation = '''[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}]''' # List[JsonPatchOperation] |
try:
# Patch Workflow
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation)
print("The response of WorkflowsApi->patch_workflow:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e)
```
@@ -986,7 +978,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.workflow import Workflow
@@ -995,9 +986,10 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow
workflow_body = {
workflow_body = '''{
"owner" : {
"name" : "William Wilson",
"id" : "2c91808568c529c60168cca6f90c1313",
@@ -1035,18 +1027,17 @@ with ApiClient(configuration) as api_client:
"type" : "EVENT"
},
"enabled" : false
} # WorkflowBody |
}''' # WorkflowBody |
try:
# Update Workflow
new_workflow_body = WorkflowBody()
new_workflow_body.from_json(workflow_body)
results =WorkflowsApi(api_client).put_workflow(id, new_workflow_body)
new_workflow_body = WorkflowBody.from_json(workflow_body)
results = WorkflowsApi(api_client).put_workflow(id=id, workflow_body=new_workflow_body)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body)
print("The response of WorkflowsApi->put_workflow:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e)
```
@@ -1087,7 +1078,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response
@@ -1096,19 +1086,20 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow
test_external_execute_workflow_request = sailpoint.v3.TestExternalExecuteWorkflowRequest() # TestExternalExecuteWorkflowRequest | (optional)
test_external_execute_workflow_request = '''sailpoint.v3.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional)
try:
# Test Workflow via External Trigger
results =WorkflowsApi(api_client).test_external_execute_workflow(id, )
results = WorkflowsApi(api_client).test_external_execute_workflow(id=id)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request)
print("The response of WorkflowsApi->test_external_execute_workflow:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e)
```
@@ -1151,7 +1142,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.test_workflow200_response import TestWorkflow200Response
@@ -1160,20 +1150,20 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow
test_workflow_request = {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} # TestWorkflowRequest |
test_workflow_request = '''{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}''' # TestWorkflowRequest |
try:
# Test Workflow By Id
new_test_workflow_request = TestWorkflowRequest()
new_test_workflow_request.from_json(test_workflow_request)
results =WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request)
new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request)
results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request)
print("The response of WorkflowsApi->test_workflow:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e)
```