# Citizen Platform Experience API

Manage flows, connections, connectors, and metadata for Anypoint Composer.

- **Version:** 0.1.0
- **Category:** Platform
- **OpenAPI Spec:** [api.yaml](https://dev-portal.mulesoft.com/apis/citizen-platform-experience/api.yaml)

## Servers
- `http://composer.mulesoft.com/citizen-xapi/api/v1`
- `https://composer.mulesoft.com/citizen-xapi/api/v1`

## Operations (29)
### GET /organizations/{organizationId}/flows

**Operation ID:** `getOrganizationsByOrganizationidFlows`
Gets the authenticated user Flows.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |

### POST /organizations/{organizationId}/flows

**Operation ID:** `createOrganizationsByOrganizationidFlows`
Creates a new flow.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |

### GET /organizations/{organizationId}/flows/{flowId}

**Operation ID:** `getOrganizationsByOrganizationidFlowsByFlowid`
Retrieves a flow.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `flowId` | query | The flow ID to identify the target resource. | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |

### PUT /organizations/{organizationId}/flows/{flowId}

**Operation ID:** `updateOrganizationsByOrganizationidFlowsByFlowid`
Save changes in a flow.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `flowId` | query | The flow ID to identify the target resource. | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |

### DELETE /organizations/{organizationId}/flows/{flowId}

**Operation ID:** `deleteOrganizationsByOrganizationidFlowsByFlowid`
Deletes a flow

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `flowId` | query | The flow ID to identify the target resource. | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |

### POST /organizations/{organizationId}/flows/{flowId}/clone

**Operation ID:** `createOrganizationsByOrganizationidFlowsByFlowidClone`
Clones a Flow with the same content as the previous flow

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `flowId` | query | The flow ID to identify the target resource. | required |

### POST /organizations/{organizationId}/flows/{flowId}/execute

**Operation ID:** `createOrganizationsByOrganizationidFlowsByFlowidExecute`
Leaves a flow running.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `flowId` | query | The flow ID to identify the target resource. | required |

### POST /organizations/{organizationId}/flows/{flowId}/stop

**Operation ID:** `createOrganizationsByOrganizationidFlowsByFlowidStop`
Stops the execution of a given flow.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `flowId` | query | The flow ID to identify the target resource. | required |

### GET /organizations/{organizationId}/flows/{flowId}/status

**Operation ID:** `getOrganizationsByOrganizationidFlowsByFlowidStatus`
Returns the status of a given flow.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `flowId` | query | The flow ID to identify the target resource. | required |

### POST /organizations/{organizationId}/flows/{flowId}/test

**Operation ID:** `createOrganizationsByOrganizationidFlowsByFlowidTest`
Starts a test for a flow.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `flowId` | query | The flow ID to identify the target resource. | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |
| `X-Session-Id` | query | The X Session  ID header value. | required |

### DELETE /organizations/{organizationId}/flows/{flowId}/test

**Operation ID:** `deleteOrganizationsByOrganizationidFlowsByFlowidTest`
Stops a test for a flow.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `flowId` | query | The flow ID to identify the target resource. | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |
| `X-Session-Id` | query | The X Session  ID header value. | required |

### GET /organizations/{organizationId}/flows/{flowId}/test-status

**Operation ID:** `getOrganizationsByOrganizationidFlowsByFlowidTestStatus`
Returns the status of a flow test.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `flowId` | query | The flow ID to identify the target resource. | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |
| `X-Session-Id` | query | The X Session  ID header value. | required |

### GET /organizations/{organizationId}/flows/{flowId}/test-messages

**Operation ID:** `getOrganizationsByOrganizationidFlowsByFlowidTestMessages`
Returns the messages of a flow test.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `flowId` | query | The flow ID to identify the target resource. | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |
| `X-Session-Id` | query | The X Session  ID header value. | required |

### GET /organizations/{organizationId}/connectors

**Operation ID:** `getOrganizationsByOrganizationidConnectors`
Returns all the connectors available for the current user.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |

### GET /organizations/{organizationId}/connectors/{connectorName}

**Operation ID:** `getOrganizationsByOrganizationidConnectorsByConnectorname`
Retrieves a connectors.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `connectorName` | query | Name of the connectors whose citizen model will be returned | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |

### POST /organizations/{organizationId}/connectors/{connectorName}/sample-data

**Operation ID:** `createOrganizationsByOrganizationidConnectorsByConnectornameSampleData`
Returns the sample data for a connector.

**Parameters:**
| `refresh` | query | Indicates if cache should be invalidated or not | optional |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `connectorName` | query | Name of the connectors whose citizen model will be returned | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |
| `X-Session-Id` | query | The X Session  ID header value. | required |

### POST /organizations/{organizationId}/connectors/{connectorName}/entity-provider

**Operation ID:** `createOrganizationsByOrganizationidConnectorsByConnectornameEntityProvider`
Returns the entity provider data for a connector.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `connectorName` | query | Name of the connectors whose citizen model will be returned | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |
| `X-Session-Id` | query | The X Session  ID header value. | required |

### POST /organizations/{organizationId}/connectors/{connectorName}/connections/{connectionId}/value-resolver

**Operation ID:** `createOrganizationsByOrganizationidConnectorsByConnectornameConnectionsByConnectionidValueResolver`
Returns the data from a data provider.

**Parameters:**
| `refresh` | query | Indicates if cache should be invalidated or not | optional |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `connectorName` | query | Name of the connectors whose citizen model will be returned | required |
| `connectionId` | query | The connection ID to identify the target resource. | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |
| `X-Session-Id` | query | The X Session  ID header value. | required |

### POST /organizations/{organizationId}/connectors/{connectorName}/connections/{connectionId}/metadata

**Operation ID:** `createOrganizationsByOrganizationidConnectorsByConnectornameConnectionsByConnectionidMetadata`
Returns the metadata for a connector.

**Parameters:**
| `refresh` | query | Indicates if cache should be invalidated or not | optional |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `connectorName` | query | Name of the connectors whose citizen model will be returned | required |
| `connectionId` | query | The connection ID to identify the target resource. | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |
| `X-Session-Id` | query | The X Session  ID header value. | required |

### GET /organizations/{organizationId}/connection-schemas/connectors/{connectorName}

**Operation ID:** `getOrganizationsByOrganizationidConnectionSchemasConnectorsByConnectorname`
Get all available connector connection schemas.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `connectorName` | query | The connectorName to identify the target resource. | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |

### GET /organizations/{organizationId}/connections

**Operation ID:** `getOrganizationsByOrganizationidConnections`
Get all available connections.

**Parameters:**
| `offset` | query | First ordered item that you want to retrieve | optional |
| `limit` | query | Maximum number of items returned | optional |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |

### POST /organizations/{organizationId}/connections

**Operation ID:** `createOrganizationsByOrganizationidConnections`
Creates a new **non-OAuth** connection. For starting OAuth dance, please use `/ocs-connections`.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |

### GET /organizations/{organizationId}/connections/connectors/{connectorName}

**Operation ID:** `getOrganizationsByOrganizationidConnectionsConnectorsByConnectorname`
Retrieves a connectors.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `connectorName` | query | Identifies the connector name. | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |

### GET /organizations/{organizationId}/connections/{connectionId}

**Operation ID:** `getOrganizationsByOrganizationidConnectionsByConnectionid`
Retrive a single connection by ID.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `connectionId` | query | The connection ID to identify the target resource. | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |

### PATCH /organizations/{organizationId}/connections/{connectionId}

**Operation ID:** `patchOrganizationsByOrganizationidConnectionsByConnectionid`
Update a connection.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `connectionId` | query | The connection ID to identify the target resource. | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |

### DELETE /organizations/{organizationId}/connections/{connectionId}

**Operation ID:** `deleteOrganizationsByOrganizationidConnectionsByConnectionid`
Delete a connection.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `connectionId` | query | The connection ID to identify the target resource. | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |

### POST /organizations/{organizationId}/connections/{connectionId}/test

**Operation ID:** `createOrganizationsByOrganizationidConnectionsByConnectionidTest`
Test the connectivity of an existing connection.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `connectionId` | query | The connection ID to identify the target resource. | required |
| `x-session-id` | query | Flow session ID. | optional |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |

### POST /organizations/{organizationId}/connections/test

**Operation ID:** `createOrganizationsByOrganizationidConnectionsTest`
Test the connectivity of a draft connection.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `x-session-id` | query | Flow session ID. | optional |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |

### POST /organizations/{organizationId}/ocs-connections

**Operation ID:** `createOrganizationsByOrganizationidOcsConnections`
Starts the OAuth dance (OCS).

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `Access-Control-Allow-Origin` | query | The Access Control Allow Origin header value. | required |