mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 04:19:42 +00:00
Update Go SDK docs: 16676109714
This commit is contained in:
@@ -24,6 +24,7 @@ Method | HTTP request | Description
|
||||
[**get-workflow**](#get-workflow) | **Get** `/workflows/{id}` | Get workflow by id
|
||||
[**get-workflow-execution**](#get-workflow-execution) | **Get** `/workflow-executions/{id}` | Get workflow execution
|
||||
[**get-workflow-execution-history**](#get-workflow-execution-history) | **Get** `/workflow-executions/{id}/history` | Get workflow execution history
|
||||
[**get-workflow-execution-history-v2**](#get-workflow-execution-history-v2) | **Get** `/workflow-executions/{id}/history-v2` | Get updated workflow execution history
|
||||
[**get-workflow-executions**](#get-workflow-executions) | **Get** `/workflows/{id}/executions` | List workflow executions
|
||||
[**list-complete-workflow-library**](#list-complete-workflow-library) | **Get** `/workflow-library` | List complete workflow library
|
||||
[**list-workflow-library-actions**](#list-workflow-library-actions) | **Get** `/workflow-library/actions` | List workflow library actions
|
||||
@@ -565,6 +566,72 @@ func main() {
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-workflow-execution-history-v2
|
||||
Get updated workflow execution history
|
||||
Gets a workflow execution history, trigger input, and workflow definition of a single workflow execution. Workflow executions are available for up to 90 days before being archived. If you attempt to access a workflow execution that has been archived, you will receive a 404 Not Found.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-workflow-execution-history-v2)
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
|
||||
**id** | **string** | Id of the workflow execution |
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiGetWorkflowExecutionHistoryV2Request struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
[**WorkflowExecutionHistory**](../models/workflow-execution-history)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
|
||||
|
||||
sailpoint "github.com/sailpoint-oss/golang-sdk/v2"
|
||||
)
|
||||
|
||||
func main() {
|
||||
id := `c17bea3a-574d-453c-9e04-4365fbf5af0b` // string | Id of the workflow execution # string | Id of the workflow execution
|
||||
|
||||
|
||||
|
||||
configuration := sailpoint.NewDefaultConfiguration()
|
||||
apiClient := sailpoint.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.V2025.WorkflowsAPI.GetWorkflowExecutionHistoryV2(context.Background(), id).Execute()
|
||||
//resp, r, err := apiClient.V2025.WorkflowsAPI.GetWorkflowExecutionHistoryV2(context.Background(), id).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `WorkflowsAPI.GetWorkflowExecutionHistoryV2``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `GetWorkflowExecutionHistoryV2`: WorkflowExecutionHistory
|
||||
fmt.Fprintf(os.Stdout, "Response from `WorkflowsAPI.GetWorkflowExecutionHistoryV2`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-workflow-executions
|
||||
List workflow executions
|
||||
Use this API to list a specified workflow's executions. Workflow executions are available for up to 90 days before being archived. By default, you can get a maximum of 250 executions. To get executions past the first 250 records, you can do the following:
|
||||
|
||||
@@ -0,0 +1,116 @@
|
||||
---
|
||||
id: v2025-workflow-execution-history
|
||||
title: WorkflowExecutionHistory
|
||||
pagination_label: WorkflowExecutionHistory
|
||||
sidebar_label: WorkflowExecutionHistory
|
||||
sidebar_class_name: gosdk
|
||||
keywords: ['go', 'Golang', 'sdk', 'WorkflowExecutionHistory', 'V2025WorkflowExecutionHistory']
|
||||
slug: /tools/sdk/go/v2025/models/workflow-execution-history
|
||||
tags: ['SDK', 'Software Development Kit', 'WorkflowExecutionHistory', 'V2025WorkflowExecutionHistory']
|
||||
---
|
||||
|
||||
# WorkflowExecutionHistory
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Definition** | Pointer to **map[string]interface{}** | The workflow definition for the workflow execution | [optional]
|
||||
**History** | Pointer to **map[string]interface{}** | List of workflow execution events for the given workflow execution | [optional]
|
||||
**Trigger** | Pointer to **map[string]interface{}** | The trigger that initiated the workflow execution | [optional]
|
||||
|
||||
## Methods
|
||||
|
||||
### NewWorkflowExecutionHistory
|
||||
|
||||
`func NewWorkflowExecutionHistory() *WorkflowExecutionHistory`
|
||||
|
||||
NewWorkflowExecutionHistory instantiates a new WorkflowExecutionHistory object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewWorkflowExecutionHistoryWithDefaults
|
||||
|
||||
`func NewWorkflowExecutionHistoryWithDefaults() *WorkflowExecutionHistory`
|
||||
|
||||
NewWorkflowExecutionHistoryWithDefaults instantiates a new WorkflowExecutionHistory object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetDefinition
|
||||
|
||||
`func (o *WorkflowExecutionHistory) GetDefinition() map[string]interface{}`
|
||||
|
||||
GetDefinition returns the Definition field if non-nil, zero value otherwise.
|
||||
|
||||
### GetDefinitionOk
|
||||
|
||||
`func (o *WorkflowExecutionHistory) GetDefinitionOk() (*map[string]interface{}, bool)`
|
||||
|
||||
GetDefinitionOk returns a tuple with the Definition field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetDefinition
|
||||
|
||||
`func (o *WorkflowExecutionHistory) SetDefinition(v map[string]interface{})`
|
||||
|
||||
SetDefinition sets Definition field to given value.
|
||||
|
||||
### HasDefinition
|
||||
|
||||
`func (o *WorkflowExecutionHistory) HasDefinition() bool`
|
||||
|
||||
HasDefinition returns a boolean if a field has been set.
|
||||
|
||||
### GetHistory
|
||||
|
||||
`func (o *WorkflowExecutionHistory) GetHistory() map[string]interface{}`
|
||||
|
||||
GetHistory returns the History field if non-nil, zero value otherwise.
|
||||
|
||||
### GetHistoryOk
|
||||
|
||||
`func (o *WorkflowExecutionHistory) GetHistoryOk() (*map[string]interface{}, bool)`
|
||||
|
||||
GetHistoryOk returns a tuple with the History field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetHistory
|
||||
|
||||
`func (o *WorkflowExecutionHistory) SetHistory(v map[string]interface{})`
|
||||
|
||||
SetHistory sets History field to given value.
|
||||
|
||||
### HasHistory
|
||||
|
||||
`func (o *WorkflowExecutionHistory) HasHistory() bool`
|
||||
|
||||
HasHistory returns a boolean if a field has been set.
|
||||
|
||||
### GetTrigger
|
||||
|
||||
`func (o *WorkflowExecutionHistory) GetTrigger() map[string]interface{}`
|
||||
|
||||
GetTrigger returns the Trigger field if non-nil, zero value otherwise.
|
||||
|
||||
### GetTriggerOk
|
||||
|
||||
`func (o *WorkflowExecutionHistory) GetTriggerOk() (*map[string]interface{}, bool)`
|
||||
|
||||
GetTriggerOk returns a tuple with the Trigger field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetTrigger
|
||||
|
||||
`func (o *WorkflowExecutionHistory) SetTrigger(v map[string]interface{})`
|
||||
|
||||
SetTrigger sets Trigger field to given value.
|
||||
|
||||
### HasTrigger
|
||||
|
||||
`func (o *WorkflowExecutionHistory) HasTrigger() bool`
|
||||
|
||||
HasTrigger returns a boolean if a field has been set.
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'WorkflowTrigger', 'V2025WorkflowTrigg
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **string** | The trigger type |
|
||||
**DisplayName** | Pointer to **NullableString** | | [optional]
|
||||
**DisplayName** | Pointer to **NullableString** | The trigger display name | [optional]
|
||||
**Attributes** | **map[string]interface{}** | Workflow Trigger Attributes. |
|
||||
|
||||
## Methods
|
||||
|
||||
Reference in New Issue
Block a user