Bitrix API

RestService extends IRestService

Table of Contents

Constants

ERROR_ACTIVITY_ADD_FAILURE  = 'ERROR_ACTIVITY_ADD_FAILURE'
ERROR_ACTIVITY_ALREADY_INSTALLED  = 'ERROR_ACTIVITY_ALREADY_INSTALLED'
ERROR_ACTIVITY_NOT_FOUND  = 'ERROR_ACTIVITY_NOT_FOUND'
ERROR_ACTIVITY_VALIDATION_FAILURE  = 'ERROR_ACTIVITY_VALIDATION_FAILURE'
ERROR_DELEGATION_NOT_ALLOWED  = 'ERROR_DELEGATION_NOT_ALLOWED'
ERROR_EMPTY_LOG_MESSAGE  = 'ERROR_EMPTY_LOG_MESSAGE'
ERROR_INVALID_USER_ID  = 'ERROR_INVALID_USER_ID'
ERROR_SELECT_VALIDATION_FAILURE  = 'ERROR_SELECT_VALIDATION_FAILURE'
ERROR_TASK_COMPLETED  = 'ERROR_TASK_COMPLETED'
ERROR_TASK_EXECUTION  = 'ERROR_TASK_EXECUTION'
ERROR_TASK_NOT_FOUND  = 'ERROR_TASK_NOT_FOUND'
ERROR_TASK_TYPE  = 'ERROR_TASK_TYPE'
ERROR_TASK_VALIDATION  = 'ERROR_TASK_VALIDATION'
ERROR_TEMPLATE_NOT_FOUND  = 'ERROR_TEMPLATE_NOT_FOUND'
ERROR_TEMPLATE_NOT_OWNER  = 'ERROR_TEMPLATE_NOT_OWNER'
ERROR_TEMPLATE_VALIDATION_FAILURE  = 'ERROR_TEMPLATE_VALIDATION_FAILURE'
ERROR_WRONG_WORKFLOW_ID  = 'ERROR_WRONG_WORKFLOW_ID'
PLACEMENT_ACTIVITY_PROPERTIES_DIALOG  = 'BIZPROC_ACTIVITY_PROPERTIES_DIALOG'
SCOPE  = 'bizproc'

Methods

addActivity()  : bool
addProvider()  : bool
addRobot()  : bool
addWorkflowTemplate()  : bool
completeTask()  : bool
delegateTask()  : mixed
deleteActivity()  : bool
deleteProvider()  : bool
deleteRobot()  : bool
deleteWorkflowTemplate()  : bool
getActivityList()  : array<string|int, mixed>
getProviderList()  : array<string|int, mixed>
getRobotList()  : array<string|int, mixed>
getTaskList()  : array<string|int, mixed>
getWorkflowInstances()  : Countable
getWorkflowTemplates()  : Countable
killWorkflow()  : bool
onRestAppDelete()  : void
Deletes application activities.
onRestAppUpdate()  : void
Deletes application activities.
onRestServiceBuildDescription()  : mixed
sendEvent()  : bool
startWorkflow()  : string
terminateWorkflow()  : bool
updateActivity()  : bool
updateRobot()  : bool
updateWorkflowTemplate()  : bool
writeActivityLog()  : bool

Constants

ERROR_ACTIVITY_ADD_FAILURE

public mixed ERROR_ACTIVITY_ADD_FAILURE = 'ERROR_ACTIVITY_ADD_FAILURE'

ERROR_ACTIVITY_ALREADY_INSTALLED

public mixed ERROR_ACTIVITY_ALREADY_INSTALLED = 'ERROR_ACTIVITY_ALREADY_INSTALLED'

ERROR_ACTIVITY_NOT_FOUND

public mixed ERROR_ACTIVITY_NOT_FOUND = 'ERROR_ACTIVITY_NOT_FOUND'

ERROR_ACTIVITY_VALIDATION_FAILURE

public mixed ERROR_ACTIVITY_VALIDATION_FAILURE = 'ERROR_ACTIVITY_VALIDATION_FAILURE'

ERROR_DELEGATION_NOT_ALLOWED

public mixed ERROR_DELEGATION_NOT_ALLOWED = 'ERROR_DELEGATION_NOT_ALLOWED'

ERROR_EMPTY_LOG_MESSAGE

public mixed ERROR_EMPTY_LOG_MESSAGE = 'ERROR_EMPTY_LOG_MESSAGE'

ERROR_INVALID_USER_ID

public mixed ERROR_INVALID_USER_ID = 'ERROR_INVALID_USER_ID'

ERROR_SELECT_VALIDATION_FAILURE

public mixed ERROR_SELECT_VALIDATION_FAILURE = 'ERROR_SELECT_VALIDATION_FAILURE'

ERROR_TASK_COMPLETED

public mixed ERROR_TASK_COMPLETED = 'ERROR_TASK_COMPLETED'

ERROR_TASK_EXECUTION

public mixed ERROR_TASK_EXECUTION = 'ERROR_TASK_EXECUTION'

ERROR_TASK_NOT_FOUND

public mixed ERROR_TASK_NOT_FOUND = 'ERROR_TASK_NOT_FOUND'

ERROR_TASK_TYPE

public mixed ERROR_TASK_TYPE = 'ERROR_TASK_TYPE'

ERROR_TASK_VALIDATION

public mixed ERROR_TASK_VALIDATION = 'ERROR_TASK_VALIDATION'

ERROR_TEMPLATE_NOT_FOUND

public mixed ERROR_TEMPLATE_NOT_FOUND = 'ERROR_TEMPLATE_NOT_FOUND'

ERROR_TEMPLATE_NOT_OWNER

public mixed ERROR_TEMPLATE_NOT_OWNER = 'ERROR_TEMPLATE_NOT_OWNER'

ERROR_TEMPLATE_VALIDATION_FAILURE

public mixed ERROR_TEMPLATE_VALIDATION_FAILURE = 'ERROR_TEMPLATE_VALIDATION_FAILURE'

ERROR_WRONG_WORKFLOW_ID

public mixed ERROR_WRONG_WORKFLOW_ID = 'ERROR_WRONG_WORKFLOW_ID'

PLACEMENT_ACTIVITY_PROPERTIES_DIALOG

public mixed PLACEMENT_ACTIVITY_PROPERTIES_DIALOG = 'BIZPROC_ACTIVITY_PROPERTIES_DIALOG'

Methods

addActivity()

public static addActivity(array<string|int, mixed> $params, int $n, CRestServer $server) : bool
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
Exception
Return values
bool

addProvider()

public static addProvider(array<string|int, mixed> $params, int $n, CRestServer $server) : bool
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
Exception
Return values
bool

addRobot()

public static addRobot(array<string|int, mixed> $params, int $n, CRestServer $server) : bool
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
Exception
Return values
bool

addWorkflowTemplate()

public static addWorkflowTemplate(array<string|int, mixed> $params, int $n, CRestServer $server) : bool
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
Exception
Return values
bool

completeTask()

public static completeTask(array<string|int, mixed> $params, int $n, CRestServer $server) : bool
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
RestException
Return values
bool

delegateTask()

public static delegateTask(mixed $params, mixed $n, mixed $server) : mixed
Parameters
$params : mixed
$n : mixed
$server : mixed

deleteActivity()

public static deleteActivity(array<string|int, mixed> $params, int $n, CRestServer $server) : bool
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
Exception
Return values
bool

deleteProvider()

public static deleteProvider(array<string|int, mixed> $params, int $n, CRestServer $server) : bool
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
Exception
Return values
bool

deleteRobot()

public static deleteRobot(array<string|int, mixed> $params, int $n, CRestServer $server) : bool
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
Exception
Return values
bool

deleteWorkflowTemplate()

public static deleteWorkflowTemplate(array<string|int, mixed> $params, int $n, CRestServer $server) : bool
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
Exception
Return values
bool

getActivityList()

public static getActivityList(array<string|int, mixed> $params, int $n, CRestServer $server) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
AccessException
throws
ArgumentException
Return values
array<string|int, mixed>

getProviderList()

public static getProviderList(array<string|int, mixed> $params, int $n, CRestServer $server) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
AccessException
throws
ArgumentException
Return values
array<string|int, mixed>

getRobotList()

public static getRobotList(array<string|int, mixed> $params, int $n, CRestServer $server) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
AccessException
throws
ArgumentException
Return values
array<string|int, mixed>

getTaskList()

public static getTaskList(array<string|int, mixed> $params, int $n, CRestServer $server) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
AccessException
Return values
array<string|int, mixed>

getWorkflowInstances()

public static getWorkflowInstances(array<string|int, mixed> $params, int $n, CRestServer $server) : Countable
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
AccessException
throws
ArgumentException
throws
SystemException
Return values
Countable

getWorkflowTemplates()

public static getWorkflowTemplates(array<string|int, mixed> $params, int $n, CRestServer $server) : Countable
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
AccessException
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
Countable —

Templates collection.

killWorkflow()

public static killWorkflow(array<string|int, mixed> $params, int $n, CRestServer $server) : bool
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
AccessException
throws
RestException
Return values
bool —

True on success.

onRestAppDelete()

Deletes application activities.

public static onRestAppDelete(array<string|int, mixed> $fields) : void
Parameters
$fields : array<string|int, mixed>

Fields describes application.

onRestAppUpdate()

Deletes application activities.

public static onRestAppUpdate(array<string|int, mixed> $fields) : void
Parameters
$fields : array<string|int, mixed>

Fields describes application.

onRestServiceBuildDescription()

public static onRestServiceBuildDescription() : mixed

sendEvent()

public static sendEvent(array<string|int, mixed> $params, int $n, CRestServer $server) : bool
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
AccessException
throws
RestException
Return values
bool

startWorkflow()

public static startWorkflow(array<string|int, mixed> $params, int $n, CRestServer $server) : string
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
AccessException
throws
RestException
Return values
string —

Workflow ID.

terminateWorkflow()

public static terminateWorkflow(array<string|int, mixed> $params, int $n, CRestServer $server) : bool
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
AccessException
throws
RestException
Return values
bool —

True on success.

updateActivity()

public static updateActivity(array<string|int, mixed> $params, int $n, CRestServer $server) : bool
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
Exception
Return values
bool

updateRobot()

public static updateRobot(array<string|int, mixed> $params, int $n, CRestServer $server) : bool
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
Exception
Return values
bool

updateWorkflowTemplate()

public static updateWorkflowTemplate(array<string|int, mixed> $params, int $n, CRestServer $server) : bool
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
Exception
Return values
bool

writeActivityLog()

public static writeActivityLog(array<string|int, mixed> $params, int $n, CRestServer $server) : bool
Parameters
$params : array<string|int, mixed>

Input params.

$n : int

Offset.

$server : CRestServer

Rest server instance.

Tags
throws
AccessException
throws
RestException
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results