Skip to content

incident_io_client.api.incidents_v2.incidents_v2_show

asyncio async 

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

Show Incidents V2

Get a single incident.

The ID supplied can be either the incident's full ID, or the numeric part of its reference. For example, to get INC-123, you could use either its full ID or:

        curl \
                --get 'https://api.incident.io/v2/incidents/123

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[IncidentsV2ShowResponseBody]

IncidentsV2ShowResponseBody
Source code in incident_io_client/api/incidents_v2/incidents_v2_show.py 
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
async def asyncio(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[IncidentsV2ShowResponseBody]:
    r""" Show Incidents V2

     Get a single incident.

    The ID supplied can be either the incident's full ID, or the numeric part of its
    reference. For example, to get INC-123, you could use either its full ID or:

    		curl \
    			--get 'https://api.incident.io/v2/incidents/123

    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:
        IncidentsV2ShowResponseBody
     """

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

asyncio_detailed async 

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

Show Incidents V2

Get a single incident.

The ID supplied can be either the incident's full ID, or the numeric part of its reference. For example, to get INC-123, you could use either its full ID or:

        curl \
                --get 'https://api.incident.io/v2/incidents/123

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[IncidentsV2ShowResponseBody]

Response[IncidentsV2ShowResponseBody]
Source code in incident_io_client/api/incidents_v2/incidents_v2_show.py 
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
async def asyncio_detailed(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[IncidentsV2ShowResponseBody]:
    r""" Show Incidents V2

     Get a single incident.

    The ID supplied can be either the incident's full ID, or the numeric part of its
    reference. For example, to get INC-123, you could use either its full ID or:

    		curl \
    			--get 'https://api.incident.io/v2/incidents/123

    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[IncidentsV2ShowResponseBody]
     """

    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[IncidentsV2ShowResponseBody]

Show Incidents V2

Get a single incident.

The ID supplied can be either the incident's full ID, or the numeric part of its reference. For example, to get INC-123, you could use either its full ID or:

        curl \
                --get 'https://api.incident.io/v2/incidents/123

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[IncidentsV2ShowResponseBody]

IncidentsV2ShowResponseBody
Source code in incident_io_client/api/incidents_v2/incidents_v2_show.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
def sync(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[IncidentsV2ShowResponseBody]:
    r""" Show Incidents V2

     Get a single incident.

    The ID supplied can be either the incident's full ID, or the numeric part of its
    reference. For example, to get INC-123, you could use either its full ID or:

    		curl \
    			--get 'https://api.incident.io/v2/incidents/123

    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:
        IncidentsV2ShowResponseBody
     """

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

sync_detailed 

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

Show Incidents V2

Get a single incident.

The ID supplied can be either the incident's full ID, or the numeric part of its reference. For example, to get INC-123, you could use either its full ID or:

        curl \
                --get 'https://api.incident.io/v2/incidents/123

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[IncidentsV2ShowResponseBody]

Response[IncidentsV2ShowResponseBody]
Source code in incident_io_client/api/incidents_v2/incidents_v2_show.py 
49
50
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
80
81
82
83
def sync_detailed(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[IncidentsV2ShowResponseBody]:
    r""" Show Incidents V2

     Get a single incident.

    The ID supplied can be either the incident's full ID, or the numeric part of its
    reference. For example, to get INC-123, you could use either its full ID or:

    		curl \
    			--get 'https://api.incident.io/v2/incidents/123

    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[IncidentsV2ShowResponseBody]
     """

    kwargs = _get_kwargs(
        id=id,
    )

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

    return _build_response(client=client, response=response)