Skip to content

Latest commit

 

History

History
168 lines (119 loc) · 7.72 KB

UserIdentifiersApi.md

File metadata and controls

168 lines (119 loc) · 7.72 KB

gooddata_api_client.UserIdentifiersApi

All URIs are relative to http://localhost

Method HTTP request Description
get_all_entities_user_identifiers GET /api/v1/entities/userIdentifiers Get UserIdentifier entities
get_entity_user_identifiers GET /api/v1/entities/userIdentifiers/{id} Get UserIdentifier entity

get_all_entities_user_identifiers

JsonApiUserIdentifierOutList get_all_entities_user_identifiers()

Get UserIdentifier entities

UserIdentifier - represents entity interacting with platform

Example

import time
import gooddata_api_client
from gooddata_api_client.api import user_identifiers_api
from gooddata_api_client.model.json_api_user_identifier_out_list import JsonApiUserIdentifierOutList
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_identifiers_api.UserIdentifiersApi(api_client)
    filter = "filter=firstname==someString;lastname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional)
    page = 0 # int | Zero-based page index (0..N) (optional) if omitted the server will use the default value of 0
    size = 20 # int | The size of the page to be returned (optional) if omitted the server will use the default value of 20
    sort = [
        "sort_example",
    ] # [str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional)
    meta_include = [
        "metaInclude=page,all",
    ] # [str] | Include Meta objects. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get UserIdentifier entities
        api_response = api_instance.get_all_entities_user_identifiers(filter=filter, page=page, size=size, sort=sort, meta_include=meta_include)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling UserIdentifiersApi->get_all_entities_user_identifiers: %s\n" % e)

Parameters

Name Type Description Notes
filter str Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). [optional]
page int Zero-based page index (0..N) [optional] if omitted the server will use the default value of 0
size int The size of the page to be returned [optional] if omitted the server will use the default value of 20
sort [str] Sorting criteria in the format: property,(asc desc). Default sort order is ascending. Multiple sort criteria are supported.
meta_include [str] Include Meta objects. [optional]

Return type

JsonApiUserIdentifierOutList

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.gooddata.api+json

HTTP response details

Status code Description Response headers
200 Request successfully processed -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_entity_user_identifiers

JsonApiUserIdentifierOutDocument get_entity_user_identifiers(id)

Get UserIdentifier entity

UserIdentifier - represents basic information about entity interacting with platform

Example

import time
import gooddata_api_client
from gooddata_api_client.api import user_identifiers_api
from gooddata_api_client.model.json_api_user_identifier_out_document import JsonApiUserIdentifierOutDocument
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = gooddata_api_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with gooddata_api_client.ApiClient() as api_client:
    # Create an instance of the API class
    api_instance = user_identifiers_api.UserIdentifiersApi(api_client)
    id = "/6bUUGjjNSwg0_bs" # str | 
    filter = "filter=firstname==someString;lastname==someString" # str | Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get UserIdentifier entity
        api_response = api_instance.get_entity_user_identifiers(id)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling UserIdentifiersApi->get_entity_user_identifiers: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get UserIdentifier entity
        api_response = api_instance.get_entity_user_identifiers(id, filter=filter)
        pprint(api_response)
    except gooddata_api_client.ApiException as e:
        print("Exception when calling UserIdentifiersApi->get_entity_user_identifiers: %s\n" % e)

Parameters

Name Type Description Notes
id str
filter str Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title=='Some Title';description=='desc'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty=='Value 123'). [optional]

Return type

JsonApiUserIdentifierOutDocument

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.gooddata.api+json

HTTP response details

Status code Description Response headers
200 Request successfully processed -

[Back to top] [Back to API list] [Back to Model list] [Back to README]