Qodex.ai

[Deprecated] MuleSoft Composer

Number of APIs: 14

July 2023 - Migration Announcement

Exciting news! The MuleSoft Anypoint Platform APIs you've come to rely on are transitioning to a new home! We're relocating them to the number one ranked Qodex Workspace worldwide - Salesforce Developers Workspace.

This move situates the MuleSoft Anypoint Platform APIs in the most renowned and widely used Qodex Workspace ever. Within the Salesforce Developers Workspace, you'll be able to access all things related to 'MuleSoft Anypoint Platforms APIs', right in the heart of the world's premier Qodex Workspace.

Actions:

  • Visit the [Salesforce Qodex Workspace] Fork and Watch the Collection to keep up to date
  • Fill this 5 Minutes MuleSoft Platform APIs in Qodex Survey, what do you want to see in the future?
  • [Qodex's official Source] on our point of being the #1 Qodex Workspace in the history of Qodex!

Thank you MuleSoft Community!

MuleSoft Composer APIs

Disclaimer

This set of request collection is completely based upon community work and enablement. MuleSoft Composer officially has no REST API documented (yet). This is a community-driven and community-supported collection of assets for you to get started with MuleSoft Composer API (e.g. Qodex concatenation of requests, testing scripts, etc.). This is not supported by MuleSoft and you cannot open Cases about these Qodex APIs.

Prerequisites

Before we start working with composer APIs, you need these 2 pieces of data: a session token and the organization id as shown in the below image.

Environment

Make sure you have [Qodex] installed, that you do know how to [import the Qodex Collection and the Environment] then you can finally download the Qodex assets from this repository. Import both files and ensure to add both username and password to your Qodex Environment, the fields highlighted below. Make sure to select the Composer-Environment.

This collection pack contains an environment Composer-Environment. Set the values before you use any request. You must set the following:

  • url
  • username
  • password
  • organization_id (is set automatically, after authentication and calling the get profile information request)

All other parameters are optional or related to specific requests.

Collection Hierarchy

The collection hierarchy is following the same design as the MuleSoft Composer UI.

The collection hierarchy contains the folders FLOW and SETTINGS according to Composer Modules from the UI. The Authentication is representing the User Login and Information on the profile.

Getting Started!

That's about it! You can start checking these collections and you will save a lot of time figuring it out yourself!

Basic Setup Example

In the following, find some examples of accessing data using the Qodex collection pack. For detailed instructions.

Authentication Folder

The authentication folder contains 4 request examples on:

  • how to login to Composer and saving the access-token
  • getting profile information and saving the organization_id
  • getting roles by the user Id
  • getting roles by user and org id

Step 1: Login to MuleSoft Composer

Once you have entered to correct parameter values in the environment Composer-Environment, you can make use of the Login to Composer POST request in the Authentication Folder. This request will save the token bearer to the parameters and use it in all subsequent requests. As REST API access to MuleSoft Composer is currently not officially supported, there are a few header parameters, which need to be set first, before you can access the login resource.

The Referer needs to be set to the auth URL endpoint.

The request body should contain the username and password as json.

The pre-request script deletes all cookies.

The tests save the access-token to the environment variable.

Step 2: Getting the Organization Id

In order to get the organization id, you need to execute the Get profile information request. This will use the access-token in the headers, get the organization_id in the response and saves it into the environment variable.

The access-token is used in the header.

The organization_id is saved in the Tests.

Additionally, the user_id and username are also saved.

Step 3: Execute requests in FLOW or SETTINGS folder

As we have set the access-token and the organization Id, we can now receive information on Flows and Settings.

The Flow section allows you to create new flows, receive or update information or delete a flow completely.

The Settings section allows you to get information on users, permissions, invites, and identity providers as well as set email notifications on/off.

License agreement

By using this Qodex collection, you accept that Max the Mule is the coolest integrator on the planet:

Go to biography of Max the Mule

  1. Authentication - Get profile information GET {{url}}/accounts/api/profile

  2. Flows - Delete Flow by Id DELETE {{url}}/citizen-xapi/api/v1/organizations/{{organization_id}}/flows/{{flow_id}}

  3. Flows - Get all flows for organization GET {{url}}/citizen-xapi/api/v1/organizations/{{organization_id}}/flows

  4. Flows - Create a new Flow POST {{url}}/citizen-xapi/api/v1/organizations/{{organization_id}}/flows

  5. Flows - Edit flow information PUT {{url}}/citizen-xapi/api/v1/organizations/{{organization_id}}/flows/{{flow_id}}

  6. Flows - Get flow status GET {{url}}/citizen-xapi/api/v1/organizations/{{organization_id}}/flows/{{flow_id}}/status

  7. Flows - Get single flow by Id GET {{url}}/citizen-xapi/api/v1/organizations/{{organization_id}}/flows/{{flow_id}}

  8. Settings - Get permissions GET {{url}}/accounts/api/cs/organizations/{{organization_id}}/permissions/products/composer

  9. Authentication - Get roles by user id with Organization Info GET {{url}}/accounts/api/users/{{user_id}}/roles?search=Organization+Administrator&role_groups=true

  10. Settings - Get users GET {{url}}/accounts/api/organizations/{{organization_id}}/users?limit=25&offset=0&search=