IBM App Connect Professional

https://www.ibm.com/docs/en/app-connect-pro
Admin
IBM App Connect Professional provides robust integration capabilities to connect applications and...
Tokens:886,949
Snippets:6,548
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### SOAP Get User Response Example

Source: https://www.ibm.com/docs/en/app-connect-pro/7.5_topic=guide-overview-management-api

An example of a SOAP response to a get user request. It returns detailed user information including ID, name, email, and status.

```xml
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
 <S:Body>
  <ns2:getUserResponse xmlns:ns2="http://www.approuter.com/schemas/2008/1/
  security" xmlns:ns3="http://www.approuter.com/schema/router/1000/security/03">
   <ns2:user>
    <ns3:id>8F059BEEA3611033D277773A95404641</ns3:id>
    <ns3:name>webuser</ns3:name>
    <ns3:encPasswd>{SHA}clO20r2ZJMJcDrNwXQzhWB8YcdI=</ns3:encPasswd>
    <ns3:displayName>WebServiceUser</ns3:displayName>
    <ns3:isActive>true</ns3:isActive>
    <ns3:isMutable>true</ns3:isMutable>
    <ns3:isVisible>true</ns3:isVisible>
    <ns3:email>webuser@mycompany.com</ns3:email>
    <ns3:createdTime>2010-03-02T22:11:32.935Z</ns3:createdTime>
    <ns3:failedLoginCount>0</ns3:failedLoginCount>
    <ns3:scopeId>B47EAECF6AD14AA028B4EA038CB742D0</ns3:scopeId>
    <ns3:scopeType>Tenant</ns3:scopeType>
   </ns2:user>
  </ns2:getUserResponse>
 </S:Body>
</S:Envelope>
```

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

### SOAP API - Get Rule Example

Source: https://www.ibm.com/docs/en/app-connect-pro/7.5_topic=deployment-getrule

This section provides an example of a SOAP request to retrieve rule details from IBM App Connect Pro.

```APIDOC
## POST /soap/rules

### Description
This endpoint allows you to retrieve details of a specific rule using a SOAP request.

### Method
POST

### Endpoint
/soap/rules

### Parameters
#### Request Body
- **sessionId** (string) - Required - The session identifier for authentication.
- **ruleId** (integer) - Required - The unique identifier of the rule to retrieve.

### Request Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:dep="http://www.approuter.com/schemas/2008/1/deployment">
 <soapenv:Header>
  <dep:sessionId>8FDBC8ED7A014272714D23D14794473A</dep:sessionId>
 </soapenv:Header>
 <soapenv:Body>
  <dep:getRule>
   <dep:ruleId>2</dep:ruleId>
  </dep:getRule>
 </soapenv:Body>
</soapenv:Envelope>
```

### Response
#### Success Response (200)
- **rule** (object) - Contains the details of the requested rule.
  - **configUrl** (string) - The configuration URL for the rule.
  - **downtimeType** (string) - The type of downtime associated with the rule.
  - **envId** (object) - Environment identifier.
    - **guidString** (string) - The GUID string of the environment.
  - **isActive** (boolean) - Indicates if the rule is active.
  - **repeatInterval** (integer) - The interval for repeating the rule.
  - **repeatType** (string) - The type of repetition for the rule.
  - **repeatingRule** (boolean) - Indicates if the rule is a repeating rule.
  - **restartDate** (string) - The start date and time for the rule.
  - **ruleId** (integer) - The unique identifier of the rule.
  - **stopDate** (string) - The stop date and time for the rule.

#### Response Example
```xml
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
 <S:Body>
  <ns2:getRuleResponse xmlns:ns2="http://www.approuter.com/schemas/2008/1/
deployment" xmlns:ns3="http://www.approuter.com/schemas/2008/1/deployment/
types" xmlns:ns4="http://www.approuter.com/schema/router/1000/security/03"
xmlns:ns5="http://www.approuter.com/schemas/2008/1/util/types">
   <ns2:rule>
    <ns3:configUrl>config-url://GenericProject_1_Cloud:1.0:Default</
    ns3:configUrl>
    <ns3:downtimeType>stop</ns3:downtimeType>
    <ns3:envId>
     <guidString>A7FFE81243A1E319FCAED0DFABF9470B</guidString>
    </ns3:envId>
    <ns3:isActive>true</ns3:isActive>
    <ns3:repeatInterval>0</ns3:repeatInterval>
    <ns3:repeatType>none</ns3:repeatType>
    <ns3:repeatingRule>false</ns3:repeatingRule>
    <ns3:restartDate>2010-04-17T08:00:00.066Z</ns3:restartDate>
    <ns3:ruleId>2</ns3:ruleId>
    <ns3:stopDate>2010-04-17T07:00:00.066Z</ns3:stopDate>
   </ns2:rule>
  </ns2:getRuleResponse>
 </S:Body>
</S:Envelope>
```
```

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

### SOAP Request to Check Staging Database Status

Source: https://www.ibm.com/docs/en/app-connect-pro/7.5_topic=staging-isstagingdatabasestarted

This section provides an example of a SOAP request used to determine if the staging database is started. It includes the necessary XML structure for the request, including headers and the body.

```APIDOC
## POST /staging/database/check

### Description
Sends a SOAP request to check if the staging database is started.

### Method
POST

### Endpoint
`/staging/database/check`

### Request Body
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:stag="http://www.approuter.com/schemas/2008/1/staging">
 <soapenv:Header>
  <stag:sessionId>91997FBCE89093792D40DEF8FDB345DD</stag:sessionId>
 </soapenv:Header>
 <soapenv:Body>
  <stag:isStagingDatabaseStarted/>
 </soapenv:Body>
</soapenv:Envelope>
```

### Response
#### Success Response (200)
Returns a SOAP response indicating whether the staging database is started.

#### Response Example
```xml
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
 <S:Body>
  <isStagingDatabaseStartedResponse xmlns="http://www.approuter.com/
  schemas/2008/1/staging">
   <isStarted>true</isStarted>
  </isStagingDatabaseStartedResponse>
 </S:Body>
</S:Envelope>
```
```

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

### SOAP Get User Request Example

Source: https://www.ibm.com/docs/en/app-connect-pro/7.5_topic=guide-overview-management-api

An example of a SOAP request to retrieve user information. It requires the sessionId obtained from a successful login and the username of the user to fetch.

```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sec="http://www.approuter.com/schemas/2008/1/security">
 <soapenv:Header>
  <sec:sessionId>8F059BEEA3611033D277773A95404641</sec:sessionId>
 </soapenv:Header>
 <soapenv:Body>
  <sec:getUser>
   <sec:username>webuser</sec:username>
  </sec:getUser>
 </soapenv:Body>
</soapenv:Envelope>
```

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

### Start Configuration API

Source: https://www.ibm.com/docs/en/app-connect-pro/7.5_topic=deployment-start

Starts the specified configuration. This API applies to Clouds and Integration Appliances.

```APIDOC
## POST /start

### Description
Starts the specified configuration. This API applies to Clouds and Integration Appliances.

### Method
POST

### Endpoint
/start

### Parameters
#### Query Parameters
- **projectName** (string) - Required - The name of the specified project.
- **version** (string) - Required - The version number for the specified project.
- **configName** (string) - Required - The configuration name for the specified project. Together projectName, version, and configName uniquely identify a configuration.

### Request Example
```json
{
  "projectName": "exampleProject",
  "version": "1.0.0",
  "configName": "exampleConfig"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success or failure of the operation.

#### Response Example
```json
{
  "status": "Success"
}
```
```

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

### App Connect Management API Guide

Source: https://www.ibm.com/docs/en/app-connect-pro/7.5_topic=provided-finance-charge-terms

This section outlines the App Connect Management API, which allows programmatic interaction with App Connect Professional functionalities. It details available endpoints, parameters, and usage examples for managing projects, orchestrations, and other related resources.

```APIDOC
## App Connect Management API Guide

### Description
This API provides endpoints for managing and interacting with App Connect Professional resources programmatically. It allows for tasks such as deploying integrations, monitoring their status, and retrieving execution logs.

### Method
GET, POST, PUT, DELETE (Specific methods depend on the endpoint)

### Endpoint
`/api/v1/...` (Specific endpoints to be detailed within the guide)

### Parameters
Detailed path, query, and request body parameters will be defined for each specific API endpoint within the full documentation.

### Request Example
```json
{
  "example": "POST /api/v1/integrations/deploy"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **message** (string) - Provides details about the operation's outcome.

#### Response Example
```json
{
  "status": "success",
  "message": "Integration deployed successfully."
}
```
```

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

### Valid and Invalid SOSL Parameter Declarations

Source: https://www.ibm.com/docs/en/app-connect-pro/7.5_topic=sa-configuring-query-objects-activity

Demonstrates valid and invalid examples of parameter declarations in SOSL for App Connect. Parameters are denoted by a '$' sign followed by alphanumeric characters, starting with a letter. Invalid examples show incorrect starting characters or the use of underscores.

```SOSL
Parameter| Valid or Invalid  
---|---
$AnAccount| valid  
$a123_456| valid  
$123a| invalid  
$_id| invalid  
```

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

### Start Configuration in Development Environment (SOAP Request)

Source: https://www.ibm.com/docs/en/app-connect-pro/7.5_topic=guide-overview-management-api

This SOAP request initiates a specific configuration ('HTTP_363j') for a project ('HTTP_363i') with version '1.0' in the currently set development environment. It requires a session ID.

```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:dep="http://www.approuter.com/schemas/2008/1/deployment">
 <soapenv:Header>
  <dep:sessionId>63Y93HD6D856EB5812EB71216C3547W7</dep:sessionId>
 </soapenv:Header>
 <soapenv:Body>
  <dep:start>
   <dep:projectName>HTTP_363i</dep:projectName>
   <dep:version>1.0</dep:version>
   <dep:configName>HTTP_363j</dep:configName>
  </dep:start>
 </soapenv:Body>
</soapenv:Envelope>
```

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

### SOAP Request to Start IBM App Connect Configuration

Source: https://www.ibm.com/docs/en/app-connect-pro/7.5_topic=deployment-start

This XML snippet demonstrates a SOAP request to initiate the starting of a configuration within IBM App Connect Professional. It includes the necessary header with a session ID and the body with project, version, and configuration names.

```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:dep="http://www.approuter.com/schemas/2008/1/deployment">
 <soapenv:Header>
  <dep:sessionId>85EBDCE6FF0685C296D79CD55D86405F</dep:sessionId>
 </soapenv:Header>
 <soapenv:Body>
  <dep:start>
   <dep:projectName>HTTP_363i</dep:projectName>
   <dep:version>1.0</dep:version>
   <dep:configName>HTTP_363j</dep:configName>
  </dep:start>
 </soapenv:Body>
</soapenv:Envelope>
```

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

### Get SNMP Endpoint SOAP Example

Source: https://www.ibm.com/docs/en/app-connect-pro/7.5_topic=lognotif-getsnmpendpoint

This section provides an example of a SOAP request to retrieve an SNMP endpoint using the App Connect Pro API.

```APIDOC
## POST /soap/endpoint/snmp

### Description
This endpoint allows you to retrieve SNMP endpoint configurations. It uses a SOAP request to specify the action.

### Method
POST

### Endpoint
`/soap/endpoint/snmp`

### Parameters
#### Request Body
- **sessionId** (string) - Required - The session identifier for authentication.

### Request Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:log="http://www.approuter.com/schemas/2008/1/lognotif">
 <soapenv:Header>
  <log:sessionId>910D9A7B441C97AC2FCC54E3F1274AA7</log:sessionId>
 </soapenv:Header>
 <soapenv:Body>
  <log:getSnmpEndpoint/>
 </soapenv:Body>
</soapenv:Envelope>
```

### Response
#### Success Response (200)
- **snmpEndpoint** (object) - Contains the details of the SNMP endpoint.
  - **active** (boolean) - Indicates if the endpoint is active.
  - **community** (string) - The SNMP community string.
  - **host** (string) - The hostname or IP address of the SNMP endpoint.

#### Response Example
```xml
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
 <S:Body>
  <ns2:getSnmpEndpointResponse xmlns:ns2="http://www.approuter.com/
  schemas/2008/1/lognotif" xmlns:ns3="http://www.approuter.com/schemas/2008/1/
  lognotif/types">
   <ns2:snmpEndpoint>
    <ns3:active>true</ns3:active>
    <ns3:community>Test</ns3:community>
    <ns3:host>hq-exch-01</ns3:host>
   </ns2:snmpEndpoint>
  </ns2:getSnmpEndpointResponse>
 </S:Body>
</S:Envelope>
```
```

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

### App Connect Management API Guide

Source: https://www.ibm.com/docs/en/app-connect-pro/7.5_topic=activities-search-files-activity

This API provides capabilities for managing App Connect Professional instances, such as deploying integrations, monitoring status, and configuring resources.

```APIDOC
## App Connect Management API

### Description
This API allows for the programmatic management of App Connect Professional resources and integrations. It enables tasks like deployment, monitoring, and configuration.

### Endpoints

#### List Integrations
- **Description**: Retrieves a list of all deployed integrations.
- **Method**: GET
- **Endpoint**: `/management/integrations`

#### Deploy Integration
- **Description**: Deploys a new integration or updates an existing one.
- **Method**: POST
- **Endpoint**: `/management/integrations/deploy`
- **Request Body**:
  - **integrationName** (string) - Required - The name of the integration.
  - **integrationContent** (string) - Required - The content of the integration.

#### Get Integration Status
- **Description**: Retrieves the operational status of a specific integration.
- **Method**: GET
- **Endpoint**: `/management/integrations/{integrationId}/status`
- **Path Parameters**:
  - **integrationId** (string) - Required - The unique identifier of the integration.

#### Delete Integration
- **Description**: Deletes a deployed integration.
- **Method**: DELETE
- **Endpoint**: `/management/integrations/{integrationId}`
- **Path Parameters**:
  - **integrationId** (string) - Required - The unique identifier of the integration.

#### List Configurations
- **Description**: Retrieves a list of available configurations.
- **Method**: GET
- **Endpoint**: `/management/configurations`

#### Create Configuration
- **Description**: Creates a new configuration.
- **Method**: POST
- **Endpoint**: `/management/configurations`
- **Request Body**:
  - **configName** (string) - Required - The name of the configuration.
  - **configDetails** (object) - Required - The details of the configuration.

#### Get Configuration
- **Description**: Retrieves details of a specific configuration.
- **Method**: GET
- **Endpoint**: `/management/configurations/{configName}`
- **Path Parameters**:
  - **configName** (string) - Required - The name of the configuration.

#### Delete Configuration
- **Description**: Deletes a specific configuration.
- **Method**: DELETE
- **Endpoint**: `/management/configurations/{configName}`
- **Path Parameters**:
  - **configName** (string) - Required - The name of the configuration.

### Request Example (Deploy Integration)
```json
{
  "integrationName": "my-new-integration",
  "integrationContent": "<integration><process>...</process></integration>"
}
```

### Response Example (Integration Status)
```json
{
  "status": "running",
  "health": "ok"
}
```
```

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

### Start Staging Database

Source: https://www.ibm.com/docs/en/app-connect-pro/7.5_topic=staging-startstagingdatabase

Starts the staging database for App Connect Professional Integration Appliances. Returns success or failure status.

```APIDOC
## startStagingDatabase

### Description
Starts the staging database. Returns success if the database starts or failure if the database fails to start. Applies to Integration Appliances only.

### Method
POST

### Endpoint
/staging/startStagingDatabase

### Parameters

#### Query Parameters

#### Request Body

### Request Example
```json
{
  "message": "Starting staging database..."
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates whether the staging database started successfully or failed.

#### Response Example
```json
{
  "status": "success"
}
```
```

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

### SOAP Request to Start Staging Database

Source: https://www.ibm.com/docs/en/app-connect-pro/7.5_topic=staging-startstagingdatabase

This XML snippet represents a SOAP request to initiate the staging database. It includes a session ID in the header and a start staging database command in the body. This is a common pattern for managing staging environments.

```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:stag="http://www.approuter.com/schemas/2008/1/staging">
 <soapenv:Header>
  <stag:sessionId>91997FBCE89093792D40DEF8FDB345DD</stag:sessionId>
 </soapenv:Header>
 <soapenv:Body>
  <stag:startStagingDatabase/>
 </soapenv:Body>
</soapenv:Envelope>
```

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

### Get Users SOAP Request

Source: https://www.ibm.com/docs/en/app-connect-pro/7.5_topic=security-getusers

This example demonstrates a SOAP request to retrieve user information. The request requires a session ID in the header.

```APIDOC
## POST /api/users (SOAP)

### Description
This endpoint retrieves a list of users from the system. It requires a valid session ID for authentication.

### Method
POST

### Endpoint
/api/users (SOAP)

### Parameters
#### Request Body
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sec="http://www.approuter.com/schemas/2008/1/security">
 <soapenv:Header>
  <sec:sessionId>YOUR_SESSION_ID</sec:sessionId>
 </soapenv:Header>
 <soapenv:Body>
  <sec:getUsers/>
 </soapenv:Body>
</soapenv:Envelope>
```

### Response
#### Success Response (200)
Returns a SOAP XML response containing a list of users. Each user object includes details such as ID, name, email, and status.

#### Response Example
```xml
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
 <S:Body>
  <ns2:getUsersResponse xmlns:ns2="http://www.approuter.com/
  schemas/2008/1/security" xmlns:ns3="http://www.approuter.com/schema/
  router/1000/security/03">
   <ns2:users>
    <ns3:id>860DDF6E8DE511EF0EA8E249A1514EA1</ns3:id>
    <ns3:name>foo@mycompany.com</ns3:name>
    <ns3:encPasswd>{SHA}L84w50sj87W4IQUhr2NqKsuO8kI=</ns3:encPasswd>
    <ns3:displayName>Foo</ns3:displayName>
    <ns3:isActive>true</ns3:isActive>
    <ns3:isMutable>true</ns3:isMutable>
    <ns3:isVisible>true</ns3:isVisible>
    <ns3:email>foo@mycompany.com</ns3:email>
    <ns3:createdTime>2010-02-24T23:12:10.252Z</ns3:createdTime>
    <ns3:failedLoginCount>0</ns3:failedLoginCount>
    <ns3:scopeId>B47EAECF6AD14AA028B4EA038CB742D0</ns3:scopeId>
    <ns3:scopeType>Tenant</ns3:scopeType>
   </ns2:users>
   </ns2:getUsersResponse>
 </S:Body>
</S:Envelope>
```

### User Object Fields:
- **id** (string) - The ID for the user.
- **name** (string) - The name for the user.
- **encPasswd** (string) - The SHA encoded password for the user.
- **displayName** (string) - The name displayed in the WMC for the user.
- **isActive** (boolean) - True if the user is logged in, false otherwise.
- **isMutable** (boolean) - True if the object can be updated, false if not.
- **isVisible** (boolean) - True if the object is visible in the WMC, false if not.
- **email** (string) - The email address for the user.
- **createdTime** (datetime) - The date and time the user was created.
- **failedLoginCount** (integer) - The number of failed attempts to log in.
- **scopeId** (string) - The scope ID for the scope where the user is located.
- **scopeType** (string) - The type of scope (tenant or environment).
```

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

### Get Role Information (SOAP)

Source: https://www.ibm.com/docs/en/app-connect-pro/7.5_topic=security-getrole

This section provides an example of a SOAP request to retrieve a specific role's information and its corresponding SOAP response.

```APIDOC
## POST /security/role

### Description
This endpoint allows you to retrieve information about a specific security role using a SOAP request.

### Method
POST

### Endpoint
/security/role

### Parameters
#### Request Body
- **sessionId** (string) - Required - The session ID for authentication.
- **name** (string) - Required - The name of the role to retrieve.

### Request Example
```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sec="http://www.approuter.com/schemas/2008/1/security">
 <soapenv:Header>
  <sec:sessionId>BC77BA76E338CFA6B0063218A0AE4656</sec:sessionId>
 </soapenv:Header>
 <soapenv:Body>
  <sec:getRole>
   <sec:name>publisher@A347B0C49C8CFA462D4F28A4C05B47C2</sec:name>
  </sec:getRole>
 </soapenv:Body>
</soapenv:Envelope>
```

### Response
#### Success Response (200)
- **id** (string) - The ID for the role.
- **name** (string) - The name of the role.
- **displayName** (string) - The name displayed in the WMC for the role.
- **isActive** (boolean) - True or false depending on whether the role is active.
- **isMutable** (boolean) - True or false. True means that the object can be updated.
- **isVisible** (boolean) - True or false. True means that the object is visible in the WMC.
- **email** (string) - The email address for the role.
- **createdTime** (string) - The date and time the role was created. The time is compliant with ISO 8601.
- **scopeId** (string) - The ID of the scope where the role is found. (Cloud only.)
- **scopeType** (string) - The type of scope, either tenant or environment. (Cloud only.)
- **groupType** (string) - The type of group to which the role belongs.

#### Response Example
```xml
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
 <S:Body>
  <ns2:getRoleResponse xmlns:ns2="http://www.approuter.com/schemas/2008/1/security" xmlns:ns3="http://www.approuter.com/schema/router/1000/security/03">
   <ns2:group>
    <ns3:id>903273B869AC8CA9D99F4C8448694680</ns3:id>
    <ns3:name>publisher@A347B0C49C8CFA462D4F28A4C05B47C2</ns3:name>
    <ns3:displayName>Publisher Group</ns3:displayName>
    <ns3:isActive>true</ns3:isActive>
    <ns3:isMutable>false</ns3:isMutable>
    <ns3:isVisible>true</ns3:isVisible>
    <ns3:createdTime>2010-04-10T00:08:23Z</ns3:createdTime>
    <ns3:scopeId>A347B0C49C8CFA462D4F28A4C05B47C2</ns3:scopeId>
    <ns3:scopeType>Environment</ns3:scopeType>
    <ns3:groupType>Publisher</ns3:groupType>
   </ns2:group>
  </ns2:getRoleResponse>
 </S:Body>
</S:Envelope>
```
```

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

### SOAP Request to Get SNMP Endpoint

Source: https://www.ibm.com/docs/en/app-connect-pro/7.5_topic=lognotif-getsnmpendpoint

This is an example of a SOAP request sent to retrieve an SNMP endpoint configuration. It includes a session ID in the header and an empty body for the getSnmpEndpoint operation. The request is formatted in XML.

```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:log="http://www.approuter.com/schemas/2008/1/lognotif">
 <soapenv:Header>
  <log:sessionId>910D9A7B441C97AC2FCC54E3F1274AA7</log:sessionId>
 </soapenv:Header>
 <soapenv:Body>
  <log:getSnmpEndpoint/>
 </soapenv:Body>
</soapenv:Envelope>
```

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

### Substring Function Example

Source: https://www.ibm.com/docs/en/app-connect-pro/7.5_topic=reference-substring-function

Demonstrates how to use the Substring function to extract a portion of a string. It takes the original string, a starting position (1-based index), and an optional number of characters to extract as input. The function returns the specified substring.

```text
substring('abcde', 3, 2) = 'cd'
```

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

### POST /resume

Source: https://www.ibm.com/docs/en/app-connect-pro/7.5_topic=deployment-resume

Resumes the specified configuration. This operation applies to both Cloud and Integration Appliance deployments.

```APIDOC
## POST /resume

### Description
Resumes the specified configuration. This operation applies to both Cloud and Integration Appliance deployments.

### Method
POST

### Endpoint
/resume

### Parameters
#### Query Parameters
- **projectName** (string) - Required - The name of the specified project.
- **version** (string) - Required - The version number for the specified project.
- **configName** (string) - Required - The configuration name for the specified project. Together projectName, version, and configName uniquely identify a configuration.

### Request Example
```json
{
  "projectName": "myProject",
  "version": "1.0.0",
  "configName": "myConfig"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success or failure of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```
Tokens:
Raw