RepliconClient
Attributes
TRIGGER_OPERATIONS
module-attribute
TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'WebhookSubscriptionsRestAPI': {'operation_id': 'WebhookSubscriptionsRestAPI', 'path': '/{connectionId}/webhook-api/api/subscription', 'method': 'post', 'required_parameters': ['hostUrl', 'body'], 'callback_payload_type': 'WebhookSubscriptionResponse'}}
Classes
BulkGetProjectDetails3Input
dataclass
ProjectDetailsResponse
dataclass
CreateProjectOrApplyModificationsInput
dataclass
CreateProjectOrApplyModificationsInput(*, target: Optional[Dict[str, Any]] = None, modifications: Optional[Dict[str, Any]] = None, project_modification_option_uri: Optional[str] = None, unit_of_work_id: Optional[str] = None)
Create Project Or Apply Modifications
Attributes
target
class-attribute
instance-attribute
project target
modifications
class-attribute
instance-attribute
modifications
CreateProjectOrApplyModificationsResponse
dataclass
UserListServiceGetDataInput
dataclass
UserListServiceGetDataInput(*, page: Optional[str] = None, pagesize: Optional[str] = None, column_uris: Optional[List[str]] = None, sort: Optional[List[Any]] = None, filter_expression: Optional[Dict[str, Any]] = None)
Get User List
Attributes
page
class-attribute
instance-attribute
page
pagesize
class-attribute
instance-attribute
page size
column_uris
class-attribute
instance-attribute
column_uris: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'columnUris'})
column uris
sort
class-attribute
instance-attribute
sort
UserListServiceGetDataResponse
dataclass
GetDescendantTaskDetailsInput
dataclass
GetDescendantTaskDetailsResponse
dataclass
CreateTaskHierarchyOrApplyModificationsInput
dataclass
CreateTaskHierarchyOrApplyModificationsInput(*, project: Optional[Dict[str, Any]] = None, task_hierarchy: Optional[List[Dict[str, Any]]] = None, task_modification_option_uri: Optional[str] = None, unit_of_work_id: Optional[str] = None)
Create Task Hierarchy Or Apply Modifications
Attributes
project
class-attribute
instance-attribute
project
task_hierarchy
class-attribute
instance-attribute
task_hierarchy: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'taskHierarchy'})
task hierarchy
CreateTaskHierarchyOrApplyModificationsResponse
dataclass
MoveTaskInput
dataclass
MoveTaskInput(*, task_uri: Optional[str] = None, target_uri: Optional[str] = None, move_task_method_uri: Optional[str] = None)
Move Task
Attributes
task_uri
class-attribute
instance-attribute
task_uri: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'taskUri'})
task uri
TaskListServiceGetDataInput
dataclass
TaskListServiceGetDataInput(*, page: Optional[str] = None, pagesize: Optional[str] = None, column_uris: Optional[List[str]] = None, sort: Optional[List[Any]] = None, filter_expression: Optional[Dict[str, Any]] = None)
Task List Service Get Data
Attributes
page
class-attribute
instance-attribute
page
pagesize
class-attribute
instance-attribute
page size
column_uris
class-attribute
instance-attribute
column_uris: Optional[List[str]] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'columnUris'})
column uris
sort
class-attribute
instance-attribute
sort
TaskListServiceGetDataResponse
dataclass
GetTimesheetSummaryInput
dataclass
GetTimesheetSummaryResponse
dataclass
BulkGetTimeEnteredSummaryInput
dataclass
BulkGetTimeEnteredSummaryResponse
dataclass
WebhookSubscriptionsRestAPIInput
dataclass
WebhookSubscriptionResponse
dataclass
WebhookSubscriptionResponse(*, id: Optional[str] = None, created_timestamp: Optional[str] = None, updated_timestamp: Optional[str] = None, event_type: Optional[str] = None, target_url: Optional[str] = None, shared_secret: Optional[str] = None, auth_type: Optional[str] = None)
Response for Subscribe to Event triggers
Attributes
id
class-attribute
instance-attribute
identity of the webhook event
created_timestamp
class-attribute
instance-attribute
created_timestamp: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'createdTimestamp'})
created time stamp of the webhook event
updated_timestamp
class-attribute
instance-attribute
updated_timestamp: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'updatedTimestamp'})
updated time stamp of the webhook event
event_type
class-attribute
instance-attribute
event_type: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'eventType'})
event Type of the webhook event
target_url
class-attribute
instance-attribute
target_url: Optional[str] = dataclass_field(default=None, kw_only=True, metadata={'wire_name': 'targetUrl'})
target Url of the webhook event
PutProjectTeamMemberAssignmentsInput
dataclass
PutProjectTeamMemberAssignmentsInput(*, project_uri: Optional[str] = None, resource_uris: Optional[List[str]] = None)
PutResourceAssignmentsInput
dataclass
PutResourceAssignmentsInput(*, task_uri: Optional[str] = None, resource_uris: Optional[List[str]] = None)
TenantEndpointDetails
dataclass
Date
dataclass
Definition: Date
Attributes
day
class-attribute
instance-attribute
day
month
class-attribute
instance-attribute
month
Duration
dataclass
Duration(*, hours: Optional[int] = None, microseconds: Optional[int] = None, milliseconds: Optional[int] = None, minutes: Optional[int] = None, seconds: Optional[int] = None)
Definition: Duration
Attributes
hours
class-attribute
instance-attribute
hours
microseconds
class-attribute
instance-attribute
microseconds
milliseconds
class-attribute
instance-attribute
milliseconds
minutes
class-attribute
instance-attribute
minutes
RepliconClient
RepliconClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)
Bases: ConnectorClientBase
Typed client for replicon connector.
Initialize a RepliconClient.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
connection_runtime_url
|
str
|
The connection runtime URL from Azure Portal. |
required |
credential
|
AsyncTokenCredential | AzureKeyCredential
|
Caller-owned Azure Core credential. |
required |
max_retry_attempts
|
int
|
The maximum number of request attempts. |
3
|
timeout
|
float
|
The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines. |
30.0
|
use_exponential_backoff
|
bool
|
Whether retries use exponential backoff. |
True
|
initial_retry_delay_seconds
|
float
|
The initial retry delay in seconds. |
0.5
|
maximum_retry_delay_seconds
|
float
|
The maximum retry delay in seconds. |
120.0
|
retry_jitter_factor
|
float
|
The jitter fraction applied to retry delays. |
0.1
|
retry_unsafe_http_methods
|
bool
|
Whether unsafe HTTP methods may be retried. |
False
|
transport
|
Optional[AsyncHttpTransport]
|
Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle. |
None
|
**kwargs
|
Any
|
Optional Azure Core pipeline policy settings. |
{}
|
Methods:
bulk_get_project_details3
async
bulk_get_project_details3(input: BulkGetProjectDetails3Input | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get Project Details
Get the project details from Replicon
Swagger operation ID: BulkGetProjectDetails3.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
BulkGetProjectDetails3Input | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
host_url
|
str
|
Replicon Host Url. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
create_project_or_apply_modifications
async
create_project_or_apply_modifications(input: CreateProjectOrApplyModificationsInput | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create Project Or Apply Modifications
Create Project Or Apply Modifications in Replicon
Swagger operation ID: CreateProjectOrApplyModifications.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateProjectOrApplyModificationsInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
host_url
|
str
|
Replicon Host Url. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
user_list_service_get_data
async
user_list_service_get_data(input: UserListServiceGetDataInput | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get User List
Get User List Data from Replicon
Swagger operation ID: UserListServiceGetData.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UserListServiceGetDataInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
host_url
|
str
|
Replicon Host Url. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
get_descendant_task_details
async
get_descendant_task_details(input: GetDescendantTaskDetailsInput | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get Descendant Task Details
Get Hierarchial Task Details from Replicon
Swagger operation ID: GetDescendantTaskDetails.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetDescendantTaskDetailsInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
host_url
|
str
|
Replicon Host Url. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
create_task_hierarchy_or_apply_modifications
async
create_task_hierarchy_or_apply_modifications(input: CreateTaskHierarchyOrApplyModificationsInput | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Create Task Hierarchy Or Apply Modifications
Create Task Hierarchy Or Apply Modifications to a Replicon Task
Swagger operation ID: CreateTaskHierarchyOrApplyModifications.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateTaskHierarchyOrApplyModificationsInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
host_url
|
str
|
Replicon Host Url. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
move_task
async
move_task(input: MoveTaskInput | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Move Task
Move Task to a new Parent
Swagger operation ID: MoveTask.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
MoveTaskInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
host_url
|
str
|
Replicon Host Url. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
task_list_service_get_data
async
task_list_service_get_data(input: TaskListServiceGetDataInput | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Task List Service Get Data
Get Task List Service Data From Replicon
Swagger operation ID: TaskListServiceGetData.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
TaskListServiceGetDataInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
host_url
|
str
|
Replicon Host Url. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
get_timesheet_summary
async
get_timesheet_summary(input: GetTimesheetSummaryInput | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get Timesheet Summary
Get Timesheet Summary from Replicon
Swagger operation ID: GetTimesheetSummary.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetTimesheetSummaryInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
host_url
|
str
|
Replicon Host Url. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
bulk_get_time_entered_summary
async
bulk_get_time_entered_summary(input: BulkGetTimeEnteredSummaryInput | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get Time Entered Summary
Get Time Entered by Task Uri from Replicon
Swagger operation ID: BulkGetTimeEnteredSummary.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
BulkGetTimeEnteredSummaryInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
host_url
|
str
|
Replicon Host Url. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
put_project_team_member_assignments
async
put_project_team_member_assignments(input: PutProjectTeamMemberAssignmentsInput | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Put Project Team Member Assignments
Rewrite Team Member assignment of Project
Swagger operation ID: PutProjectTeamMemberAssignments.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PutProjectTeamMemberAssignmentsInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
host_url
|
str
|
Replicon Host Url. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
put_resource_assignments
async
put_resource_assignments(input: PutResourceAssignmentsInput | Mapping[str, Any], host_url: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None
Rewrite Resource Assignment of a task
Update the Resource assignment to a specified task
Swagger operation ID: PutResourceAssignments.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PutResourceAssignmentsInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
host_url
|
str
|
Replicon Host Url. |
required |
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
None |
None
|
The operation completes without a response body. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
get_my_tenant_endpoint_details
async
get_my_tenant_endpoint_details(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None
Get Tenant End Point Details
Get End Point Details of the Tenant
Swagger operation ID: GetMyTenantEndpointDetails.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
timeout
|
Optional[float]
|
The request timeout in seconds. |
None
|
headers
|
Optional[Mapping[str, str]]
|
Additional HTTP request headers. |
None
|
client_request_id
|
Optional[str]
|
A caller-provided request identifier. |
None
|
response_hook
|
Optional[ConnectorResponseHook]
|
A callback invoked with the connector response. |
None
|
Returns:
| Type | Description |
|---|---|
dict[str, Any] | None
|
dict[str, Any] | None: The connector operation result. |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |