ConnectCases / Client / get_case

get_case#

ConnectCases.Client.get_case(**kwargs)#

Returns information about a specific case if it exists.

See also: AWS API Documentation

Request Syntax

response = client.get_case(
    caseId='string',
    domainId='string',
    fields=[
        {
            'id': 'string'
        },
    ],
    nextToken='string'
)
Parameters:

  • caseId (string) –

    [REQUIRED]

    A unique identifier of the case.

  • domainId (string) –

    [REQUIRED]

    The unique identifier of the Cases domain.

  • fields (list) –

    [REQUIRED]

    A list of unique field identifiers.

    • (dict) –

      Object for unique identifier of a field.

      • id (string) – [REQUIRED]

        Unique identifier of a field.

  • nextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'fields': [
        {
            'id': 'string',
            'value': {
                'booleanValue': True|False,
                'doubleValue': 123.0,
                'emptyValue': {},
                'stringValue': 'string',
                'userArnValue': 'string'
            }
        },
    ],
    'nextToken': 'string',
    'tags': {
        'string': 'string'
    },
    'templateId': 'string'
}

Response Structure

  • (dict) –

    • fields (list) –

      A list of detailed field information.

      • (dict) –

        Object for case field values.

        • id (string) –

          Unique identifier of a field.

        • value (dict) –

          Union of potential field value types.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: booleanValue, doubleValue, emptyValue, stringValue, userArnValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

          'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

          • booleanValue (boolean) –

            Can be either null, or have a Boolean value type. Only one value can be provided.

          • doubleValue (float) –

            Can be either null, or have a Double number value type. Only one value can be provided.

          • emptyValue (dict) –

            An empty value.

          • stringValue (string) –

            String value type.

          • userArnValue (string) –

            Represents the user that performed the audit.

    • nextToken (string) –

      The token for the next set of results. This is null if there are no more results to return.

    • tags (dict) –

      A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

      • (string) –

        • (string) –

    • templateId (string) –

      A unique identifier of a template.

Exceptions