eZmaxApi.ObjectUserstagedApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method	HTTP request	Description
userstaged_create_user_v1	POST /1/object/userstaged/{pkiUserstagedID}/createUser	Create a User from a Userstaged and then map it
userstaged_delete_object_v1	DELETE /1/object/userstaged/{pkiUserstagedID}	Delete an existing Userstaged
userstaged_get_list_v1	GET /1/object/userstaged/getList	Retrieve Userstaged list
userstaged_get_object_v2	GET /2/object/userstaged/{pkiUserstagedID}	Retrieve an existing Userstaged
userstaged_map_v1	POST /1/object/userstaged/{pkiUserstagedID}/map	Map the Userstaged to an existing user

userstaged_create_user_v1

UserstagedCreateUserV1Response userstaged_create_user_v1(pki_userstaged_id, body)

Create a User from a Userstaged and then map it

Default values will be used while creating the User. If you need to change those values, you should use the route to edit a User.

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.userstaged_create_user_v1_response import UserstagedCreateUserV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectUserstagedApi(api_client)
    pki_userstaged_id = 56 # int | 
    body = None # object | 

    try:
        # Create a User from a Userstaged and then map it
        api_response = api_instance.userstaged_create_user_v1(pki_userstaged_id, body)
        print("The response of ObjectUserstagedApi->userstaged_create_user_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectUserstagedApi->userstaged_create_user_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_userstaged_id	int
body	object

Return type

UserstagedCreateUserV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

userstaged_delete_object_v1

UserstagedDeleteObjectV1Response userstaged_delete_object_v1(pki_userstaged_id)

Delete an existing Userstaged

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.userstaged_delete_object_v1_response import UserstagedDeleteObjectV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectUserstagedApi(api_client)
    pki_userstaged_id = 56 # int | 

    try:
        # Delete an existing Userstaged
        api_response = api_instance.userstaged_delete_object_v1(pki_userstaged_id)
        print("The response of ObjectUserstagedApi->userstaged_delete_object_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectUserstagedApi->userstaged_delete_object_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_userstaged_id	int

Return type

UserstagedDeleteObjectV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

userstaged_get_list_v1

UserstagedGetListV1Response userstaged_get_list_v1(e_order_by=e_order_by, i_row_max=i_row_max, i_row_offset=i_row_offset, accept_language=accept_language, s_filter=s_filter)

Retrieve Userstaged list

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.header_accept_language import HeaderAcceptLanguage
from eZmaxApi.models.userstaged_get_list_v1_response import UserstagedGetListV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectUserstagedApi(api_client)
    e_order_by = 'e_order_by_example' # str | Specify how you want the results to be sorted (optional)
    i_row_max = 56 # int |  (optional)
    i_row_offset = 0 # int |  (optional) (default to 0)
    accept_language = eZmaxApi.HeaderAcceptLanguage() # HeaderAcceptLanguage |  (optional)
    s_filter = 's_filter_example' # str |  (optional)

    try:
        # Retrieve Userstaged list
        api_response = api_instance.userstaged_get_list_v1(e_order_by=e_order_by, i_row_max=i_row_max, i_row_offset=i_row_offset, accept_language=accept_language, s_filter=s_filter)
        print("The response of ObjectUserstagedApi->userstaged_get_list_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectUserstagedApi->userstaged_get_list_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
e_order_by	str	Specify how you want the results to be sorted	[optional]
i_row_max	int		[optional]
i_row_offset	int		[optional] [default to 0]
accept_language	HeaderAcceptLanguage		[optional]
s_filter	str		[optional]

Return type

UserstagedGetListV1Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

HTTP response details

Status code	Description	Response headers
200	Successful response	-
406	The URL is valid, but one of the Accept header is not defined or invalid. For example, you set the header "Accept: application/json" but the function can only return "Content-type: image/png"	-

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

userstaged_get_object_v2

UserstagedGetObjectV2Response userstaged_get_object_v2(pki_userstaged_id)

Retrieve an existing Userstaged

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.userstaged_get_object_v2_response import UserstagedGetObjectV2Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectUserstagedApi(api_client)
    pki_userstaged_id = 56 # int | 

    try:
        # Retrieve an existing Userstaged
        api_response = api_instance.userstaged_get_object_v2(pki_userstaged_id)
        print("The response of ObjectUserstagedApi->userstaged_get_object_v2:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectUserstagedApi->userstaged_get_object_v2: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_userstaged_id	int

Return type

UserstagedGetObjectV2Response

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-

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

userstaged_map_v1

UserstagedMapV1Response userstaged_map_v1(pki_userstaged_id, userstaged_map_v1_request)

Map the Userstaged to an existing user

Example

Api Key Authentication (Authorization):

import eZmaxApi
from eZmaxApi.models.userstaged_map_v1_request import UserstagedMapV1Request
from eZmaxApi.models.userstaged_map_v1_response import UserstagedMapV1Response
from eZmaxApi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
# See configuration.py for a list of all supported configuration parameters.
configuration = eZmaxApi.Configuration(
    host = "https://prod.api.appcluster01.ca-central-1.ezmax.com/rest"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: Authorization
configuration.api_key['Authorization'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Enter a context with an instance of the API client
with eZmaxApi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = eZmaxApi.ObjectUserstagedApi(api_client)
    pki_userstaged_id = 56 # int | 
    userstaged_map_v1_request = eZmaxApi.UserstagedMapV1Request() # UserstagedMapV1Request | 

    try:
        # Map the Userstaged to an existing user
        api_response = api_instance.userstaged_map_v1(pki_userstaged_id, userstaged_map_v1_request)
        print("The response of ObjectUserstagedApi->userstaged_map_v1:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ObjectUserstagedApi->userstaged_map_v1: %s\n" % e)

Parameters

Name	Type	Description	Notes
pki_userstaged_id	int
userstaged_map_v1_request	UserstagedMapV1Request

Return type

UserstagedMapV1Response

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful response	-
404	The request failed. The element on which you were trying to work does not exists. Look for detail about the error in the body	-
422	The request was syntactically valid but failed because of an interdependance condition. Look for detail about the error in the body	-

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

Files

ObjectUserstagedApi.md

Latest commit

History

ObjectUserstagedApi.md

File metadata and controls

eZmaxApi.ObjectUserstagedApi

userstaged_create_user_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

userstaged_delete_object_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

userstaged_get_list_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

userstaged_get_object_v2

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

userstaged_map_v1

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details