3.10 ReadResource

POST method to read from a resource (for example, a file) associated with a Workflow Automation provider namespace object.

3.10.1 Request Parameters

Include the following parameters in the request URL as needed.

Parameter

Description

  • sessionID
  • userName
  • password
  • hostName
  • portNumber

All web service calls require BSL authentication and may optionally identify a Workflow Automation Server. For more information about authentication and identification, see Authentication and Identification.

3.10.2 Request Data

Include the following elements in the POST request data as needed.

Element

Description

Path

REQUIRED. Workflow Automation provider namespace path.

BufferType

REQUIRED. Numeric buffer type that identifies the data type (such as integer, floating point, string, attribute names and values) to be stored in the buffer.

Provider

REQUIRED. Workflow Automation provider name.

HINT:You can get a list of all the active providers for a Workflow Automation Server using the GetManagementServices method.

ReadBlockSize

REQUIRED. Number of bytes to read from the resource.

ResourceName

REQUIRED. Name of the resource to read from.

HINT:Available Workflow Automation resources are represented by paths and resource names within a Workflow Automation provider namespace.

StartPosition

REQUIRED. Offset within the resource from which to begin reading. If zero, reading starts at the beginning of the resource.

3.10.3 Response Data

The POST response data contains the following elements.

Element

Description

Type

Buffer type.

Value

Data read from ResourceName.