### Process Parameters Configuration

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessStartConfig.html

Methods to get and set the process parameters for starting a process.

```APIDOC
### getProcessParameters
public ProcessVariable[] getProcessParameters()
Get the process parameters that will be used when starting the process.

Returns:
    the process parameters

### setProcessParameters
public void setProcessParameters(ProcessVariable[] processParameters)
Set the process parameters to use when starting the process. If using a process variable of an Appian type, do not set the value to that object but instead to the corresponding primitive. For instance, do not assign a User process variable a `User` object. Instead, assign that process variable a `String` containing the username. Likewise, assign a process variable of type Group should be assigned a `Long`, etc. The exception to this rule is the People type. Process variables of type People should be assigned a `LocalObject`. Only the values are used for passed parameters, not expressions; expressions must be set on the process model at design time.

Parameters:
    `processParameters` - The following fields must be populated for each `ProcessVariable` object: `name`, `value`, `instanceType`
```

--------------------------------

### Process Starting Information

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessDesignService.html

Method for retrieving information related to starting a process.

```APIDOC
## getProcessStartingInfo$UPDATES

### Description
Retrieves information required to start a process.

### Method
static final boolean
```

--------------------------------

### initiateProcess

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessDesignService.html

Starts an instance of the given process model with additional configuration to control how the process is started.

```APIDOC
## initiateProcess

### Description
Starts an instance of the given process model.

### Method
Long

### Parameters
#### Path Parameters
- **processModelId_** (Long) - Required - id of process model to start
- **config** (ProcessStartConfig) - Required - additional configuration to control how the process is started

### Returns
- The id of the started process instance.

### Throws
- `InvalidProcessModelException` - if the referenced process model does not exist or has been deleted.
- `InvalidPriorityException` - if the Priority does not exist
- `InvalidVersionException` - if the process model version is invalid.
- `PrivilegeException` - if the user does not have permission to perform this action.
- `InvalidStateException` - if there is no published version of the specified pm, the published version is disabled, or if the process model contains sub process models that have been disabled or deleted. Note that all sub process models of a published process model must have been published, but they can still be disabled.
- `StorageLimitException` - if storage limits are exceeded.
- `InvalidUserException` - if any user referenced in any `ProcessVariable` does not exist.
- `IllegalArgumentException` - if the `ProcessModel` requires process parameters to start, and the `variables_` parameter is an empty array, or does not contain all necessary process parameters.
- `com.appiancorp.asl3.servicefw.connect.ServiceException` - if any system-level error occurs.
- `Exception`
```

--------------------------------

### startQuickTask

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessExecutionService.html

Starts a new task from a specified node. If the process is cancelled or completed, it reactivates. For paused processes, a new task is started but will not kick off until the process is resumed. Logic nodes cannot be started.

```APIDOC
## startQuickTask

### Description
Starts a new task from the node. If the process to which the node belongs is cancelled or completed, then the process is reactivated. For a paused process, a new task is started but will not be kicked off until the process is resumed. N.B. Logic nodes cannot be started.

### Method
`startQuickTask`

### Parameters
#### Path Parameters
- **processId_** (Long) - Required - The id of the process.
- **nodeId_** (Long) - Required - The id of the task's template node, which can be obtained from the `templateId` property of a `TaskSummary` object.

### Returns
- `Long` the task id, if the task started correctly, null if the node has spawning or recurrence configured.

### Throws
- `InvalidProcessException` - if the process does not exist
- `InvalidNodeException` - the node used does not exist or if the node exists (it has a valid template) but does not belong to the given process
- `InvalidNodeTypeLogicException` - if the node is a logic node.
- `InvalidStateException` - if the process is paused by exception
- `PrivilegeException` - if `NodePermissions.isModifyInFlight()` is `false` for the current user
- `InvalidNodeTypeRecurringException` - if the node is set to recur
- `InvalidNodeMultiplicityException` - if the node cannot be started because its activity chaining settings prohibit multiple instances
- `ServiceException` - if any system-level error occurs
```

--------------------------------

### Process Models I Can Start

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessDesignService.html

Retrieves a list of process models that the current user is permitted to start.

```APIDOC
## getProcessModelsICanStart$UPDATES

### Description
Retrieves a list of process models that the current user is permitted to start.

### Method
static final boolean

### Endpoint
N/A (This is a method signature, not an HTTP endpoint)

### Parameters
None explicitly defined in this snippet.

### Request Example
N/A

### Response
N/A
```

--------------------------------

### ProcessStartingInfo

Source: https://docs.appian.com/suite/help/25.4/api/allclasses-index.html

Bean for process starting info.

```APIDOC
## ProcessStartingInfo

### Description
Bean for process starting info.

### Class
ProcessStartingInfo
```

--------------------------------

### DynamicForm.getInstructions

Source: https://docs.appian.com/suite/help/25.4/api/index-all.html

Gets the instructions for the form.

```APIDOC
## getInstructions()

### Description
Gets the instructions for the form.

### Method
Instance method

### Class
com.appian.suiteapi.process.forms.DynamicForm
```

--------------------------------

### getStartIndex (ReportData)

Source: https://docs.appian.com/suite/help/25.4/api/index-all.html

Gets the start index for ReportData.

```APIDOC
## getStartIndex()

### Description
Get the start index.

### Method
(Not specified, likely a class method call)

### Endpoint
(Not specified)

### Parameters
None

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### Get Default Application

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/applications/ApplicationService.html

Gets the default system application.

```APIDOC
## getDefaultApplication

### Description
Gets the default system application.

### Method Signature
`Long getDefaultApplication()`
```

--------------------------------

### FormElement.getInstructions

Source: https://docs.appian.com/suite/help/25.4/api/index-all.html

Gets the instructions for the form element.

```APIDOC
## getInstructions()

### Description
Gets the instructions for the form element.

### Method
Instance method

### Class
com.appian.suiteapi.process.forms.FormElement
```

--------------------------------

### ProcessStartConfig Methods

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessStartConfig.html

Details the methods available for retrieving and setting configurations for starting a process.

```APIDOC
## getDepth()

### Description
Get the depth of the current process.

### Method
`int getDepth()`
```

```APIDOC
## getPriorityId()

### Description
Get the priority id to use when starting the process.

### Method
`Long getPriorityId()`
```

```APIDOC
## getProcessModelVersion()

### Description
Get the process model version to use when starting the process.

### Method
`String getProcessModelVersion()`
```

```APIDOC
## getProcessParameters()

### Description
Get the process parameters that will be used when starting the process.

### Method
`ProcessVariable[] getProcessParameters()`
```

```APIDOC
## setDepth(int depth)

### Description
Set the current process depth.

### Method
`void setDepth(int depth)`
```

```APIDOC
## setPriorityId(Long priorityId)

### Description
Set the priority id to use when starting the process.

### Method
`void setPriorityId(Long priorityId)`
```

```APIDOC
## setProcessModelVersion(String processModelVersion)

### Description
Set the process model version to use when starting the process.

### Method
`void setProcessModelVersion(String processModelVersion)`
```

```APIDOC
## setProcessParameters(ProcessVariable[] processParameters)

### Description
Set the process parameters to use when starting the process.

### Method
`void setProcessParameters(ProcessVariable[] processParameters)`
```

--------------------------------

### create() Static Method

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/common/ServiceProvider.html

Provides a default implementation of all known services.

```APIDOC
## create(ServiceContext ctx)

### Description
Provides a default implementation of all the known Services.

### Parameters
* **ctx** (ServiceContext) - The ServiceContext to use.

### Returns
* Map<Class<?>, Provider<?>> - A map of service classes to their default providers.

### See Also
* `ServiceLocator`
```

--------------------------------

### getPriorityId()

Source: https://docs.appian.com/suite/help/25.4/api/index-all.html

Get the priority id to use when starting the process.

```APIDOC
## getPriorityId()

### Description
Get the priority id to use when starting the process.

### Method
Method

### Class
com.appiancorp.suiteapi.process.ProcessStartConfig
```

--------------------------------

### getSpecific()

Source: https://docs.appian.com/suite/help/25.4/api/index-all.html

Get the start and end times for specific days.

```APIDOC
## getSpecific()

### Description
Get the start and end times for specific days.

### Method
N/A (Java Method)

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
None
```

--------------------------------

### WorkingCalendar.getDefaultDayOfWeek()

Source: https://docs.appian.com/suite/help/25.4/api/index-all.html

Get the default start and end times for the days of the week.

```APIDOC
## getDefaultDayOfWeek()

### Description
Get the default start and end times for the days of the week.

### Method
Method

### Class
com.appiancorp.suiteapi.process.calendar.WorkingCalendar
```

--------------------------------

### getDescription

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/content/Content.html

Gets the description of the content. If the description starts with "##!", it is internationalized.

```APIDOC
## getDescription

### Description
Gets the description. If the description starts with "##!", then it is internationalized and the internationalization value should be looked up in Java.

### Method
public String getDescription()

### Returns
* the description (String)
```

--------------------------------

### Constructor

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/TaskSummary.html

Initializes a new instance of the TaskSummary class.

```APIDOC
## Constructor Details

### `TaskSummary`
`public TaskSummary()`
```

--------------------------------

### startProcessVersion

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessDesignService.html

Starts a new instance of a specified process model version. It initializes the process with provided variables and an optional priority. Note: This method is deprecated and `initiateProcess` is recommended.

```APIDOC
## startProcessVersion

### Description
Deprecated. Use `initiateProcess(Long, ProcessStartConfig)`, which has better enforcement of required parameters (requires that their values not be null or empty).
Starts an instance of the given process model version, using the given variables to initialize state.

### Method Signature
`Long startProcessVersion(Long processModelId_, ProcessVariable[] variables_, String version_, Long priorityId_)`

### Parameters
*   **`processModelId_`** (Long) - ID of the process model to start.
*   **`variables_`** (ProcessVariable[]) - Parameters for the process model. For Appian types, use primitive equivalents (e.g., String for User, Long for Group). People type requires `LocalObject`. Exception: People type requires `LocalObject`.
*   **`version_`** (String) - Version of the process model to start.
*   **`priorityId_`** (Long) - Priority of the process model to start. Use `null` for the default priority.

### Returns
*   The ID of the started process instance (Long).

### Throws
*   `InvalidProcessModelException` - If the process model is invalid.
*   `InvalidPriorityException` - If the priority is invalid.
*   `InvalidVersionException` - If the version is invalid.
*   `PrivilegeException` - If the user lacks privileges.
*   `InvalidStateException` - If the version does not exist.
*   `StorageLimitException` - If all execution servers are full.
*   `InvalidUserException` - If a referenced user does not exist.
*   `IllegalArgumentException` - If the process model requires parameters and `variables_` is null, empty, or incomplete.
*   `com.appiancorp.asl3.servicefw.connect.ServiceException` - If any system-level error occurs.
*   `Exception`
```

--------------------------------

### Get Process Parameters

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessModelFacade.html

Retrieves the process parameters used to start a process model.

```APIDOC
## getProcessParameters

### Description
Retrieve the process parameters used to start of the process model of the given ID.

### Method Signature
`static ProcessVariable[] getProcessParameters(Long pmId, ServiceContext sc)`

### Parameters
- **pmId** (Long) - The ID of the process model.
- **sc** (ServiceContext) - The service context for the operation.

### Returns
- ProcessVariable[] - An array of process variables representing the parameters.
```

--------------------------------

### startProcess

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessDesignService.html

Starts an instance of a process model with given variables. Deprecated, use initiateProcess instead.

```APIDOC
## startProcess

### Description
Starts an instance of the given process model, using the given variables to initialize state. Deprecated. Use `initiateProcess(Long, ProcessStartConfig)`, which has better enforcement of required parameters (requires that their values not be null or empty).

The following fields must be populated for each `ProcessVariable` object: `key`, `value`, `type`, and `multiple`.

### Method
`startProcess(Long processModelId_, ProcessVariable[] variables_)

### Parameters
#### Path Parameters
- **processModelId_** (Long) - Required - id of process model to start
- **variables_** (ProcessVariable[]) - Required - parameters for the process model. If using a process variable of an Appian type, do not set the value to that object but instead to the corresponding primitive. For instance, do not assign a User process variable a `User` object. Instead, assign that process variable a `String` containing the username. Likewise, assign a process variable of type Group should be assigned a `Long`, etc. The exception to this rule is the People type. Process variables of type People should be assigned a `LocalObject`. Only the values are used for passed parameters, not expressions; expressions must be set on the process model at design time.

### Response
#### Success Response (200)
- **Long** - The id of the started process instance.

### Throws
- `InvalidProcessModelException` - if the `ProcessModel` specified by `processModelId_` does not exist
- `PrivilegeException` - if the current `User` does not have sufficient privileges to view the `ProcessModel`
- `InvalidStateException`
- `StorageLimitException`
- `InvalidUserException`
- `IllegalArgumentException`
- `Exception` - if any system-level error occurs
```

--------------------------------

### Priority ID Configuration

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessStartConfig.html

Methods to get and set the priority ID for starting a process.

```APIDOC
## Method Details

### getPriorityId
public Long getPriorityId()
Get the priority id to use when starting the process. Defaults to null, which means use the default priority id.

Returns:
    the priority id

### setPriorityId
public void setPriorityId(Long priorityId)
Set the priority id to use when starting the process.

Parameters:
    `priorityId` - the priority id (null means use the default)
```

--------------------------------

### ProcessStartConfig Constructors

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessStartConfig.html

Provides information on how to instantiate a ProcessStartConfig object with different configurations.

```APIDOC
## ProcessStartConfig()

### Description
Instantiate a `ProcessStartConfig` using default values for all configurations.

### Constructor
`ProcessStartConfig()`
```

```APIDOC
## ProcessStartConfig(ProcessVariable[] processParameters)

### Description
Instantiate a `ProcessStartConfig` with the given process parameters.

### Constructor
`ProcessStartConfig(ProcessVariable[] processParameters)`
```

```APIDOC
## ProcessStartConfig(ProcessVariable[] processParameters, String processModelVersion, Long priorityId)

### Description
Instantiate a `ProcessStartConfig` with the given process parameters, process model version and priority id.

### Constructor
`ProcessStartConfig(ProcessVariable[] processParameters, String processModelVersion, Long priorityId)`
```

```APIDOC
## ProcessStartConfig(ProcessVariable[] processParameters, String processModelVersion, Long priorityId, int depth)

### Description
Instantiate a `ProcessStartConfig` with the given process parameters, process model version and priority id.

### Constructor
`ProcessStartConfig(ProcessVariable[] processParameters, String processModelVersion, Long priorityId, int depth)`
```

--------------------------------

### getMinuteOfDay

Source: https://docs.appian.com/suite/help/25.4/api/index-all.html

Get the minute of the day on which this start-end period will start. 0 minutes corresponds to midnight.

```APIDOC
## getMinuteOfDay()

### Description
Get the minute of the day on which this start-end period will start. 0 minutes corresponds to midnight.

### Method
Method

### Class
com.appian.suiteapi.process.calendar.CalendarElement
```

--------------------------------

### Constructors

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessStartConfig.html

Provides constructors to instantiate ProcessStartConfig with different configurations.

```APIDOC
## Constructor Details

### ProcessStartConfig
public ProcessStartConfig()
Instantiate a `ProcessStartConfig` using default values for all configurations.

### ProcessStartConfig
public ProcessStartConfig(ProcessVariable[] processParameters)
Instantiate a `ProcessStartConfig` with the given process parameters. Default values will be used for all other configurations.

Parameters:
    `processParameters` - The process parameters to use when starting the process. The following fields must be populated for each `ProcessVariable` object: `name`, `value`, `instanceType`.

### ProcessStartConfig
public ProcessStartConfig(ProcessVariable[] processParameters, String processModelVersion, Long priorityId)
Instantiate a `ProcessStartConfig` with the given process parameters, process model version and priority id.

Parameters:
    `processParameters` - The process parameters to use when starting the process. The following fields must be populated for each `ProcessVariable` object: `name`, `value`, `instanceType`.     `processModelVersion` - The process model version to use when starting the process (use `AbstractProcessModel.LATEST_PUBLISHED_VERSION` to start the latest published version of the model)     `priorityId` - The priority id to use when starting the process (null means use the default).

### ProcessStartConfig
public ProcessStartConfig(ProcessVariable[] processParameters, String processModelVersion, Long priorityId, int depth)
Instantiate a `ProcessStartConfig` with the given process parameters, process model version and priority id.

Parameters:
    `processParameters` - The process parameters to use when starting the process. The following fields must be populated for each `ProcessVariable` object: `name`, `value`, `instanceType`.     `processModelVersion` - The process model version to use when starting the process (use `AbstractProcessModel.LATEST_PUBLISHED_VERSION` to start the latest published version of the model)     `priorityId` - The priority id to use when starting the process (null means use the default).     `depth` - The current subprocess depth. Top level is 0
```

--------------------------------

### Get Tree At Folder

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/portal/portlets/links/LinksService.html

Retrieves the folder tree starting from the specified folder. Note: This method is deprecated.

```APIDOC
## getTreeAtFolder

### Description
Get the folder tree at a `Folder`.

### Method
getTreeAtFolder

### Parameters
- **folderId_** (Long) - The ID of the root folder for the tree

### Response
- **Success Response (Folder)** - The root folder of the tree.
```

--------------------------------

### getApplicationActions()

Source: https://docs.appian.com/suite/help/25.4/api/index-all.html

Gets the application actions.

```APIDOC
## getApplicationActions()

### Description
Gets the application actions.

### Method
Not specified (likely a Java method call)

### Endpoint
Not applicable (Java method)

### Parameters
None

### Request Example
Not applicable

### Response
- **Success Response**: A collection of application actions.

### Response Example
Not applicable
```

--------------------------------

### Process Model Version Configuration

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessStartConfig.html

Methods to get and set the process model version for starting a process.

```APIDOC
### getProcessModelVersion
public String getProcessModelVersion()
Get the process model version to use when starting the process. Defaults to the latest published version if not set.

Returns:
    the process model version

### setProcessModelVersion
public void setProcessModelVersion(String processModelVersion)
Set the process model version to use when starting the process.

Parameters:
    `processModelVersion` - the process model version (use `AbstractProcessModel.LATEST_PUBLISHED_VERSION` to start the latest published version of the model)
```

--------------------------------

### getPrefix()

Source: https://docs.appian.com/suite/help/25.4/api/index-all.html

Gets the prefix of the application.

```APIDOC
## getPrefix()

### Description
Gets the prefix of the application as a `String`.

### Method
Method

### Response
#### Success Response (200)
- **String** (String) - The application prefix.
```

--------------------------------

### Process Timing Information

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessSummary.html

Methods to get and set the elapsed time, start time, and end time of a process.

```APIDOC
## getElapsedMilliseconds

### Description
Retrieves the number of milliseconds since the process has started.

### Method
public Long getElapsedMilliseconds()

### Returns
number of milliseconds.

## setElapsedMilliseconds

### Description
Sets the number of milliseconds since the process has started.

### Method
public void setElapsedMilliseconds(Long milliseconds_)

### Parameters
- `milliseconds_` (Long) - elapsed milliseconds

## getEndTime

### Description
Returns the time at which the process ended. Null if the process is currently active.

### Method
public Timestamp getEndTime()

### Returns
Returns the timestamp of the process end time.

## setEndTime

### Description
Sets the time at which the process ended.

### Method
public void setEndTime(Timestamp time_)

### Parameters
- `time_` (Timestamp) - the end timestamp of the process.

## getStartTime

### Description
Retrieves the time at which the process started.

### Method
public Timestamp getStartTime()

### Returns
timestamp of the process start time.

## setStartTime

### Description
Sets the time at which the process started.

### Method
public void setStartTime(Timestamp time_)

### Parameters
- `time_` (Timestamp) - timestamp of the process start time.
```

--------------------------------

### ProcessStartingInfo Constructor

Source: https://docs.appian.com/suite/help/25.4/api/index-all.html

Constructor for the ProcessStartingInfo class.

```APIDOC
## ProcessStartingInfo()

### Description
Constructor for class com.appiancorp.suiteapi.process.webservices.ProcessStartingInfo

### Method
Constructor

### Endpoint
N/A

### Parameters
None
```

--------------------------------

### getParameters

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/portal/Portlet.html

Gets the map of name-value pair parameters for this portlet. Names must be single words, starting with a letter and containing only _, numbers and letters in the basic US character set. Values should be of type String, though future implementations (and experimentally, the current one) may allow other datatypes. This method is deprecated.

```APIDOC
## getParameters
public Map<String,Object> getParameters()

Deprecated.
The map of name-value pair parameters for this portlet. Names must be single words, starting with a letter and containing only _, numbers and letters in the basic US character set. Values should be of type String, though future implementations (and experimentally, the current one) may allow other datatypes. 

See Also:
    
      * `PortletService.updatePortletParameters(java.lang.Long, java.util.Map)`
```

--------------------------------

### startProcess

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/test/ProcessController.html

Starts a new process instance based on a given Process Model ID and an array of Process Variables.

```APIDOC
## startProcess

### Description
Starts the given ProcessModel using the given ProcessVariables.

### Method
`Long startProcess(Long processModelId, ProcessVariable[] pvs)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **processModelId** (Long) - The ID of the process model to start.
- **pvs** (ProcessVariable[]) - An array of Process Variables to be used when starting the process.

### Request Example
```json
{
  "processModelId": 12345,
  "pvs": [
    {"name": "variable1", "value": "value1"},
    {"name": "variable2", "value": 100}
  ]
}
```

### Response
#### Success Response (200)
- **processId** (Long) - The ID of the newly started process.

#### Response Example
```json
{
  "processId": 67890
}
```

### Throws
- `Exception`
- `IllegalArgumentException`
- `InvalidUserException`
- `StorageLimitException`
- `InvalidStateException`
- `PrivilegeException`
- `InvalidProcessModelException`
```

--------------------------------

### Get Version

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/collaboration/DocumentService.html

Gets a specific version of a document.

```APIDOC
## getVersion

### Description
Gets a specific version of a document.

### Method Signature
`Document getVersion(Long doid_, Integer versionId_)`

### Parameters
* `doid_` (Long) - The ID of the document.
* `versionId_` (Integer) - The ID of the version to retrieve.

### Returns
* `Document` - The requested document version.

### Deprecated
This method is deprecated.
```

--------------------------------

### Application Constructor

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/applications/Application.html

Initializes a new instance of the Application class.

```APIDOC
## Application()

### Description
Initializes a new instance of the Application class.

### Constructor
public Application()
```

--------------------------------

### Get Criteria

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/common/query/GenericQuery.html

Gets the Criteria associated with the GenericQuery.

```APIDOC
## getCriteria()

### Description
Gets the `Criteria`.

### Method
```java
public Criteria getCriteria()
```

### Returns
the `Criteria`
```

--------------------------------

### Constructor

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/RuntimeProcessNode.html

Initializes a new instance of the RuntimeProcessNode class.

```APIDOC
## RuntimeProcessNode()

### Description
Initializes a new instance of the RuntimeProcessNode class.

### Method
`public RuntimeProcessNode()`
```

--------------------------------

### Spawning Methods

Source: https://docs.appian.com/suite/help/25.4/api/index-all.html

Returns the Instances configuration.

```APIDOC
## getInstances()

### Description
Returns the `Instances` configuration.

### Method
Method

### Response
#### Success Response (200)
- **instances** (Instances) - Description
```

--------------------------------

### Get External Filename

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/content/ContentService.html

Gets the external filename of a document.

```APIDOC
## getExternalFilename

### Description
Gets the external filename (the name that the file would be saved as by the client, or the name within a .zip file) of a document.

### Method Signature
`String getExternalFilename(Long id_)`

### Parameters
* **id_** (Long) - The ID of the document.
```

--------------------------------

### Get External Filenames

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/content/ContentService.html

Gets the external filenames of a set of documents.

```APIDOC
## getExternalFilenames

### Description
Gets the external filenames (the name that the file would be saved as by the client, or the name within a .zip file) of a set of document.

### Method Signature
`String[] getExternalFilenames(Long[] ids_)`

### Parameters
* **ids_** (Long[]) - An array of document IDs.
```

--------------------------------

### Constructor

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/security/ProcessApplicationPermissions.html

Initializes a new instance of the ProcessApplicationPermissions class.

```APIDOC
## ProcessApplicationPermissions

### Description
Initializes a new instance of the ProcessApplicationPermissions class.

### Method
public ProcessApplicationPermissions()
```

--------------------------------

### startTasks

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessExecutionService.html

Attempts to start multiple tasks for a given process and returns an array of result codes indicating the outcome for each task. It can also cancel and resolve existing instances of nodes that were paused by exception. Logic nodes cannot be started.

```APIDOC
## startTasks

### Description
Tries to start the tasks, and returns an array of result codes on whether the operation was successful or an error had occurred. Will cancel and resolve existing instances of the node that were paused by exception. N.B. Logic nodes cannot be started.

### Method
`startTasks`

### Parameters
#### Path Parameters
- **processId_** (Long) - Required - The id of the process.
- **nodeIds_** (Long[]) - Required - The ids of the tasks to start.

### Returns
- Integer[] - an array of result codes. The result codes can be: `RESULT_CODE_SUCCESS` if the action succeeded, `RESULT_CODE_INVALID_TASK` if the node does not exist, `RESULT_CODE_INSUFFICIENT_PRIVILEGES` if the user does not have permission, or `RESULT_CODE_INVALID_STATE` if it is a logic node `RESULT_CODE_NODE_MULTIPLICITY` if the node cannot be started `RESULT_CODE_INVALID_NODE` if the node is invalid because its activity chaining settings prohibit multiple instances

### Throws
- `InvalidProcessException` - if the process does not exist
```

--------------------------------

### Get Attachments for Task

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessExecutionService.html

Gets all attachments for a given task and its related process.

```APIDOC
## getAttachmentsForTask

### Description
Gets all the attachments for a given task and its related process.

### Method Signature
`Attachment[] getAttachmentsForTask(Long taskId_)`

### Parameters
#### Path Parameters
- `taskId_` (Long) - The ID of the task.

### Returns
The attachments.

### Throws
- `InvalidActivityException` - if the task specified does not exist.
- `PrivilegeException` - if the current user does not have privileges to perform this action.
- `InvalidProcessException`
- `ServiceException` - if any system-level error occurs.
- `InvalidOperationException`
```

--------------------------------

### getProcessStartingInfo

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessDesignService.html

Retrieves information required to start a process.

```APIDOC
## getProcessStartingInfo

### Description
Retrieves information required to start a process.

### Method
Not specified (assumed to be a method call in an SDK)

### Endpoint
Not applicable (SDK method)

### Response
#### Success Response
- **ProcessStartingInfo** - Information about starting a process.
```

--------------------------------

### getOptions Method

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/common/cli/Configurable.html

Retrieves a list of available configuration options.

```APIDOC
## getOptions

### Description
Retrieves a list of available configuration options.

### Method
List<Option>

### Signature
List<Option> getOptions()
```

--------------------------------

### Get Datatype IDs

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/content/ContentService.html

Gets the datatype IDs that content IDs map to.

```APIDOC
## getDatatypeIds

### Description
Gets the datatype ids that content ids map to.

### Method Signature
`Long[] getDatatypeIds(Long... contentIds)`

### Parameters
* **contentIds** (Long...) - A variable number of content IDs.
```

--------------------------------

### Connection Class Methods

Source: https://docs.appian.com/suite/help/25.4/api/index-all.html

Methods for setting the start node GUI ID in Connection.

```APIDOC
## setStartNodeGuiId Long

### Description
Sets the gui id of the start node `ProcessNode` of this connection.

### Method
N/A (Java method signature)

### Parameters
- **startNodeGuiId** (Long) - Description not provided
```

--------------------------------

### Get Versions Paging

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/collaboration/DocumentService.html

Gets specific versions of a document with pagination support.

```APIDOC
## getVersionsPaging

### Description
Gets specific versions of a document, paging.

### Method Signature
`ResultPage getVersionsPaging(Long doid_, Integer[] versionIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_)`

### Parameters
* `doid_` (Long) - The ID of the document.
* `versionIds_` (Integer[]) - An array of version IDs to retrieve.
* `startIndex_` (int) - The starting index for the page.
* `batchSize_` (int) - The number of results per page.
* `sortProperty_` (Integer) - The property to sort by.
* `sortOrder_` (Integer) - The order of sorting.

### Returns
* `ResultPage` - A page of document versions.

### Deprecated
This method is deprecated.
```

--------------------------------

### Get All Versions for Document Paging

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/collaboration/DocumentService.html

Gets all versions of a document with pagination support.

```APIDOC
## getAllVersionsForDocumentPaging

### Description
Gets all versions of a document, paging.

### Method Signature
`ResultPage getAllVersionsForDocumentPaging(Long doid_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_)`

### Parameters
* `doid_` (Long) - The ID of the document.
* `startIndex_` (int) - The starting index for the page.
* `batchSize_` (int) - The number of results per page.
* `sortProperty_` (Integer) - The property to sort by.
* `sortOrder_` (Integer) - The order of sorting (e.g., ascending or descending).

### Returns
* `ResultPage` - A page of document versions.

### Deprecated
This method is deprecated.
```

--------------------------------

### Start Form Capability

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessDesignService.html

Checks if a process model is capable of having a start form.

```APIDOC
## isStartFormCapable$UPDATES

### Description
Checks if a process model is capable of having a start form.

### Method
static final boolean

### Endpoint
N/A (This is a method signature, not an HTTP endpoint)

### Parameters
None explicitly defined in this snippet.

### Request Example
N/A

### Response
N/A
```

--------------------------------

### startAllNodes

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessExecutionService.html

Start a task for each of the given nodeUuids in every applicable process.

```APIDOC
## startAllNodes

### Description
Start a task for each of the given nodeUuids in every applicable process.

### Method Signature
`NodeActionResult startAllNodes(String[] nodeUuids, Long[] withinProcessIds, BulkNodeOption... bulkNodeOption)`
```

--------------------------------

### startProcessWithPriority

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessDesignService.html

Starts an instance of a given process model with a specified priority and initializes its state using provided variables. This method is deprecated and users should prefer `initiateProcess`.

```APIDOC
## startProcessWithPriority

### Description
Deprecated. Use `initiateProcess(Long, ProcessStartConfig)`, which has better enforcement of required parameters (requires that their values not be null or empty). Starts an instance of the given process model, using the given variables to initialize state. The process will be started with the priority specified.

### Method
Long

### Parameters
#### Path Parameters
- **processModelId_** (Long) - Required - id of process model to start
- **variables_** (ProcessVariable[]) - Required - parameters for the process model. If using a process variable of an Appian type, do not set the value to that object but instead to the corresponding primitive. For instance, do not assign a User process variable a `User` object. Instead, assign that process variable a `String` containing the username. Likewise, assign a process variable of type Group should be assigned a `Long`, etc. The exception to this rule is the People type. Process variables of type People should be assigned a `LocalObject`.
- **priorityId_** (Long) - Required - the priority with which to start the process

### Returns
- The id of the started process instance.

### Throws
- `InvalidPriorityException` - if the Priority does not exist
- `InvalidProcessModelException` - if the `ProcessModel` does not exist
- `PrivilegeException` - if the user does not have permission to perform this action
- `InvalidStateException` - if there is no published version of the specified pm, the published version is disabled, or if the process model contains sub process models that have been disabled or deleted. Note that all sub process models of a published process model must have been published, but they can still be disabled.
- `InvalidUserException` - if any user referenced in any `ProcessVariable` does not exist
- `IllegalArgumentException` - if the `ProcessModel` requires process parameters to start, and the `variables_` parameter is null, an empty array, or does not contain all necessary process parameters.
- `com.appiancorp.asl3.servicefw.connect.ServiceException` - if any system-level error occurs
- `Exception`
```

--------------------------------

### Get Attachments for Process (Deprecated)

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessExecutionService.html

Deprecated method to get all attachments for a given process.

```APIDOC
## getAttachmentsForProcess (Deprecated)

### Description
Gets all the attachments for a given process.

### Method Signature
`@Deprecated Attachment[] getAttachmentsForProcess(Long processId_)`

### Parameters
#### Path Parameters
- `processId_` (Long) - The ID of the process.

### Returns
The attachments.

### Throws
- `InvalidProcessException` - if the process specified does not exist.
- `PrivilegeException` - if the current user does not have privileges to perform this action.
- `ServiceException` - if any system-level error occurs.
```

--------------------------------

### ApplicationNavigation Constructor

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/applications/Application.ApplicationNavigation.html

Initializes a new instance of the ApplicationNavigation class.

```APIDOC
## ApplicationNavigation()

### Description
Initializes a new instance of the ApplicationNavigation class.

### Constructor
`ApplicationNavigation()`
```

--------------------------------

### Get Download Log Type

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/content/ContentService.html

Gets the type identifier used for download logging.

```APIDOC
## getDownloadLogType

### Description
Gets the download log type.

### Method Signature
`Integer getDownloadLogType()`
```

--------------------------------

### Get Security

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/common/RoleMap.html

Gets the security bitmap for an object. This is primarily used for Content objects.

```APIDOC
## getSecurity

### Description
Gets the security bitmap for the object. Only currently exists for Content. For possible values for Content, see ContentConstants.SEC_XXX. May be `null`.

### Method
public Integer getSecurity()

### Returns
The security map.
```

--------------------------------

### Initiate Process Permissions

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/security/ProcessModelPermissions.html

Methods to check and set permissions for starting processes from a process model.

```APIDOC
### isInitiateProcess
public boolean isInitiateProcess()
Determines whether the current user can start processes from the process model

Returns:
    `true` if the user can start a process from the process model, else `false`

### setInitiateProcess
public void setInitiateProcess(boolean initiateProcess_)

See Also:
    
      * `isInitiateProcess()`
```

--------------------------------

### Get Versions

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/collaboration/DocumentService.html

Gets specific versions of a document. Use `getVersionsPaging` for paginated results.

```APIDOC
## getVersions

### Description
Gets specific versions of a document.

### Method Signature
`Document[] getVersions(Long doid_, Integer[] versionIds_)`

### Parameters
* `doid_` (Long) - The ID of the document.
* `versionIds_` (Integer[]) - An array of version IDs to retrieve.

### Returns
* `Document[]` - An array of the requested document versions.

### Deprecated
Use `getVersionsPaging(java.lang.Long, java.lang.Integer[], int, int, java.lang.Integer, java.lang.Integer)`.
```

--------------------------------

### Process Execution

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessDesignService.html

Methods for starting and managing process instances.

```APIDOC
## startProcessVersion$UPDATES

### Description
Starts a new process instance from a specific process model version.

### Method
POST (assumed, based on naming convention)

### Endpoint
/processModels/{modelId}/versions/{versionNumber}/start

### Parameters
#### Path Parameters
- **modelId** (string) - Required - The unique identifier of the process model.
- **versionNumber** (integer) - Required - The version number of the process model to start.
#### Request Body
- **startParameters** (object) - Optional - Parameters required to start the process instance.
```

--------------------------------

### AbstractProcessNode Class Methods

Source: https://docs.appian.com/suite/help/25.4/api/index-all.html

Methods for setting start node properties in AbstractProcessNode.

```APIDOC
## setStartNode boolean

### Description
Used by tracking logic, this property is not always available. Sets whether this is a start node.

### Method
N/A (Java method signature)

### Parameters
- **startNode** (boolean) - Description not provided
```

--------------------------------

### Get and Set UUID

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/collaboration/Document.html

Gets or sets the UUID of the document. Note that these methods are deprecated.

```APIDOC
## getUuid

### Description
Gets the UUID of the document.

## setUuid

### Description
Sets the UUID of the document.

### Parameters
- `uuid` (String) - the UUID to set
```

--------------------------------

### ProcessStartConfig

Source: https://docs.appian.com/suite/help/25.4/api/allclasses-index.html

Specifies options and configurations that control behavior when starting a process.

```APIDOC
## ProcessStartConfig

### Description
Specifies options and configurations that control behavior when starting a process.

### Class
ProcessStartConfig
```

--------------------------------

### Get Content IDs Where Viewable

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/content/ContentService.html

Gets the specified content IDs that are viewable by the current user.

```APIDOC
## getContentIdsWhereViewable

### Description
Gets the specified content IDs where viewable, rather than giving an error that the content is not viewable.

### Method Signature
`Long[] getContentIdsWhereViewable(Long[] ids_)`

### Parameters
* **ids_** (Long[]) - An array of content IDs.
```

--------------------------------

### QuickFilter.getItems

Source: https://docs.appian.com/suite/help/25.4/api/index-all.html

Get the list of QuickFilterItems.

```APIDOC
## getItems()

### Description
Get the list of QuickFilterItems.

### Method
Instance method

### Class
com.appian.suiteapi.process.analytics2.QuickFilter
```

--------------------------------

### Get My Task Count

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/analytics2/ProcessAnalyticsService.html

Gets the total count of tasks assigned to or accepted by the current user.

```APIDOC
## getMyTaskCount

### Description
Gets the total number of tasks that are either assigned to or accepted by the current user.

### Method Signature
`int getMyTaskCount()`
```

--------------------------------

### startQuickTask

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessExecutionService.html

Starts a new task from the node. If the process to which the node belongs is cancelled or completed, then the process is reactivated.

```APIDOC
## startQuickTask

### Description
Starts a new task from the node. If the process to which the node belongs is cancelled or completed, then the process is reactivated.

### Method Signature
`Long startQuickTask(Long processId_, Long nodeId_)`
```

--------------------------------

### create

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/applications/ApplicationService.html

Creates a new application. Requires the user to have the necessary privileges.

```APIDOC
## create

### Description
Creates an application.

### Method
create

### Parameters
#### Path Parameters
- `application` (Application) - Required - The application object to be created.

### Returns
- `Long` - The id of the created application.

### Throws
- `InvalidApplicationException` - if the application is in an inconsistent state or if its identifier matches that of any of the existing applications.
- `PrivilegeException` - if the user does not have permission to perform this action.
```

--------------------------------

### Get Site Calendar Settings Clone

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/portal/GlobalizationService.html

Gets the calendar-specific settings for the site. This method is deprecated.

```APIDOC
## getSiteCalendarSettingsClone()

### Description
Gets the calendar specific settings for the site.

### Method
GET (assumed, as it's a retrieval method)

### Endpoint
/globalization/site/calendar/settings/clone (assumed)

### Response
#### Success Response (200)
- **SiteCalendarSettings** (SiteCalendarSettings) - The site's calendar settings.
```

--------------------------------

### ActivityExecutionMetadata Constructor

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/framework/ActivityExecutionMetadata.html

Initializes a new instance of the ActivityExecutionMetadata class.

```APIDOC
## ActivityExecutionMetadata()

### Description
Initializes a new instance of the ActivityExecutionMetadata class.

### Method
public ActivityExecutionMetadata()
```

--------------------------------

### Get Documents List

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/collaboration/DocumentService.html

Gets the specified documents, returning valid results even if some cannot be retrieved.

```APIDOC
## getDocumentsList

### Description
Gets the specified documents, returning the valid results even if all the results cannot be retrieved (for instance, if some of the documents corresponding to the ids no longer exist).

### Method Signature
`ResultList getDocumentsList(Long[] docIds_)`

### Parameters
* `docIds_` (Long[]) - An array of document IDs.

### Returns
* `ResultList` - A list containing the retrieved documents and information about any failures.

### Deprecated
This method is deprecated.
```

--------------------------------

### Create Application

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/applications/ApplicationService.html

Creates a new application.

```APIDOC
## create

### Description
Creates an application.

### Method Signature
`Long create(Application application)`
```

--------------------------------

### startTasks

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/ProcessExecutionService.html

Tries to start the tasks, and returns an array of result codes on whether the operation was successful or an error had occurred.

```APIDOC
## startTasks

### Description
Tries to start the tasks, and returns an array of result codes on whether the operation was successful or an error had occurred.

### Method Signature
`Integer[] startTasks(Long processId_, Long[] nodeIds_)`
```

--------------------------------

### ProcessStartingInfo Class

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/webservices/ProcessStartingInfo.html

Provides methods to get and set process model ID, service name, and parameters.

```APIDOC
## ProcessStartingInfo

### Description
Bean for process starting info.

### Constructor
`ProcessStartingInfo()`

### Methods
#### Getters
- `ProcessVariable[] getParameters()`: Gets the parameters for the process model.
- `Long getProcessModelId()`: Gets the process model id.
- `String getProcessModelServiceName()`: Gets the process model service name.

#### Setters
- `void setParameters(ProcessVariable[] parameters_)`: Sets the parameters for the process model.
- `void setProcessModelId(Long processModelId_)`: Sets the process model id.
- `void setProcessModelServiceName(String processModelServiceName_)`: Sets the process model service name.
```

--------------------------------

### Get Site Locale Settings Clone

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/portal/GlobalizationService.html

Gets the site locale settings for the site. This method is deprecated.

```APIDOC
## getSiteLocaleSettingsClone()

### Description
Gets the site locale settings for the site.

### Method
GET (assumed, as it's a retrieval method)

### Endpoint
/globalization/site/locale/settings/clone (assumed)

### Response
#### Success Response (200)
- **SiteLocaleSettings** (SiteLocaleSettings) - The site's locale settings.
```

--------------------------------

### getStartTime

Source: https://docs.appian.com/suite/help/25.4/api/index-all.html

Retrieves the time at which a process started.

```APIDOC
## getStartTime()

### Description
Retrieves the time at which the process started

### Method
(Not specified, likely a class method call)

### Endpoint
(Not specified)

### Parameters
None

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### Get Site Time Zone Settings Clone

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/portal/GlobalizationService.html

Gets the site timezone settings for the site. This method is deprecated.

```APIDOC
## getSiteTimeZoneSettingsClone()

### Description
Gets the site timezone settings for the site.

### Method
GET (assumed, as it's a retrieval method)

### Endpoint
/globalization/site/timezone/settings/clone (assumed)

### Response
#### Success Response (200)
- **SiteTimeZoneSettings** (SiteTimeZoneSettings) - The site's timezone settings.
```

--------------------------------

### Batch Size and Start Index

Source: https://docs.appian.com/suite/help/25.4/api/com/appiancorp/suiteapi/process/analytics2/ReportData.html

Methods for managing the batch size and start index for report data retrieval.

```APIDOC
## getBatchSize

### Description
Get the batch size.

### Method
GET

### Returns
int - the batch size

## setBatchSize

### Description
Set the batch size.

### Method
POST

### Parameters
#### Request Body
- `batchSize_` (int) - Required - the batch size

## getStartIndex

### Description
Get the start index.

### Method
GET

### Returns
int - the start index

## setStartIndex

### Description
Set the start index.

### Method
POST

### Parameters
#### Request Body
- `startIndex_` (int) - Required - the start index
```