Skip to content

incident_io_client.api.workflows_v2.workflows_v2_show_workflow

asyncio async 

asyncio(
    id: str, *, client: Union[AuthenticatedClient, Client]
) -> Optional[WorkflowsV2ShowWorkflowResponseBody]

ShowWorkflow Workflows V2

Show a workflow by ID

Parameters:

Name Type Description Default
id str
required

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Optional[WorkflowsV2ShowWorkflowResponseBody]

WorkflowsV2ShowWorkflowResponseBody
Source code in incident_io_client/api/workflows_v2/workflows_v2_show_workflow.py 
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
async def asyncio(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[WorkflowsV2ShowWorkflowResponseBody]:
    """ShowWorkflow Workflows V2

     Show a workflow by ID

    Args:
        id (str):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        WorkflowsV2ShowWorkflowResponseBody
    """

    return (
        await asyncio_detailed(
            id=id,
            client=client,
        )
    ).parsed

asyncio_detailed async 

asyncio_detailed(
    id: str, *, client: Union[AuthenticatedClient, Client]
) -> Response[WorkflowsV2ShowWorkflowResponseBody]

ShowWorkflow Workflows V2

Show a workflow by ID

Parameters:

Name Type Description Default
id str
required

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[WorkflowsV2ShowWorkflowResponseBody]

Response[WorkflowsV2ShowWorkflowResponseBody]
Source code in incident_io_client/api/workflows_v2/workflows_v2_show_workflow.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
async def asyncio_detailed(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[WorkflowsV2ShowWorkflowResponseBody]:
    """ShowWorkflow Workflows V2

     Show a workflow by ID

    Args:
        id (str):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[WorkflowsV2ShowWorkflowResponseBody]
    """

    kwargs = _get_kwargs(
        id=id,
    )

    response = await client.get_async_httpx_client().request(**kwargs)

    return _build_response(client=client, response=response)

sync 

sync(
    id: str, *, client: Union[AuthenticatedClient, Client]
) -> Optional[WorkflowsV2ShowWorkflowResponseBody]

ShowWorkflow Workflows V2

Show a workflow by ID

Parameters:

Name Type Description Default
id str
required

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Optional[WorkflowsV2ShowWorkflowResponseBody]

WorkflowsV2ShowWorkflowResponseBody
Source code in incident_io_client/api/workflows_v2/workflows_v2_show_workflow.py 
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
def sync(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[WorkflowsV2ShowWorkflowResponseBody]:
    """ShowWorkflow Workflows V2

     Show a workflow by ID

    Args:
        id (str):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        WorkflowsV2ShowWorkflowResponseBody
    """

    return sync_detailed(
        id=id,
        client=client,
    ).parsed

sync_detailed 

sync_detailed(
    id: str, *, client: Union[AuthenticatedClient, Client]
) -> Response[WorkflowsV2ShowWorkflowResponseBody]

ShowWorkflow Workflows V2

Show a workflow by ID

Parameters:

Name Type Description Default
id str
required

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[WorkflowsV2ShowWorkflowResponseBody]

Response[WorkflowsV2ShowWorkflowResponseBody]
Source code in incident_io_client/api/workflows_v2/workflows_v2_show_workflow.py 
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
def sync_detailed(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[WorkflowsV2ShowWorkflowResponseBody]:
    """ShowWorkflow Workflows V2

     Show a workflow by ID

    Args:
        id (str):

    Raises:
        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
        httpx.TimeoutException: If the request takes longer than Client.timeout.

    Returns:
        Response[WorkflowsV2ShowWorkflowResponseBody]
    """

    kwargs = _get_kwargs(
        id=id,
    )

    response = client.get_httpx_client().request(
        **kwargs,
    )

    return _build_response(client=client, response=response)