Overview
Statistics
152
Operations
3
Skills
Exchange
Category
Manage assets, reviews, ratings, and portal customizations in Anypoint Exchange. Search, publish, and consume reusable API and integration assets.
Servers
-
https://anypoint.mulesoft.com/exchange/api/v2Anypoint URL -
https://{region}.anypoint.mulesoft.com/exchange/api/v2Regional Anypoint URL -
https://{region}.platform.mulesoft.com/exchange/api/v2Regional Anypoint URL
Authentication & Security
-
bearerAuth http
Bearer token authentication. Login endpoint: https://anypoint.mulesoft.com/accounts/api/login
-
clientAuth oauth2
OAuth2 client credentials. Token endpoint: https://anypoint.mulesoft.com/accounts/api/v2/oauth2/token
Create Assets createAssets
POST
Try it out
Header Parameters
Custom Query Parameters
Custom Headers
Uploads an asset
Header Parameters
Content-Type:
string
The Content Type header value.
x-allowed-api-spec-formats:
string
The x allowed api spec formats header value.
x-file-validation:
any
The x file validation header value.
default:
Truex-strict-package:
any
Indicates if file is immutable.
default:
Falsex-user-id:
string
The x user id header value.
x-snapshots-allowed:
any
Indicates if snapshot publicataion is enabled.
Response
Asset created
Get Assets Search getAssetsSearch
GET
Try it out
Query Parameters
Custom Query Parameters
Custom Headers
Gets a paginated set of assets
Query Parameters
limit:
any
Amount of objects retrieved in the response
offset:
any
The offset specifies the offset of the first row to return
sort:
string
Property to sort by
ascending:
any
Order for sorting
sharedWithMe:
any
Filter assets that are shared with me
types:
string
Filter assets by type
rootOrganizationId:
string(uuid)
Root organization ID to scope the asset search
Related Operations:
Response
success
items:
array
Array items
Examples
SearchResult
{
"value": [
{
"organizationId": "9efb6531-9fa2-4a45-ac42-bd157773ce95",
"groupId": "9efb6531-9fa2-4a45-ac42-bd157773aa00",
"assetId": "endpoints-review",
"version": "1.0.0",
"minorVersion": "1.0",
"description": "description of the asset",
"versionGroup": "1.0.0",
"isPublic": false,
"name": "Endpoints Review",
"type": "custom",
"status": "published",
"createdById": "102d0953-9cca-475e-1919-768cd7aa7695",
"createdAt": "2020-09-07T17:48:33.995Z"
}
]
}
Patch Assets By Groupid By Assetid patchAssetsByGroupidByAssetid
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates asset metadata (name and description)
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
Request Body
jsonExamples
application/json
{
"name": "new asset name",
"description": "new asset description"
}
Response
asset modified successfully
Delete Assets By Groupid By Assetid deleteAssetsByGroupidByAssetid
DELETE
Try it out
Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Deletes an asset
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
Header Parameters
X-Delete-Type:
string
The X Delete Type header value.
Response
Asset deleted
Get Assets By Groupid By Assetid Metrics getAssetsByGroupidByAssetidMetrics
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets metrics given a groupId and assetId
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
Query Parameters
periodType:
string
The periodType query parameter.
default:
WEEKformat:
string
The format query parameter.
Response
success
Examples
Metrics
{
"value": {
"periodType": "WEEK",
"dateFrom": "2022-12-29T00:00:00+00:00",
"dateTo": "2023-01-06T00:00:00+00:00",
"asset": {
"metrics": [
{
"metricId": "1621d354-bb5e-45b1-9ea3-767236c7dd08",
"displayName": "Downloads",
"key": "assetDownload",
"score": 1,
"allTime": 200
},
{
"metricId": "a57a91e6-5aaf-4863-b0fd-55b93318952a",
"displayName": "Engagement",
"key": "engagement",
"score": 1,
"allTime": 200
},
{
"metricId": "c07bba9e-8afc-4e44-9f99-ed9697c09272",
"displayName": "Imports from API Designer",
"key": "importsFromApid",
"score": 0,
"allTime": 0
},
{
"metricId": "283f0a5b-32d8-4cab-b18b-96477f2c1944",
"displayName": "Dependents",
"key": "assetDependent",
"score": 0,
"allTime": 0
},
{
"metricId": "bb572128-b2c6-45b4-814e-e9d84a834906",
"displayName": "Contracts",
"key": "assetContract",
"score": 0,
"allTime": 0
}
]
}
}
}
MetricsCSV
{
"value": "\"assetDownloadScore\",\"engagementScore\",\"importsFromApidScore\",\"importsFromApidAllTime\",\"assetDependentScore\",\"assetDependentAllTime\",\"assetContractScore\",\"assetContractAllTime\"\n4,4,0,0,0,0,0,0"
}
Get Assets By Groupid By Assetid Metrics Versions getAssetsByGroupidByAssetidMetricsVersions
GET
Try it out
Path Parameters
Query Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Gets metrics by version given a groupId and assetId
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
Query Parameters
format:
string
The format query parameter.
periodType:
string
The periodType query parameter.
default:
WEEKHeader Parameters
accept:
string
The accept header value.
default:
application/jsonResponse
success
Examples
MetricVersions
{
"value": {
"periodType": "MONTH",
"dateFrom": "2022-12-28T00:00:00+00:00",
"dateTo": "2023-01-05T00:00:00+00:00",
"versions": [
{
"groupId": "cd7y8b06-e178-4167-9a36-1abf775a5b5e",
"assetId": "assset-id",
"version": "2.0.0",
"minorVersion": "2.0",
"isPublic": false,
"name": "Assset Name",
"type": "http-api",
"status": "published",
"createdDate": "2022-12-01T13:21:13.973000+00:00",
"contactEmail": null,
"contactName": null,
"createdBy": {
"id": "0853c514-6a56-4e23-8a51-6c2e6b6d2e85",
"userName": "pepe",
"firstName": "Pepe",
"lastName": "lastName"
},
"metrics": [
{
"metricId": "1621d354-bb5e-45b1-9ea3-767236c7dd08",
"displayName": "Downloads",
"key": "assetDownload",
"score": 20,
"allTime": 200
},
{
"metricId": "a57a91e6-5aaf-4863-b0fd-55b93318952a",
"displayName": "Engagement",
"key": "engagement",
"score": 12,
"allTime": 23
},
{
"metricId": "c07bba9e-8afc-4e44-9f99-ed9697c09272",
"displayName": "Imports from API Designer",
"key": "importsFromApid",
"score": 2,
"allTime": 30
},
{
"metricId": "283f0a5b-32d8-4cab-b18b-96477f2c1944",
"displayName": "Dependents",
"key": "assetDependent",
"score": 1,
"allTime": 12
}
]
},
{
"groupId": "cd7y8b06-e178-4167-9a36-1abf775a5b5e",
"assetId": "assset-id",
"version": "1.0.0",
"minorVersion": "1.0",
"isPublic": false,
"name": "Assset Name",
"type": "http-api",
"status": "published",
"createdDate": "2021-10-28T13:01:44.011000+00:00",
"contactEmail": null,
"contactName": null,
"createdBy": {
"id": "0853c514-6a56-4e23-8a51-6c2e6b6d2e85",
"userName": "pepe",
"firstName": "Pepe",
"lastName": "lastName"
},
"metrics": [
{
"metricId": "1621d354-bb5e-45b1-9ea3-767236c7dd08",
"displayName": "Downloads",
"key": "assetDownload",
"score": 12,
"allTime": 15
},
{
"metricId": "a57a91e6-5aaf-4863-b0fd-55b93318952a",
"displayName": "Engagement",
"key": "engagement",
"score": 30,
"allTime": 50
},
{
"metricId": "c07bba9e-8afc-4e44-9f99-ed9697c09272",
"displayName": "Imports from API Designer",
"key": "importsFromApid",
"score": 30,
"allTime": 46
},
{
"metricId": "283f0a5b-32d8-4cab-b18b-96477f2c1944",
"displayName": "Dependents",
"key": "assetDependent",
"score": 12,
"allTime": 23
}
]
}
]
}
}
MetricVersionsCSV
{
"value": "\"version\",\"isPublic\",\"status\",\"createdDate\",\"createdByFirstName\",\"createdByLastName\",\"updatedDate\",\"assetCreatedDate\",\"assetDownloadScore\",\"assetDownloadAllTime\",\"engagementScore\",\"engagementAllTime\",\"importsFromApidScore\",\"importsFromApidAllTime\",\"assetDependentScore\",\"assetDependentAllTime\",\"assetContractScore\",\"assetContractAllTime\"\n\"2.0.0\",false,\"published\",\"2022-12-01T13:21:13.973Z\",\"Pepe\",\"Gomez\",,,,0,0,0,0,0,0,0,0,0\n\"1.0.0\",false,\"published\",\"2022-11-28T13:01:44.011Z\",\"Pepe\",\"Gomez\",,,0,0,0,0,0,0,0,0,0,0\n"
}
Update Assets By Groupid By Assetid Icon updateAssetsByGroupidByAssetidIcon
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body */*
Uploads an icon as a binary file
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
Request Body
*/*Examples
IconSVG
{
"value": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<!-- Generator: Adobe Illustrator 19.2.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->\n<svg version=\"1.1\" xmlns=\"http://www.w3.org/2000/svg\" x=\"0px\" y=\"0px\"\n viewBox=\"0 0 26 26\" enable-background=\"new 0 0 26 26\" xml:space=\"preserve\">\n<g id=\"guides\">\n</g>\n<g id=\"white\">\n</g>\n<g id=\"_x31_6_16\" display=\"none\">\n</g>\n<g id=\"content\">\n <path fill=\"#00A3E0\" d=\"M20.5492554,17.5856934l1.6424561,1.1501465C20.3830566,21.314209,17.3885498,23,13.999939,23\n c-4.8378296,0-8.8724365-3.4356689-9.7990723-8H1.9991455v-4h2.2017212c0.9266357-4.5643311,4.9612427-8,9.7990723-8\n c3.3886108,0,6.3831177,1.685791,8.1917725,4.2641602l-1.6424561,1.1501465C19.1008301,6.3518066,16.7059937,5,13.999939,5\n C9.5887451,5,6,8.5888672,6,13s3.5887451,8,7.999939,8C16.7059937,21,19.1008301,19.6481934,20.5492554,17.5856934z\"/>\n <path fill=\"#087299\" d=\"M24.0009766,12.0136719l-6.1418457-0.0118408C17.4136353,10.2785645,15.8623657,9,14,9\n c-2.2091064,0-3.999939,1.7907715-3.999939,4c0,2.2091064,1.7908325,4,3.999939,4\n c1.8660278,0,3.4203491-1.2834473,3.8622437-3.0118408L23.9970703,14L24.0009766,12.0136719z M14,15c-1.1027832,0-2-0.8972168-2-2\n s0.8972168-2,2-2c1.1028442,0,2,0.8972168,2,2S15.1028442,15,14,15z\"/>\n</g>\n<g id=\"grid\">\n</g>\n</svg>\n"
}
Response
Resource created successfully.
Examples
application/json
{
"assetId": "api-test",
"groupId": "59291b3f-c12a-4c84-be4b-19cf19de0475",
"classifier": "icon",
"packaging": "png",
"externalKey": "59291b3f-c12a-4c84-be4b-19cf19de0475/41470514d754ff6ae8906b93540742c8dbaeb44deb88d565f677c47641452870.png",
"externalLink": "http://localhost/api-test-1.0.0-icon.png"
}
Delete Assets By Groupid By Assetid Icon deleteAssetsByGroupidByAssetidIcon
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Delete an icon for the whole ga
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
Response
Icon deleted
Update Assets By Groupid By Assetid Public updateAssetsByGroupidByAssetidPublic
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Sets the public versions for the asset
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
Request Body
jsonitems:
array
Array items
Response
success
Get Assets By Groupid By Assetid Asset getAssetsByGroupidByAssetidAsset
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets an asset
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
Response
success
Examples
Asset
{
"value": {
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "2.0.0",
"minorVersion": "2.0",
"description": "My asset description",
"versionGroup": "v2",
"isPublic": false,
"name": "Asset with files",
"type": "rest-api",
"isSnapshot": false,
"status": "published",
"externalFile": {
"url": null
},
"createdDate": "2020-09-08T16:44:04.238000+00:00",
"updatedDate": "2020-09-08T16:44:04.217000+00:00",
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"labels": [
"asset-tag",
"another-tag"
],
"categories": [
{
"value": [
"value"
],
"displayName": "Category",
"key": "Category"
}
],
"customFields": [],
"mule3ConnectorMetadata": {
"fullVersion": null,
"featureId": null
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "d2dd14a6cbbb15869105d9755d2f8345",
"sha1": "d2dd14a6cbbb15869105d9755d2f8345",
"createdDate": "2020-09-08T16:44:03.861000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "d2dd14a6cbbb15869105d9755d2f8345",
"sha1": "d2dd14a6cbbb15869105d9755d2f8345",
"createdDate": "2020-09-08T16:44:03.887000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "d2dd14a6cbbb15869105d9755d2f8345",
"sha1": "d2dd14a6cbbb15869105d9755d2f8345",
"createdDate": "2020-09-08T16:44:04.117000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"rating": 5,
"numberOfRates": 1,
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"instances": [
{
"versionGroup": "v2",
"organizationId": "org.mule.modules",
"id": "mocking-service",
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "2.0.0",
"minorVersion": "2.0",
"productAPIVersion": "v2",
"environmentId": null,
"providerId": null,
"endpointUri": "https://anypoint.mulesoft.com/mocking/api/v1/sources/exchange/assets/org.mule.modules/asset-with-files/2.0.0/m",
"name": "Mocking Service",
"isPublic": true,
"type": "mocked",
"fullname": "Mocking Service",
"deprecated": false
}
],
"dependencies": [],
"generated": [
{
"roupId": "org.mule.modules",
"assetId": "mule-plugin-asset-with-files",
"version": "2.0.0",
"versionGroup": "2.0.0",
"name": "Asset with files",
"type": "extension",
"minMuleVersion": "4.1.1",
"files": [
{
"classifier": "icon",
"packaging": "svg",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/icon/svg",
"externalLink": "https://localhost/org.mule.modules/Dmule-plugin-asset-with-files-2.0.0-icon.svg",
"md5": "4e66d7d9944fae99cd10d802a9c02207",
"sha1": "00b2b3da2a1a886eeefc4d5fa5d8f049cef4e7e8",
"createdDate": "2020-09-08T16:37:12.435000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": "mule-plugin",
"packaging": "jar",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/mule-plugin/jar",
"externalLink": "https://localhost/org.mule.modules/mule-plugin-asset-with-files-2.0.0-mule-plugin.jar",
"md5": "a94d53d0a5522a83bcc7b8c6c7118ae0",
"sha1": "be58dd541aa71c947de488c174c44b016f13698c",
"createdDate": "2020-09-08T16:44:05.420000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": null,
"packaging": "pom",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/pom",
"externalLink": "https://localhost/org.mule.modules/mule-plugin-asset-with-files-2.0.0.pom",
"md5": "45ae05e606e34293314a4a189f9bbb92",
"sha1": "1d50e4a549975cb712ec56d9e7516a9a6849f025",
"createdDate": "2020-09-08T16:44:05.745000+00:00",
"mainFile": null,
"isGenerated": false
}
]
},
{
"groupId": "org.mule.modules",
"assetId": "mule-module-asset-with-files",
"version": "2.0.0",
"versionGroup": "2.0.0",
"name": "instagram Connector",
"type": "connector",
"minMuleVersion": "3.6.0",
"files": [
{
"classifier": null,
"packaging": "jar",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/jar",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0.jar",
"md5": "26ab438e482e032bb0187b5208ebc733",
"sha1": "72b1f94bafc6d71d92767315edbd3d4899498cb0",
"createdDate": "2020-09-08T16:44:19.813000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": null,
"packaging": "pom",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/pom",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0.pom",
"md5": "c92f82a5690cf7e129127ce77e10c4b0",
"sha1": "2b47d576700d141749d36f7fa4f9aae3f4bd94bf",
"createdDate": "2020-09-08T16:44:20.250000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": "studio-plugin",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/studio-plugin/zip",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0-studio-plugin.zip",
"md5": "abafce8dd4817861aea26c1d4ae37e8f",
"sha1": "cdba899a66202fed3683736ec91beb195e17faba",
"createdDate": "2020-09-08T16:44:21.680000+00:00",
"mainFile": null,
"isGenerated": false
}
]
}
],
"otherVersions": [
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "1.0.1",
"minorVersion": "1.0",
"versionGroup": "v1",
"isPublic": false,
"type": "rest-api",
"status": "published",
"createdDate": "2020-09-08T16:55:28.130000+00:00",
"updatedDate": "2020-09-08T16:55:28.115000+00:00",
"isSnapshot": false,
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"externalFile": {
"url": null
},
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "347f9598e3fed6e428e58380186ea294",
"sha1": "c4e5f88e56e66ba61d25ccb9fa0a81688bc7ec8f",
"createdDate": "2020-09-08T16:55:26.660000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "347f9598e3fed6e428e58380186ea294",
"sha1": "c4e5f88e56e66ba61d25ccb9fa0a81688bc7ec8f",
"createdDate": "2020-09-08T16:55:26.681000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "d4af802fbf1a35e0feb85ebc775582b9",
"sha1": "eb72390d770fe89d711ce295fb2973aa97ba0889",
"createdDate": "2020-09-08T16:55:27.956000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"dependencies": []
},
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "1.0.0",
"minorVersion": "1.0",
"versionGroup": "v1",
"isPublic": false,
"type": "rest-api",
"status": "published",
"createdDate": "2020-09-08T16:37:11.194000+00:00",
"updatedDate": "2020-09-08T16:44:04.217000+00:00",
"isSnapshot": false,
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"externalFile": {
"url": null
},
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "ec57fff8e8abd7169f20b9c0f3a65c03",
"sha1": "3f75b6252ba42a502bcd41771f9d847b09ea126e",
"createdDate": "2020-09-08T16:37:10.781000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "ec57fff8e8abd7169f20b9c0f3a65c03",
"sha1": "3f75b6252ba42a502bcd41771f9d847b09ea126e",
"createdDate": "2020-09-08T16:37:10.824000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "e6658956af113a1ce7771f649f1e1370",
"sha1": "73897231991441f0d0e0d9c15e2b30ebcb29d09d",
"createdDate": "2020-09-08T16:37:11.001000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"dependencies": []
}
],
"id": "org.mule.modules/asset-with-files/2.0.0",
"icon": "http://www.icon.com.ar",
"createdAt": "2020-09-08T16:44:04.238000+00:00",
"modifiedAt": "2020-09-08T16:44:04.217000+00:00",
"organization": {
"id": "org.mule.modules",
"name": "Mulesoft",
"parentOrganizationIds": [],
"subOrganizationIds": [],
"tenantOrganizationIds": [],
"isMaster": true,
"domain": "mulesoft-0000",
"isMulesoftOrganization": false
},
"permissions": [
"admin",
"edit"
],
"versions": [
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "2.0.0",
"minorVersion": "2.0",
"description": "",
"versionGroup": "v2",
"isPublic": false,
"name": "Asset with files",
"type": "rest-api",
"isSnapshot": false,
"status": "published",
"externalFile": {
"url": null
},
"createdDate": "2020-09-08T16:44:04.238000+00:00",
"updatedDate": "2020-09-08T16:44:04.217000+00:00",
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"labels": [
"asset-tag",
"another-tag"
],
"categories": [
{
"value": [
"value"
],
"displayName": "Category",
"key": "Category"
}
],
"customFields": [],
"mule3ConnectorMetadata": {
"fullVersion": null,
"featureId": null
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "b2fb0ee5430cf3947432ebdee9383c38",
"sha1": "c57be838629921bcdf7c0de4f56798205d0178c4",
"createdDate": "2020-09-08T16:44:03.861000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "b2fb0ee5430cf3947432ebdee9383c38",
"sha1": "c57be838629921bcdf7c0de4f56798205d0178c4",
"createdDate": "2020-09-08T16:44:03.887000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "d5e9236adfea9ef8b54c053795bf768b",
"sha1": "08bdcca2179479d385a772dfe0654253a3e2ac80",
"createdDate": "2020-09-08T16:44:04.117000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"rating": 5,
"numberOfRates": 1,
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"instances": [
{
"versionGroup": "v2",
"organizationId": "org.mule.modules",
"id": "mocking-service",
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "2.0.0",
"minorVersion": "2.0",
"productAPIVersion": "v2",
"environmentId": null,
"providerId": null,
"endpointUri": "https://anypoint.mulesoft.com/mocking/api/v1/sources/exchange/assets/org.mule.modules/asset-with-files/2.0.0/m",
"name": "Mocking Service",
"isPublic": true,
"type": "mocked",
"fullname": "Mocking Service",
"deprecated": false
}
],
"dependencies": [],
"generated": [
{
"groupId": "org.mule.modules",
"assetId": "mule-plugin-asset-with-files",
"version": "2.0.0",
"versionGroup": "2.0.0",
"name": "Asset with files",
"type": "extension",
"minMuleVersion": "4.1.1",
"files": [
{
"classifier": "icon",
"packaging": "svg",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/icon/svg",
"externalLink": "https://localhost/org.mule.modules/Dmule-plugin-asset-with-files-2.0.0-icon.svg",
"md5": "4e66d7d9944fae99cd10d802a9c02207",
"sha1": "00b2b3da2a1a886eeefc4d5fa5d8f049cef4e7e8",
"createdDate": "2020-09-08T16:37:12.435000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": "mule-plugin",
"packaging": "jar",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/mule-plugin/jar",
"externalLink": "https://localhost/org.mule.modules/mule-plugin-asset-with-files-2.0.0-mule-plugin.jar",
"md5": "a94d53d0a5522a83bcc7b8c6c7118ae0",
"sha1": "be58dd541aa71c947de488c174c44b016f13698c",
"createdDate": "2020-09-08T16:44:05.420000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": null,
"packaging": "pom",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/pom",
"externalLink": "https://localhost/org.mule.modules/mule-plugin-asset-with-files-2.0.0.pom",
"md5": "45ae05e606e34293314a4a189f9bbb92",
"sha1": "1d50e4a549975cb712ec56d9e7516a9a6849f025",
"createdDate": "2020-09-08T16:44:05.745000+00:00",
"mainFile": null,
"isGenerated": false
}
]
},
{
"groupId": "org.mule.modules",
"assetId": "mule-module-asset-with-files",
"version": "2.0.0",
"versionGroup": "2.0.0",
"name": "instagram Connector",
"type": "connector",
"minMuleVersion": "3.6.0",
"files": [
{
"classifier": null,
"packaging": "jar",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/jar",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0.jar",
"md5": "26ab438e482e032bb0187b5208ebc733",
"sha1": "72b1f94bafc6d71d92767315edbd3d4899498cb0",
"createdDate": "2020-09-08T16:44:19.813000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": null,
"packaging": "pom",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/pom",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0.pom",
"md5": "c92f82a5690cf7e129127ce77e10c4b0",
"sha1": "2b47d576700d141749d36f7fa4f9aae3f4bd94bf",
"createdDate": "2020-09-08T16:44:20.250000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": "studio-plugin",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/studio-plugin/zip",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0-studio-plugin.zip",
"md5": "abafce8dd4817861aea26c1d4ae37e8f",
"sha1": "cdba899a66202fed3683736ec91beb195e17faba",
"createdDate": "2020-09-08T16:44:21.680000+00:00",
"mainFile": null,
"isGenerated": false
}
]
}
],
"otherVersions": [
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "1.0.1",
"minorVersion": "1.0",
"versionGroup": "v1",
"isPublic": false,
"type": "rest-api",
"status": "published",
"createdDate": "2020-09-08T16:55:28.130000+00:00",
"updatedDate": "2020-09-08T16:55:28.115000+00:00",
"isSnapshot": false,
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"externalFile": {
"url": null
},
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "347f9598e3fed6e428e58380186ea294",
"sha1": "c4e5f88e56e66ba61d25ccb9fa0a81688bc7ec8f",
"createdDate": "2020-09-08T16:55:26.660000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "347f9598e3fed6e428e58380186ea294",
"sha1": "c4e5f88e56e66ba61d25ccb9fa0a81688bc7ec8f",
"createdDate": "2020-09-08T16:55:26.681000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "d4af802fbf1a35e0feb85ebc775582b9",
"sha1": "eb72390d770fe89d711ce295fb2973aa97ba0889",
"createdDate": "2020-09-08T16:55:27.956000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"dependencies": []
},
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "1.0.0",
"minorVersion": "1.0",
"versionGroup": "v1",
"isPublic": false,
"type": "rest-api",
"status": "published",
"createdDate": "2020-09-08T16:37:11.194000+00:00",
"updatedDate": "2020-09-08T16:44:04.217000+00:00",
"isSnapshot": false,
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"externalFile": {
"url": null
},
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "ec57fff8e8abd7169f20b9c0f3a65c03",
"sha1": "3f75b6252ba42a502bcd41771f9d847b09ea126e",
"createdDate": "2020-09-08T16:37:10.781000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "ec57fff8e8abd7169f20b9c0f3a65c03",
"sha1": "3f75b6252ba42a502bcd41771f9d847b09ea126e",
"createdDate": "2020-09-08T16:37:10.824000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "e6658956af113a1ce7771f649f1e1370",
"sha1": "73897231991441f0d0e0d9c15e2b30ebcb29d09d",
"createdDate": "2020-09-08T16:37:11.001000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"dependencies": []
}
],
"id": "org.mule.modules/asset-with-files/2.0.0",
"icon": "http://www.icon.com.ar",
"createdAt": "2020-09-08T16:44:04.238000+00:00",
"modifiedAt": "2020-09-08T16:44:04.217000+00:00",
"organization": {
"id": "org.mule.modules",
"name": "Mulesoft",
"parentOrganizationIds": [],
"subOrganizationIds": [],
"tenantOrganizationIds": [],
"isMaster": true,
"domain": "mulesoft-0000",
"isMulesoftOrganization": false
},
"permissions": [
"admin",
"edit"
]
}
]
}
}
Get Assets By Groupid By Assetid Minorversions By Minorversion Portal Search getAssetsByGroupidByAssetidMinorversionsByMinorversionPortalSearch
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a search.
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
minorVersion *:
string
Minor version
pattern:
^[0-9]+\.[0-9]+$Query Parameters
term *:
string
The term query parameter.
Response
success
items:
array
The list of documentation pages with matches
Examples
application/json
{
"pages": [
{
"title": "home"
},
{
"title": "authentication"
}
]
}
Get Assets By Groupid By Assetid Versiongroups getAssetsByGroupidByAssetidVersiongroups
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets asset version groups
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
Query Parameters
status:
array
Filter versions that matches the status indicated. Should be one of deprecated, development or published
Response
success
items:
array
Array items
Examples
VersionGroups
{
"value": [
{
"organizationId": "26c17b05-c2da-4ad6-b1d1-34bde9e74e6e",
"groupId": "group-id",
"assetId": "some-asset-id",
"versionGroup": "v2",
"major": 2,
"isPublic": true
},
{
"organizationId": "26c17b05-c2da-4ad6-b1d1-34bde9e74e6e",
"groupId": "group-id",
"assetId": "some-asset-id",
"versionGroup": "v1",
"major": 1,
"isPublic": true
}
]
}
Get Assets By Groupid By Assetid Versiongroups By Versiongroup Apigroupinstances getAssetsByGroupidByAssetidVersiongroupsByVersiongroupApigroupinstances
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets API Group Instance
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
versionGroup *:
string
Version group of the asset
Query Parameters
limit:
any
Amount of objects retrieved in the response
offset:
any
The offset specifies the offset of the first row to return
sort:
string
Property to sort by
ascending:
any
Order for sorting
Response
success
Examples
APIGroupInstances
{
"value": [
{
"id": 22,
"name": "Social Media",
"assetVersion": "1.0.0",
"isPublic": true,
"deprecated": true,
"instances": [
{
"groupId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a",
"assetId": "facebook-api",
"assetVersion": "1.0.0",
"productApiVersion": "v1",
"apiVersionId": 1,
"instanceName": "Instance 1",
"environmentName": "Prod",
"environmentId": "f81fb343-3649-4990-832e-27de26ee649e",
"providerId": "ed687558-f86e-465f-bf88-45c989f0c2ad",
"isPublic": true,
"endpointUri": "",
"deprecated": false
},
{
"groupId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a",
"assetId": "instagram-api",
"assetVersion": "1.0.1",
"productApiVersion": "v1",
"apiVersionId": 2,
"instanceName": "Instance 2",
"environmentName": "Prod",
"environmentId": "5d15a77c-0d35-400e-9a90-61d0beb09409",
"providerId": "ed687558-f86e-465f-bf88-45c989f0c2ad",
"isPublic": true,
"endpointUri": "",
"deprecated": false
}
]
}
]
}
Patch Assets By Groupid By Assetid Versiongroups By Versiongroup Environments By Environmentid Apigroupinstances By Apigroupinstanceid patchAssetsByGroupidByAssetidVersiongroupsByVersiongroupEnvironmentsByEnvironmentidApigroupinstancesByApigroupinstanceid
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates API Group visibility
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
versionGroup *:
string
Version group of the asset
environmentId *:
string
The environment ID to identify the target resource.
minLength: 36, maxLength: 36
Related Operations:
apiGroupInstanceId *:
any
The apiGroupInstance ID to identify the target resource.
Request Body
jsonResponse
API Group visibility successfully updated
Get Assets By Groupid By Assetid Versiongroups By Versiongroup Environments By Environmentid Apigroupinstances By Apigroupinstanceid Tiers getAssetsByGroupidByAssetidVersiongroupsByVersiongroupEnvironmentsByEnvironmentidApigroupinstancesByApigroupinstanceidTiers
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets a list of tiers
Path Parameters
versionGroup *:
string
Version group of the asset
assetId *:
string
assetId of the asset
Related Operations:
groupId *:
string
groupId of the asset
Related Operations:
apiGroupInstanceId *:
any
The apiGroupInstance ID to identify the target resource.
environmentId *:
string
The environment ID to identify the target resource.
minLength: 36, maxLength: 36
Related Operations:
Response
success
Examples
Tiers
{
"value": [
{
"id": 100,
"name": "Free",
"description": null,
"limits": [
{
"timePeriodInMilliseconds": 10000,
"maximumRequests": 10
}
],
"status": "ACTIVE"
},
{
"id": 101,
"name": "Cheap",
"description": null,
"limits": [
{
"timePeriodInMilliseconds": 1000,
"maximumRequests": 10
}
],
"status": "ACTIVE"
}
]
}
Get Assets By Groupid By Assetid Versiongroups By Versiongroup Terms getAssetsByGroupidByAssetidVersiongroupsByVersiongroupTerms
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets Terms and Conditions associated to the API
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
versionGroup *:
string
Version group of the asset
Response
success
Examples
Terms
{
"value": [
{
"groupId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"assetId": "inimputability",
"assetVersion": "1.0.0",
"versionGroup": "v1",
"id": 7183,
"underlyingTerms": [
{
"groupId": "be1e07e2-a230-424b-93c4-a95829767d5d",
"assetId": "american-flights",
"minorVersion": "2.0",
"version": "2.0.2",
"name": "American Flights",
"termsText": "<h2>Dwelling and speedily ignorant any steepest</h2>\n<p>His followed carriage proposal entrance directly had elegance.</p>\n"
},
{
"groupId": "be1e07e2-a230-424b-93c4-a95829767d5d",
"assetId": "delta-flights",
"minorVersion": "1.0",
"version": "1.0.0",
"name": "Delta Flights",
"termsText": "<h2>Dwelling and speedily ignorant any steepest</h2>\n<p>His followed carriage proposal entrance directly had elegance.</p>\n"
}
]
},
{
"groupId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"assetId": "inimputability",
"assetVersion": "1.0.0",
"versionGroup": "v1",
"id": 7184,
"underlyingTerms": [
{
"groupId": "be1e07e2-a230-424b-93c4-a95829767d5d",
"assetId": "delta-flights",
"minorVersion": "1.1",
"version": "1.1.1",
"name": "Delta Flights",
"termsText": "<h2>Dwelling and speedily ignorant any steepest</h2>\n<p>His followed carriage proposal entrance directly had elegance.</p>\n"
}
]
}
]
}
Get Assets By Groupid By Assetid Versiongroups By Versiongroup Instances getAssetsByGroupidByAssetidVersiongroupsByVersiongroupInstances
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets API instances
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
versionGroup *:
string
Version group of the asset
Response
success
items:
array
Array items
Examples
ExternalInstances
{
"value": [
{
"id": "3defc266-c001-431c-88d2-7cc83928efca",
"groupId": "com.mulesoft",
"assetId": "salesforce",
"productApiVersion": "v1",
"environmentId": "1234",
"endpointUri": "https://www.yes.com/dog",
"name": "Instance name",
"isPublic": true,
"type": "external",
"createdBy": "e1dd88f8-dG6e-4443-93a1-bd074603e118",
"createdDate": "2017-09-22T19:26:00.815000+00:00",
"updatedDate": "2017-09-22T19:26:00.815000+00:00",
"providerId": "aaf409a9-08c3-4c32-bb66-d6f2e4dba153",
"deprecated": false
},
{
"id": "96ccd7af-c88b-40b9-af89-bad8c039a353",
"groupId": "com.mulesoft",
"assetId": "salesforce",
"productApiVersion": "v2",
"environmentId": "1234568",
"endpointUri": "https://www.no.com/cat",
"name": "Another instance name",
"isPublic": false,
"type": "external",
"createdBy": "e1dd88f8-dG6e-4443-93a1-bd074603e118",
"createdDate": "2016-12-27T20:47:46.470000+00:00",
"updatedDate": "2016-12-27T20:47:46.470000+00:00",
"providerId": "aaf409a9-08c3-4c32-bb66-d6f2e4dba153",
"deprecated": false
}
]
}
Get Assets By Groupid By Assetid Versiongroups By Versiongroup Instances By Apiinstanceid Relatedapigroupinstances getAssetsByGroupidByAssetidVersiongroupsByVersiongroupInstancesByApiinstanceidRelatedapigroupinstances
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets API group instances that include an API instance
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
versionGroup *:
string
Version group of the asset
apiInstanceId *:
string
The apiInstance ID to identify the target resource.
Response
success
Examples
application/json
[
{
"id": 266126,
"organizationId": "930f973d-e5a7-4e48-acfa-3b30de06f98d",
"groupId": "930f973d-e5a7-4e48-acfa-3b30de06f98d",
"assetId": "social-media",
"version": "1.0.0",
"isPublic": true
},
{
"id": 266127,
"organizationId": "930f973d-e5a7-4e48-acfa-3b30de06f98d",
"groupId": "930f973d-e5a7-4e48-acfa-3b30de06f98d",
"assetId": "social-media",
"version": "2.0.0",
"isPublic": false
}
]
Get Assets By Groupid By Assetid Versiongroups By Versiongroup Instances By Apiid Tiers getAssetsByGroupidByAssetidVersiongroupsByVersiongroupInstancesByApiidTiers
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets a list of tiers
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
versionGroup *:
string
Version group of the asset
apiId *:
string
The api ID to identify the target resource.
Response
success
items:
array
Array items
Examples
Tiers
{
"value": [
{
"id": 100,
"name": "Free",
"description": null,
"limits": [
{
"timePeriodInMilliseconds": 10000,
"maximumRequests": 10
}
],
"status": "ACTIVE"
},
{
"id": 101,
"name": "Cheap",
"description": null,
"limits": [
{
"timePeriodInMilliseconds": 1000,
"maximumRequests": 10
}
],
"status": "ACTIVE"
}
]
}
Create Assets By Groupid By Assetid Versiongroups By Versiongroup Instances Evented Apis External createAssetsByGroupidByAssetidVersiongroupsByVersiongroupInstancesEventedApisExternal
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new external API instance for an evented API
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
versionGroup *:
string
Version group of the asset
Request Body
jsonendpointUri *:
string
maxLength: 2048
isPublic:
boolean
name *:
string
maxLength: 150
Examples
CreateExternalInstance
{
"value": {
"name": "Production - US",
"endpointUri": "http://dog.domain.tld.com/much/doge",
"isPublic": true
}
}
Response
Created
id *:
string
groupId *:
string
maxLength: 256
assetId *:
string
maxLength: 256
productApiVersion *:
string
maxLength: 128
isPublic *:
boolean
type *:
any
endpointUri *:
string
maxLength: 2048
name *:
string
maxLength: 150
organizationId:
string
maxLength: 256
createdBy:
string
createdDate:
string
updatedDate:
string
Examples
ExternalInstance
{
"value": {
"id": "3defc266-c001-431c-88d2-7cc83928efca",
"groupId": "com.mulesoft",
"assetId": "salesforce",
"productApiVersion": "v1",
"environmentId": "1234",
"providerId": "ed687558-f86e-465f-bf88-45c989f0c2ad",
"name": "Instance name",
"endpointUri": "https://www.yes.com/dog",
"createdBy": "e1dd88f8-dG6e-4443-93a1-bd074603e118",
"createdDate": "2017-09-22T19:26:00.815000+00:00",
"updatedDate": "2017-09-22T19:26:00.815000+00:00",
"isPublic": true,
"type": "external"
}
}
Patch Assets By Groupid By Assetid Versiongroups By Versiongroup Instances Evented Apis External By Id patchAssetsByGroupidByAssetidVersiongroupsByVersiongroupInstancesEventedApisExternalById
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates an existing external API instance
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
versionGroup *:
string
Version group of the asset
id *:
string(uuid)
The id to identify the target resource.
Request Body
jsonExamples
CreateExternalInstance
{
"value": {
"name": "Production - US",
"endpointUri": "http://dog.domain.tld.com/much/doge",
"isPublic": true
}
}
Response
External instance updated
Create Assets By Groupid By Assetid Versiongroups By Versiongroup Instances External createAssetsByGroupidByAssetidVersiongroupsByVersiongroupInstancesExternal
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new external API instance
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
versionGroup *:
string
Version group of the asset
Request Body
jsonendpointUri *:
string
maxLength: 2048
isPublic:
boolean
name *:
string
maxLength: 150
Examples
CreateExternalInstance
{
"value": {
"name": "Production - US",
"endpointUri": "http://dog.domain.tld.com/much/doge",
"isPublic": true
}
}
Response
created
id *:
string
groupId *:
string
maxLength: 256
assetId *:
string
maxLength: 256
productApiVersion *:
string
maxLength: 128
isPublic *:
boolean
type *:
any
endpointUri *:
string
maxLength: 2048
name *:
string
maxLength: 150
organizationId:
string
maxLength: 256
createdBy:
string
createdDate:
string
updatedDate:
string
Examples
ExternalInstance
{
"value": {
"id": "3defc266-c001-431c-88d2-7cc83928efca",
"groupId": "com.mulesoft",
"assetId": "salesforce",
"productApiVersion": "v1",
"environmentId": "1234",
"providerId": "ed687558-f86e-465f-bf88-45c989f0c2ad",
"name": "Instance name",
"endpointUri": "https://www.yes.com/dog",
"createdBy": "e1dd88f8-dG6e-4443-93a1-bd074603e118",
"createdDate": "2017-09-22T19:26:00.815000+00:00",
"updatedDate": "2017-09-22T19:26:00.815000+00:00",
"isPublic": true,
"type": "external"
}
}
Delete Assets By Groupid By Assetid Versiongroups By Versiongroup Instances External deleteAssetsByGroupidByAssetidVersiongroupsByVersiongroupInstancesExternal
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes all instance instances from Version Group
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
versionGroup *:
string
Version group of the asset
Response
deleted all external instances
Patch Assets By Groupid By Assetid Versiongroups By Versiongroup Instances External By Id patchAssetsByGroupidByAssetidVersiongroupsByVersiongroupInstancesExternalById
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates an existing external API instance
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
versionGroup *:
string
Version group of the asset
id *:
string(uuid)
The id to identify the target resource.
Request Body
jsonExamples
CreateExternalInstance
{
"value": {
"name": "Production - US",
"endpointUri": "http://dog.domain.tld.com/much/doge",
"isPublic": true
}
}
Response
External instance updated
Delete Assets By Groupid By Assetid Versiongroups By Versiongroup Instances External By Id deleteAssetsByGroupidByAssetidVersiongroupsByVersiongroupInstancesExternalById
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes an existing external API instance
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
versionGroup *:
string
Version group of the asset
id *:
string(uuid)
The id to identify the target resource.
Response
External instance deleted
Patch Assets By Groupid By Assetid Versiongroups By Versiongroup Instances Managed By Id patchAssetsByGroupidByAssetidVersiongroupsByVersiongroupInstancesManagedById
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates an existing managed API instance
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
versionGroup *:
string
Version group of the asset
id *:
string
The id to identify the target resource.
Request Body
jsonExamples
CreateExternalInstance
{
"value": {
"name": "Production - US",
"endpointUri": "http://dog.domain.tld.com/much/doge",
"isPublic": true
}
}
Response
Managed instance updated
Get Assets By Groupid By Assetid Identities getAssetsByGroupidByAssetidIdentities
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
A collection of identities assigned to an asset with their role
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
Query Parameters
search:
string
Search parameter used to filter facets
Response
Successful operation.
Examples
application/json
[
{
"identityType": "user",
"username": "username",
"firstName": "Scott",
"lastName": "Lawson",
"email": "email@gmail.com",
"id": "3db3585a-db33-4fe6-b8e7-b91ac953e482",
"role": "admin",
"roleId": "03bf5aff-a0e2-4e1a-8377-b7e4f67750df",
"createdAt": "2020-08-10T20:02:11.955239",
"organization": {
"id": "d4e2bceb-baae-484c-92f3-3cc272256c7f",
"name": "Mulesoft Inc",
"domain": "mulesoft-inc"
}
}
]
Update Assets By Groupid By Assetid Identities updateAssetsByGroupidByAssetidIdentities
PUT
Try it out
Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Assigns identities to an asset
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
Header Parameters
x-skip-notifications:
string
The x skip notifications header value.
Request Body
jsonResponse
Identities assigned to the asset
Get Assets By Groupid By Assetid Domain getAssetsByGroupidByAssetidDomain
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets domain
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
Response
success
Get Assets By Groupid By Assetid By Version getAssetsByGroupidByAssetidByVersion
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get a particular asset by its id
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Query Parameters
includeSnapshots:
any
Filters results depending on whether the snapshots is enabled or not
status:
array
Filter versions that matches the status indicated. Should be one of deprecated, development or published
strict:
any
Asset related versions populated into
otherVersions property will also have the filters for this query applied, e.g.: if status filter is applied, then related versions will have the status filter also applied, otherwise all possible status will be returned. Defaults to trueResponse
Gets asset
Examples
Asset
{
"value": {
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "2.0.0",
"minorVersion": "2.0",
"description": "My asset description",
"versionGroup": "v2",
"isPublic": false,
"name": "Asset with files",
"type": "rest-api",
"isSnapshot": false,
"status": "published",
"externalFile": {
"url": null
},
"createdDate": "2020-09-08T16:44:04.238000+00:00",
"updatedDate": "2020-09-08T16:44:04.217000+00:00",
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"labels": [
"asset-tag",
"another-tag"
],
"categories": [
{
"value": [
"value"
],
"displayName": "Category",
"key": "Category"
}
],
"customFields": [],
"mule3ConnectorMetadata": {
"fullVersion": null,
"featureId": null
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "d2dd14a6cbbb15869105d9755d2f8345",
"sha1": "d2dd14a6cbbb15869105d9755d2f8345",
"createdDate": "2020-09-08T16:44:03.861000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "d2dd14a6cbbb15869105d9755d2f8345",
"sha1": "d2dd14a6cbbb15869105d9755d2f8345",
"createdDate": "2020-09-08T16:44:03.887000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "d2dd14a6cbbb15869105d9755d2f8345",
"sha1": "d2dd14a6cbbb15869105d9755d2f8345",
"createdDate": "2020-09-08T16:44:04.117000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"rating": 5,
"numberOfRates": 1,
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"instances": [
{
"versionGroup": "v2",
"organizationId": "org.mule.modules",
"id": "mocking-service",
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "2.0.0",
"minorVersion": "2.0",
"productAPIVersion": "v2",
"environmentId": null,
"providerId": null,
"endpointUri": "https://anypoint.mulesoft.com/mocking/api/v1/sources/exchange/assets/org.mule.modules/asset-with-files/2.0.0/m",
"name": "Mocking Service",
"isPublic": true,
"type": "mocked",
"fullname": "Mocking Service",
"deprecated": false
}
],
"dependencies": [],
"generated": [
{
"roupId": "org.mule.modules",
"assetId": "mule-plugin-asset-with-files",
"version": "2.0.0",
"versionGroup": "2.0.0",
"name": "Asset with files",
"type": "extension",
"minMuleVersion": "4.1.1",
"files": [
{
"classifier": "icon",
"packaging": "svg",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/icon/svg",
"externalLink": "https://localhost/org.mule.modules/Dmule-plugin-asset-with-files-2.0.0-icon.svg",
"md5": "4e66d7d9944fae99cd10d802a9c02207",
"sha1": "00b2b3da2a1a886eeefc4d5fa5d8f049cef4e7e8",
"createdDate": "2020-09-08T16:37:12.435000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": "mule-plugin",
"packaging": "jar",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/mule-plugin/jar",
"externalLink": "https://localhost/org.mule.modules/mule-plugin-asset-with-files-2.0.0-mule-plugin.jar",
"md5": "a94d53d0a5522a83bcc7b8c6c7118ae0",
"sha1": "be58dd541aa71c947de488c174c44b016f13698c",
"createdDate": "2020-09-08T16:44:05.420000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": null,
"packaging": "pom",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/pom",
"externalLink": "https://localhost/org.mule.modules/mule-plugin-asset-with-files-2.0.0.pom",
"md5": "45ae05e606e34293314a4a189f9bbb92",
"sha1": "1d50e4a549975cb712ec56d9e7516a9a6849f025",
"createdDate": "2020-09-08T16:44:05.745000+00:00",
"mainFile": null,
"isGenerated": false
}
]
},
{
"groupId": "org.mule.modules",
"assetId": "mule-module-asset-with-files",
"version": "2.0.0",
"versionGroup": "2.0.0",
"name": "instagram Connector",
"type": "connector",
"minMuleVersion": "3.6.0",
"files": [
{
"classifier": null,
"packaging": "jar",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/jar",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0.jar",
"md5": "26ab438e482e032bb0187b5208ebc733",
"sha1": "72b1f94bafc6d71d92767315edbd3d4899498cb0",
"createdDate": "2020-09-08T16:44:19.813000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": null,
"packaging": "pom",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/pom",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0.pom",
"md5": "c92f82a5690cf7e129127ce77e10c4b0",
"sha1": "2b47d576700d141749d36f7fa4f9aae3f4bd94bf",
"createdDate": "2020-09-08T16:44:20.250000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": "studio-plugin",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/studio-plugin/zip",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0-studio-plugin.zip",
"md5": "abafce8dd4817861aea26c1d4ae37e8f",
"sha1": "cdba899a66202fed3683736ec91beb195e17faba",
"createdDate": "2020-09-08T16:44:21.680000+00:00",
"mainFile": null,
"isGenerated": false
}
]
}
],
"otherVersions": [
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "1.0.1",
"minorVersion": "1.0",
"versionGroup": "v1",
"isPublic": false,
"type": "rest-api",
"status": "published",
"createdDate": "2020-09-08T16:55:28.130000+00:00",
"updatedDate": "2020-09-08T16:55:28.115000+00:00",
"isSnapshot": false,
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"externalFile": {
"url": null
},
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "347f9598e3fed6e428e58380186ea294",
"sha1": "c4e5f88e56e66ba61d25ccb9fa0a81688bc7ec8f",
"createdDate": "2020-09-08T16:55:26.660000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "347f9598e3fed6e428e58380186ea294",
"sha1": "c4e5f88e56e66ba61d25ccb9fa0a81688bc7ec8f",
"createdDate": "2020-09-08T16:55:26.681000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "d4af802fbf1a35e0feb85ebc775582b9",
"sha1": "eb72390d770fe89d711ce295fb2973aa97ba0889",
"createdDate": "2020-09-08T16:55:27.956000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"dependencies": []
},
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "1.0.0",
"minorVersion": "1.0",
"versionGroup": "v1",
"isPublic": false,
"type": "rest-api",
"status": "published",
"createdDate": "2020-09-08T16:37:11.194000+00:00",
"updatedDate": "2020-09-08T16:44:04.217000+00:00",
"isSnapshot": false,
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"externalFile": {
"url": null
},
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "ec57fff8e8abd7169f20b9c0f3a65c03",
"sha1": "3f75b6252ba42a502bcd41771f9d847b09ea126e",
"createdDate": "2020-09-08T16:37:10.781000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "ec57fff8e8abd7169f20b9c0f3a65c03",
"sha1": "3f75b6252ba42a502bcd41771f9d847b09ea126e",
"createdDate": "2020-09-08T16:37:10.824000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "e6658956af113a1ce7771f649f1e1370",
"sha1": "73897231991441f0d0e0d9c15e2b30ebcb29d09d",
"createdDate": "2020-09-08T16:37:11.001000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"dependencies": []
}
],
"id": "org.mule.modules/asset-with-files/2.0.0",
"icon": "http://www.icon.com.ar",
"createdAt": "2020-09-08T16:44:04.238000+00:00",
"modifiedAt": "2020-09-08T16:44:04.217000+00:00",
"organization": {
"id": "org.mule.modules",
"name": "Mulesoft",
"parentOrganizationIds": [],
"subOrganizationIds": [],
"tenantOrganizationIds": [],
"isMaster": true,
"domain": "mulesoft-0000",
"isMulesoftOrganization": false
},
"permissions": [
"admin",
"edit"
],
"versions": [
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "2.0.0",
"minorVersion": "2.0",
"description": "",
"versionGroup": "v2",
"isPublic": false,
"name": "Asset with files",
"type": "rest-api",
"isSnapshot": false,
"status": "published",
"externalFile": {
"url": null
},
"createdDate": "2020-09-08T16:44:04.238000+00:00",
"updatedDate": "2020-09-08T16:44:04.217000+00:00",
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"labels": [
"asset-tag",
"another-tag"
],
"categories": [
{
"value": [
"value"
],
"displayName": "Category",
"key": "Category"
}
],
"customFields": [],
"mule3ConnectorMetadata": {
"fullVersion": null,
"featureId": null
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "b2fb0ee5430cf3947432ebdee9383c38",
"sha1": "c57be838629921bcdf7c0de4f56798205d0178c4",
"createdDate": "2020-09-08T16:44:03.861000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "b2fb0ee5430cf3947432ebdee9383c38",
"sha1": "c57be838629921bcdf7c0de4f56798205d0178c4",
"createdDate": "2020-09-08T16:44:03.887000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "d5e9236adfea9ef8b54c053795bf768b",
"sha1": "08bdcca2179479d385a772dfe0654253a3e2ac80",
"createdDate": "2020-09-08T16:44:04.117000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"rating": 5,
"numberOfRates": 1,
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"instances": [
{
"versionGroup": "v2",
"organizationId": "org.mule.modules",
"id": "mocking-service",
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "2.0.0",
"minorVersion": "2.0",
"productAPIVersion": "v2",
"environmentId": null,
"providerId": null,
"endpointUri": "https://anypoint.mulesoft.com/mocking/api/v1/sources/exchange/assets/org.mule.modules/asset-with-files/2.0.0/m",
"name": "Mocking Service",
"isPublic": true,
"type": "mocked",
"fullname": "Mocking Service",
"deprecated": false
}
],
"dependencies": [],
"generated": [
{
"groupId": "org.mule.modules",
"assetId": "mule-plugin-asset-with-files",
"version": "2.0.0",
"versionGroup": "2.0.0",
"name": "Asset with files",
"type": "extension",
"minMuleVersion": "4.1.1",
"files": [
{
"classifier": "icon",
"packaging": "svg",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/icon/svg",
"externalLink": "https://localhost/org.mule.modules/Dmule-plugin-asset-with-files-2.0.0-icon.svg",
"md5": "4e66d7d9944fae99cd10d802a9c02207",
"sha1": "00b2b3da2a1a886eeefc4d5fa5d8f049cef4e7e8",
"createdDate": "2020-09-08T16:37:12.435000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": "mule-plugin",
"packaging": "jar",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/mule-plugin/jar",
"externalLink": "https://localhost/org.mule.modules/mule-plugin-asset-with-files-2.0.0-mule-plugin.jar",
"md5": "a94d53d0a5522a83bcc7b8c6c7118ae0",
"sha1": "be58dd541aa71c947de488c174c44b016f13698c",
"createdDate": "2020-09-08T16:44:05.420000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": null,
"packaging": "pom",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/pom",
"externalLink": "https://localhost/org.mule.modules/mule-plugin-asset-with-files-2.0.0.pom",
"md5": "45ae05e606e34293314a4a189f9bbb92",
"sha1": "1d50e4a549975cb712ec56d9e7516a9a6849f025",
"createdDate": "2020-09-08T16:44:05.745000+00:00",
"mainFile": null,
"isGenerated": false
}
]
},
{
"groupId": "org.mule.modules",
"assetId": "mule-module-asset-with-files",
"version": "2.0.0",
"versionGroup": "2.0.0",
"name": "instagram Connector",
"type": "connector",
"minMuleVersion": "3.6.0",
"files": [
{
"classifier": null,
"packaging": "jar",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/jar",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0.jar",
"md5": "26ab438e482e032bb0187b5208ebc733",
"sha1": "72b1f94bafc6d71d92767315edbd3d4899498cb0",
"createdDate": "2020-09-08T16:44:19.813000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": null,
"packaging": "pom",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/pom",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0.pom",
"md5": "c92f82a5690cf7e129127ce77e10c4b0",
"sha1": "2b47d576700d141749d36f7fa4f9aae3f4bd94bf",
"createdDate": "2020-09-08T16:44:20.250000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": "studio-plugin",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/studio-plugin/zip",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0-studio-plugin.zip",
"md5": "abafce8dd4817861aea26c1d4ae37e8f",
"sha1": "cdba899a66202fed3683736ec91beb195e17faba",
"createdDate": "2020-09-08T16:44:21.680000+00:00",
"mainFile": null,
"isGenerated": false
}
]
}
],
"otherVersions": [
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "1.0.1",
"minorVersion": "1.0",
"versionGroup": "v1",
"isPublic": false,
"type": "rest-api",
"status": "published",
"createdDate": "2020-09-08T16:55:28.130000+00:00",
"updatedDate": "2020-09-08T16:55:28.115000+00:00",
"isSnapshot": false,
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"externalFile": {
"url": null
},
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "347f9598e3fed6e428e58380186ea294",
"sha1": "c4e5f88e56e66ba61d25ccb9fa0a81688bc7ec8f",
"createdDate": "2020-09-08T16:55:26.660000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "347f9598e3fed6e428e58380186ea294",
"sha1": "c4e5f88e56e66ba61d25ccb9fa0a81688bc7ec8f",
"createdDate": "2020-09-08T16:55:26.681000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "d4af802fbf1a35e0feb85ebc775582b9",
"sha1": "eb72390d770fe89d711ce295fb2973aa97ba0889",
"createdDate": "2020-09-08T16:55:27.956000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"dependencies": []
},
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "1.0.0",
"minorVersion": "1.0",
"versionGroup": "v1",
"isPublic": false,
"type": "rest-api",
"status": "published",
"createdDate": "2020-09-08T16:37:11.194000+00:00",
"updatedDate": "2020-09-08T16:44:04.217000+00:00",
"isSnapshot": false,
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"externalFile": {
"url": null
},
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "ec57fff8e8abd7169f20b9c0f3a65c03",
"sha1": "3f75b6252ba42a502bcd41771f9d847b09ea126e",
"createdDate": "2020-09-08T16:37:10.781000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "ec57fff8e8abd7169f20b9c0f3a65c03",
"sha1": "3f75b6252ba42a502bcd41771f9d847b09ea126e",
"createdDate": "2020-09-08T16:37:10.824000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "e6658956af113a1ce7771f649f1e1370",
"sha1": "73897231991441f0d0e0d9c15e2b30ebcb29d09d",
"createdDate": "2020-09-08T16:37:11.001000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"dependencies": []
}
],
"id": "org.mule.modules/asset-with-files/2.0.0",
"icon": "http://www.icon.com.ar",
"createdAt": "2020-09-08T16:44:04.238000+00:00",
"modifiedAt": "2020-09-08T16:44:04.217000+00:00",
"organization": {
"id": "org.mule.modules",
"name": "Mulesoft",
"parentOrganizationIds": [],
"subOrganizationIds": [],
"tenantOrganizationIds": [],
"isMaster": true,
"domain": "mulesoft-0000",
"isMulesoftOrganization": false
},
"permissions": [
"admin",
"edit"
]
}
]
}
}
Delete Assets By Groupid By Assetid By Version deleteAssetsByGroupidByAssetidByVersion
DELETE
Try it out
Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Deletes an asset by its ID
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Header Parameters
X-Delete-Type:
string
The X Delete Type header value.
Response
Asset deleted
Update Assets By Groupid By Assetid By Version Icon updateAssetsByGroupidByAssetidByVersionIcon
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body */*
Uploads an icon as a binary file.
- Body should be application/json. This is not specified in the raml as it conflicts with Osprey.
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Request Body
*/*Examples
Icon
{
"value": "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<!-- Generator: Adobe Illustrator 19.2.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->\n<svg version=\"1.1\" xmlns=\"http://www.w3.org/2000/svg\" x=\"0px\" y=\"0px\"\n viewBox=\"0 0 26 26\" enable-background=\"new 0 0 26 26\" xml:space=\"preserve\">\n<g id=\"guides\">\n</g>\n<g id=\"white\">\n</g>\n<g id=\"_x31_6_16\" display=\"none\">\n</g>\n<g id=\"content\">\n <path fill=\"#00A3E0\" d=\"M20.5492554,17.5856934l1.6424561,1.1501465C20.3830566,21.314209,17.3885498,23,13.999939,23\n c-4.8378296,0-8.8724365-3.4356689-9.7990723-8H1.9991455v-4h2.2017212c0.9266357-4.5643311,4.9612427-8,9.7990723-8\n c3.3886108,0,6.3831177,1.685791,8.1917725,4.2641602l-1.6424561,1.1501465C19.1008301,6.3518066,16.7059937,5,13.999939,5\n C9.5887451,5,6,8.5888672,6,13s3.5887451,8,7.999939,8C16.7059937,21,19.1008301,19.6481934,20.5492554,17.5856934z\"/>\n <path fill=\"#087299\" d=\"M24.0009766,12.0136719l-6.1418457-0.0118408C17.4136353,10.2785645,15.8623657,9,14,9\n c-2.2091064,0-3.999939,1.7907715-3.999939,4c0,2.2091064,1.7908325,4,3.999939,4\n c1.8660278,0,3.4203491-1.2834473,3.8622437-3.0118408L23.9970703,14L24.0009766,12.0136719z M14,15c-1.1027832,0-2-0.8972168-2-2\n s0.8972168-2,2-2c1.1028442,0,2,0.8972168,2,2S15.1028442,15,14,15z\"/>\n</g>\n<g id=\"grid\">\n</g>\n</svg>\n"
}
Response
Icon has been uploaded
Get Assets By Groupid By Assetid By Version Asset getAssetsByGroupidByAssetidByVersionAsset
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets an asset
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Response
Successful operation.
Examples
Asset
{
"value": {
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "2.0.0",
"minorVersion": "2.0",
"description": "My asset description",
"versionGroup": "v2",
"isPublic": false,
"name": "Asset with files",
"type": "rest-api",
"isSnapshot": false,
"status": "published",
"externalFile": {
"url": null
},
"createdDate": "2020-09-08T16:44:04.238000+00:00",
"updatedDate": "2020-09-08T16:44:04.217000+00:00",
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"labels": [
"asset-tag",
"another-tag"
],
"categories": [
{
"value": [
"value"
],
"displayName": "Category",
"key": "Category"
}
],
"customFields": [],
"mule3ConnectorMetadata": {
"fullVersion": null,
"featureId": null
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "d2dd14a6cbbb15869105d9755d2f8345",
"sha1": "d2dd14a6cbbb15869105d9755d2f8345",
"createdDate": "2020-09-08T16:44:03.861000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "d2dd14a6cbbb15869105d9755d2f8345",
"sha1": "d2dd14a6cbbb15869105d9755d2f8345",
"createdDate": "2020-09-08T16:44:03.887000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "d2dd14a6cbbb15869105d9755d2f8345",
"sha1": "d2dd14a6cbbb15869105d9755d2f8345",
"createdDate": "2020-09-08T16:44:04.117000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"rating": 5,
"numberOfRates": 1,
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"instances": [
{
"versionGroup": "v2",
"organizationId": "org.mule.modules",
"id": "mocking-service",
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "2.0.0",
"minorVersion": "2.0",
"productAPIVersion": "v2",
"environmentId": null,
"providerId": null,
"endpointUri": "https://anypoint.mulesoft.com/mocking/api/v1/sources/exchange/assets/org.mule.modules/asset-with-files/2.0.0/m",
"name": "Mocking Service",
"isPublic": true,
"type": "mocked",
"fullname": "Mocking Service",
"deprecated": false
}
],
"dependencies": [],
"generated": [
{
"roupId": "org.mule.modules",
"assetId": "mule-plugin-asset-with-files",
"version": "2.0.0",
"versionGroup": "2.0.0",
"name": "Asset with files",
"type": "extension",
"minMuleVersion": "4.1.1",
"files": [
{
"classifier": "icon",
"packaging": "svg",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/icon/svg",
"externalLink": "https://localhost/org.mule.modules/Dmule-plugin-asset-with-files-2.0.0-icon.svg",
"md5": "4e66d7d9944fae99cd10d802a9c02207",
"sha1": "00b2b3da2a1a886eeefc4d5fa5d8f049cef4e7e8",
"createdDate": "2020-09-08T16:37:12.435000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": "mule-plugin",
"packaging": "jar",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/mule-plugin/jar",
"externalLink": "https://localhost/org.mule.modules/mule-plugin-asset-with-files-2.0.0-mule-plugin.jar",
"md5": "a94d53d0a5522a83bcc7b8c6c7118ae0",
"sha1": "be58dd541aa71c947de488c174c44b016f13698c",
"createdDate": "2020-09-08T16:44:05.420000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": null,
"packaging": "pom",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/pom",
"externalLink": "https://localhost/org.mule.modules/mule-plugin-asset-with-files-2.0.0.pom",
"md5": "45ae05e606e34293314a4a189f9bbb92",
"sha1": "1d50e4a549975cb712ec56d9e7516a9a6849f025",
"createdDate": "2020-09-08T16:44:05.745000+00:00",
"mainFile": null,
"isGenerated": false
}
]
},
{
"groupId": "org.mule.modules",
"assetId": "mule-module-asset-with-files",
"version": "2.0.0",
"versionGroup": "2.0.0",
"name": "instagram Connector",
"type": "connector",
"minMuleVersion": "3.6.0",
"files": [
{
"classifier": null,
"packaging": "jar",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/jar",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0.jar",
"md5": "26ab438e482e032bb0187b5208ebc733",
"sha1": "72b1f94bafc6d71d92767315edbd3d4899498cb0",
"createdDate": "2020-09-08T16:44:19.813000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": null,
"packaging": "pom",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/pom",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0.pom",
"md5": "c92f82a5690cf7e129127ce77e10c4b0",
"sha1": "2b47d576700d141749d36f7fa4f9aae3f4bd94bf",
"createdDate": "2020-09-08T16:44:20.250000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": "studio-plugin",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/studio-plugin/zip",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0-studio-plugin.zip",
"md5": "abafce8dd4817861aea26c1d4ae37e8f",
"sha1": "cdba899a66202fed3683736ec91beb195e17faba",
"createdDate": "2020-09-08T16:44:21.680000+00:00",
"mainFile": null,
"isGenerated": false
}
]
}
],
"otherVersions": [
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "1.0.1",
"minorVersion": "1.0",
"versionGroup": "v1",
"isPublic": false,
"type": "rest-api",
"status": "published",
"createdDate": "2020-09-08T16:55:28.130000+00:00",
"updatedDate": "2020-09-08T16:55:28.115000+00:00",
"isSnapshot": false,
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"externalFile": {
"url": null
},
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "347f9598e3fed6e428e58380186ea294",
"sha1": "c4e5f88e56e66ba61d25ccb9fa0a81688bc7ec8f",
"createdDate": "2020-09-08T16:55:26.660000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "347f9598e3fed6e428e58380186ea294",
"sha1": "c4e5f88e56e66ba61d25ccb9fa0a81688bc7ec8f",
"createdDate": "2020-09-08T16:55:26.681000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "d4af802fbf1a35e0feb85ebc775582b9",
"sha1": "eb72390d770fe89d711ce295fb2973aa97ba0889",
"createdDate": "2020-09-08T16:55:27.956000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"dependencies": []
},
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "1.0.0",
"minorVersion": "1.0",
"versionGroup": "v1",
"isPublic": false,
"type": "rest-api",
"status": "published",
"createdDate": "2020-09-08T16:37:11.194000+00:00",
"updatedDate": "2020-09-08T16:44:04.217000+00:00",
"isSnapshot": false,
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"externalFile": {
"url": null
},
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "ec57fff8e8abd7169f20b9c0f3a65c03",
"sha1": "3f75b6252ba42a502bcd41771f9d847b09ea126e",
"createdDate": "2020-09-08T16:37:10.781000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "ec57fff8e8abd7169f20b9c0f3a65c03",
"sha1": "3f75b6252ba42a502bcd41771f9d847b09ea126e",
"createdDate": "2020-09-08T16:37:10.824000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "e6658956af113a1ce7771f649f1e1370",
"sha1": "73897231991441f0d0e0d9c15e2b30ebcb29d09d",
"createdDate": "2020-09-08T16:37:11.001000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"dependencies": []
}
],
"id": "org.mule.modules/asset-with-files/2.0.0",
"icon": "http://www.icon.com.ar",
"createdAt": "2020-09-08T16:44:04.238000+00:00",
"modifiedAt": "2020-09-08T16:44:04.217000+00:00",
"organization": {
"id": "org.mule.modules",
"name": "Mulesoft",
"parentOrganizationIds": [],
"subOrganizationIds": [],
"tenantOrganizationIds": [],
"isMaster": true,
"domain": "mulesoft-0000",
"isMulesoftOrganization": false
},
"permissions": [
"admin",
"edit"
],
"versions": [
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "2.0.0",
"minorVersion": "2.0",
"description": "",
"versionGroup": "v2",
"isPublic": false,
"name": "Asset with files",
"type": "rest-api",
"isSnapshot": false,
"status": "published",
"externalFile": {
"url": null
},
"createdDate": "2020-09-08T16:44:04.238000+00:00",
"updatedDate": "2020-09-08T16:44:04.217000+00:00",
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"labels": [
"asset-tag",
"another-tag"
],
"categories": [
{
"value": [
"value"
],
"displayName": "Category",
"key": "Category"
}
],
"customFields": [],
"mule3ConnectorMetadata": {
"fullVersion": null,
"featureId": null
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "b2fb0ee5430cf3947432ebdee9383c38",
"sha1": "c57be838629921bcdf7c0de4f56798205d0178c4",
"createdDate": "2020-09-08T16:44:03.861000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "b2fb0ee5430cf3947432ebdee9383c38",
"sha1": "c57be838629921bcdf7c0de4f56798205d0178c4",
"createdDate": "2020-09-08T16:44:03.887000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "d5e9236adfea9ef8b54c053795bf768b",
"sha1": "08bdcca2179479d385a772dfe0654253a3e2ac80",
"createdDate": "2020-09-08T16:44:04.117000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"rating": 5,
"numberOfRates": 1,
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"instances": [
{
"versionGroup": "v2",
"organizationId": "org.mule.modules",
"id": "mocking-service",
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "2.0.0",
"minorVersion": "2.0",
"productAPIVersion": "v2",
"environmentId": null,
"providerId": null,
"endpointUri": "https://anypoint.mulesoft.com/mocking/api/v1/sources/exchange/assets/org.mule.modules/asset-with-files/2.0.0/m",
"name": "Mocking Service",
"isPublic": true,
"type": "mocked",
"fullname": "Mocking Service",
"deprecated": false
}
],
"dependencies": [],
"generated": [
{
"groupId": "org.mule.modules",
"assetId": "mule-plugin-asset-with-files",
"version": "2.0.0",
"versionGroup": "2.0.0",
"name": "Asset with files",
"type": "extension",
"minMuleVersion": "4.1.1",
"files": [
{
"classifier": "icon",
"packaging": "svg",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/icon/svg",
"externalLink": "https://localhost/org.mule.modules/Dmule-plugin-asset-with-files-2.0.0-icon.svg",
"md5": "4e66d7d9944fae99cd10d802a9c02207",
"sha1": "00b2b3da2a1a886eeefc4d5fa5d8f049cef4e7e8",
"createdDate": "2020-09-08T16:37:12.435000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": "mule-plugin",
"packaging": "jar",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/mule-plugin/jar",
"externalLink": "https://localhost/org.mule.modules/mule-plugin-asset-with-files-2.0.0-mule-plugin.jar",
"md5": "a94d53d0a5522a83bcc7b8c6c7118ae0",
"sha1": "be58dd541aa71c947de488c174c44b016f13698c",
"createdDate": "2020-09-08T16:44:05.420000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": null,
"packaging": "pom",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/pom",
"externalLink": "https://localhost/org.mule.modules/mule-plugin-asset-with-files-2.0.0.pom",
"md5": "45ae05e606e34293314a4a189f9bbb92",
"sha1": "1d50e4a549975cb712ec56d9e7516a9a6849f025",
"createdDate": "2020-09-08T16:44:05.745000+00:00",
"mainFile": null,
"isGenerated": false
}
]
},
{
"groupId": "org.mule.modules",
"assetId": "mule-module-asset-with-files",
"version": "2.0.0",
"versionGroup": "2.0.0",
"name": "instagram Connector",
"type": "connector",
"minMuleVersion": "3.6.0",
"files": [
{
"classifier": null,
"packaging": "jar",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/jar",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0.jar",
"md5": "26ab438e482e032bb0187b5208ebc733",
"sha1": "72b1f94bafc6d71d92767315edbd3d4899498cb0",
"createdDate": "2020-09-08T16:44:19.813000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": null,
"packaging": "pom",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/pom",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0.pom",
"md5": "c92f82a5690cf7e129127ce77e10c4b0",
"sha1": "2b47d576700d141749d36f7fa4f9aae3f4bd94bf",
"createdDate": "2020-09-08T16:44:20.250000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": "studio-plugin",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/studio-plugin/zip",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0-studio-plugin.zip",
"md5": "abafce8dd4817861aea26c1d4ae37e8f",
"sha1": "cdba899a66202fed3683736ec91beb195e17faba",
"createdDate": "2020-09-08T16:44:21.680000+00:00",
"mainFile": null,
"isGenerated": false
}
]
}
],
"otherVersions": [
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "1.0.1",
"minorVersion": "1.0",
"versionGroup": "v1",
"isPublic": false,
"type": "rest-api",
"status": "published",
"createdDate": "2020-09-08T16:55:28.130000+00:00",
"updatedDate": "2020-09-08T16:55:28.115000+00:00",
"isSnapshot": false,
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"externalFile": {
"url": null
},
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "347f9598e3fed6e428e58380186ea294",
"sha1": "c4e5f88e56e66ba61d25ccb9fa0a81688bc7ec8f",
"createdDate": "2020-09-08T16:55:26.660000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "347f9598e3fed6e428e58380186ea294",
"sha1": "c4e5f88e56e66ba61d25ccb9fa0a81688bc7ec8f",
"createdDate": "2020-09-08T16:55:26.681000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "d4af802fbf1a35e0feb85ebc775582b9",
"sha1": "eb72390d770fe89d711ce295fb2973aa97ba0889",
"createdDate": "2020-09-08T16:55:27.956000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"dependencies": []
},
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "1.0.0",
"minorVersion": "1.0",
"versionGroup": "v1",
"isPublic": false,
"type": "rest-api",
"status": "published",
"createdDate": "2020-09-08T16:37:11.194000+00:00",
"updatedDate": "2020-09-08T16:44:04.217000+00:00",
"isSnapshot": false,
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"externalFile": {
"url": null
},
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "ec57fff8e8abd7169f20b9c0f3a65c03",
"sha1": "3f75b6252ba42a502bcd41771f9d847b09ea126e",
"createdDate": "2020-09-08T16:37:10.781000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "ec57fff8e8abd7169f20b9c0f3a65c03",
"sha1": "3f75b6252ba42a502bcd41771f9d847b09ea126e",
"createdDate": "2020-09-08T16:37:10.824000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "e6658956af113a1ce7771f649f1e1370",
"sha1": "73897231991441f0d0e0d9c15e2b30ebcb29d09d",
"createdDate": "2020-09-08T16:37:11.001000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"dependencies": []
}
],
"id": "org.mule.modules/asset-with-files/2.0.0",
"icon": "http://www.icon.com.ar",
"createdAt": "2020-09-08T16:44:04.238000+00:00",
"modifiedAt": "2020-09-08T16:44:04.217000+00:00",
"organization": {
"id": "org.mule.modules",
"name": "Mulesoft",
"parentOrganizationIds": [],
"subOrganizationIds": [],
"tenantOrganizationIds": [],
"isMaster": true,
"domain": "mulesoft-0000",
"isMulesoftOrganization": false
},
"permissions": [
"admin",
"edit"
]
}
]
}
}
Get Assets By Groupid By Assetid By Version Rating getAssetsByGroupidByAssetidByVersionRating
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets the asset rating
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Response
success
organizationId:
string
group:
string
assetId:
string
version:
string
rating:
number
numberOfRates:
integer
Examples
Rating
{
"value": {
"organizationId": "cccdb637d-9c15-4237-5341-c87c0s82c4f2",
"group": "com.mulesoft",
"assetId": "someasset",
"version": "1.0.0",
"rating": 5.22,
"numberOfRates": 45
}
}
Get Assets By Groupid By Assetid By Version Reviews getAssetsByGroupidByAssetidByVersionReviews
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets a list of reviews
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Query Parameters
includeComments:
any
Indicates to include comments or not in reviews
Response
success
items:
array
Array items
Examples
Reviews
{
"value": [
{
"id": "0fcd1f70-6181-49f9-98e1-bce958bb391d",
"userId": "Test-connector-1",
"version": "1.0.0",
"organizationId": "cccdb637d-9c15-4237-5341-c87c0s82c4f2",
"rating": 5,
"text": "Hey, this is a review",
"createdDate": "2016-07-15T17:33:36.542000+00:00",
"updatedDate": "2016-07-15T17:33:36.542000+00:00",
"comments": [
{
"id": "e47b5e4c-ea78-4f21-9d78-398762667cdd",
"userId": "0fcd1f70-6181-49f9-98e1-bce958bb391d",
"comment": "Hey, this is a comment for the review",
"createdDate": "2016-07-15T17:33:36.542000+00:00",
"updatedDate": "2016-07-15T17:33:36.542000+00:00"
}
]
}
]
}
Create Assets By Groupid By Assetid By Version Reviews createAssetsByGroupidByAssetidByVersionReviews
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new asset review
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Request Body
jsonrating *:
integer
min: 1, max: 5
text *:
string
minLength: 1, maxLength: 2048
title:
string
minLength: 1, maxLength: 30
Examples
CreateReview
{
"value": {
"rating": 3,
"title": "this is the review title",
"text": "This is a review"
}
}
Response
created
id:
string
userId:
string
version:
string
organizationId:
string
rating:
integer
text:
string
createdDate:
string
updatedDate:
string
comments:
array
Examples
Review
{
"value": {
"id": "0fcd1f70-6181-49f9-98e1-bce958bb391d",
"userId": "Test-connector-1",
"version": "1.0.0",
"organizationId": "cccdb637d-9c15-4237-5341-c87c0s82c4f2",
"rating": 5,
"text": "Hey, this is a review",
"createdDate": "2016-07-15T17:33:36.542000+00:00",
"updatedDate": "2016-07-15T17:33:36.542000+00:00",
"comments": [
{
"id": "e47b5e4c-ea78-4f21-9d78-398762667cdd",
"userId": "0fcd1f70-6181-49f9-98e1-bce958bb391d",
"comment": "Hey, this is a comment for the review",
"createdDate": "2016-07-15T17:33:36.542000+00:00",
"updatedDate": "2016-07-15T17:33:36.542000+00:00"
}
]
}
}
Patch Assets By Groupid By Assetid By Version Reviews By Reviewid patchAssetsByGroupidByAssetidByVersionReviewsByReviewid
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Edits an asset review
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
reviewId *:
string(uuid)
The review ID to identify the target resource.
Request Body
jsonrating:
integer
min: 1, max: 5
text:
string
maxLength: 2048
Examples
UpdateReview
{
"value": {
"rating": 5,
"text": "This is a review"
}
}
Response
success
id:
string
userId:
string
version:
string
organizationId:
string
rating:
integer
text:
string
createdDate:
string
updatedDate:
string
comments:
array
Examples
Review
{
"value": {
"id": "0fcd1f70-6181-49f9-98e1-bce958bb391d",
"userId": "Test-connector-1",
"version": "1.0.0",
"organizationId": "cccdb637d-9c15-4237-5341-c87c0s82c4f2",
"rating": 5,
"text": "Hey, this is a review",
"createdDate": "2016-07-15T17:33:36.542000+00:00",
"updatedDate": "2016-07-15T17:33:36.542000+00:00",
"comments": [
{
"id": "e47b5e4c-ea78-4f21-9d78-398762667cdd",
"userId": "0fcd1f70-6181-49f9-98e1-bce958bb391d",
"comment": "Hey, this is a comment for the review",
"createdDate": "2016-07-15T17:33:36.542000+00:00",
"updatedDate": "2016-07-15T17:33:36.542000+00:00"
}
]
}
}
Delete Assets By Groupid By Assetid By Version Reviews By Reviewid deleteAssetsByGroupidByAssetidByVersionReviewsByReviewid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes an specific asset review.
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
reviewId *:
string(uuid)
The review ID to identify the target resource.
Response
Review deleted
Get Assets By Groupid By Assetid By Version Api Model getAssetsByGroupidByAssetidByVersionApiModel
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets the JSON-LD model for this API
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Response
Returns the JSON-LD model for this API
Examples
JsonLD
{
"value": [
{
"@id": "valkyr-for-humans-api.raml",
"@type": [
"http://raml.org/vocabularies/document#Document",
"http://raml.org/vocabularies/document#Fragment",
"http://raml.org/vocabularies/document#Module",
"http://raml.org/vocabularies/document#Unit"
],
"http://raml.org/vocabularies/document#encodes": [
{
"@id": "valkyr-for-humans-api.raml#/web-api",
"@type": [
"http://schema.org/WebAPI",
"http://raml.org/vocabularies/document#RootDomainElement",
"http://raml.org/vocabularies/document#DomainElement"
],
"http://schema.org/name": [
{
"@value": "Valkyr for Humans API"
}
],
"http://schema.org/version": [
{
"@value": "v1"
}
],
"http://raml.org/vocabularies/http#endpoint": [
{
"@id": "valkyr-for-humans-api.raml#/web-api/end-points/%2Fservice",
"@type": [
"http://raml.org/vocabularies/http#EndPoint",
"http://raml.org/vocabularies/document#DomainElement"
],
"http://raml.org/vocabularies/http#path": [
{
"@value": "/service"
}
],
"http://www.w3.org/ns/hydra/core#supportedOperation": [
{
"@id": "valkyr-for-humans-api.raml#/web-api/end-points/%2Fservice/post",
"@type": [
"http://www.w3.org/ns/hydra/core#Operation",
"http://raml.org/vocabularies/document#DomainElement"
],
"http://www.w3.org/ns/hydra/core#method": [
{
"@value": "post"
}
],
"http://www.w3.org/ns/hydra/core#expects": [
{
"@id": "valkyr-for-humans-api.raml#/web-api/end-points/%2Fservice/post/request",
"@type": [
"http://raml.org/vocabularies/http#Request",
"http://raml.org/vocabularies/document#DomainElement"
],
"http://raml.org/vocabularies/http#payload": [
{
"@id": "valkyr-for-humans-api.raml#/web-api/end-points/%2Fservice/post/request/application/json",
"@type": [
"http://raml.org/vocabularies/http#Payload",
"http://raml.org/vocabularies/document#DomainElement"
],
"http://raml.org/vocabularies/http#mediaType": [
{
"@value": "application/json"
}
],
"http://raml.org/vocabularies/http#schema": [
{
"@id": "valkyr-for-humans-api.raml#/web-api/end-points/%2Fservice/post/request/application/json/schema",
"@type": [
"http://www.w3.org/ns/shacl#NodeShape",
"http://www.w3.org/ns/shacl#Shape",
"http://raml.org/vocabularies/shapes#Shape",
"http://raml.org/vocabularies/document#DomainElement"
],
"http://www.w3.org/ns/shacl#closed": [
{
"@value": false
}
],
"http://www.w3.org/ns/shacl#property": [
{
"@id": "valkyr-for-humans-api.raml#/web-api/end-points/%2Fservice/post/request/application/json/schema/property/product",
"@type": [
"http://www.w3.org/ns/shacl#PropertyShape",
"http://www.w3.org/ns/shacl#Shape",
"http://raml.org/vocabularies/shapes#Shape"
],
"http://www.w3.org/ns/shacl#path": [
{
"@id": "http://raml.org/vocabularies/data#product"
}
],
"http://raml.org/vocabularies/shapes#range": [
{
"@id": "valkyr-for-humans-api.raml#/web-api/end-points/%2Fservice/post/request/application/json/schema/property/product/scalar/product",
"@type": [
"http://raml.org/vocabularies/shapes#ScalarShape",
"http://www.w3.org/ns/shacl#Shape",
"http://raml.org/vocabularies/shapes#Shape",
"http://raml.org/vocabularies/document#DomainElement"
],
"http://www.w3.org/ns/shacl#datatype": [
{
"@id": "http://www.w3.org/2001/XMLSchema#string"
}
],
"http://www.w3.org/ns/shacl#name": [
{
"@value": "product"
}
]
}
],
"http://www.w3.org/ns/shacl#minCount": [
{
"@value": 1
}
],
"http://www.w3.org/ns/shacl#name": [
{
"@value": "product"
}
]
},
{
"@id": "valkyr-for-humans-api.raml#/web-api/end-points/%2Fservice/post/request/application/json/schema/property/component",
"@type": [
"http://www.w3.org/ns/shacl#PropertyShape",
"http://www.w3.org/ns/shacl#Shape",
"http://raml.org/vocabularies/shapes#Shape"
],
"http://www.w3.org/ns/shacl#path": [
{
"@id": "http://raml.org/vocabularies/data#component"
}
],
"http://raml.org/vocabularies/shapes#range": [
{
"@id": "valkyr-for-humans-api.raml#/web-api/end-points/%2Fservice/post/request/application/json/schema/property/component/scalar/component",
"@type": [
"http://raml.org/vocabularies/shapes#ScalarShape",
"http://www.w3.org/ns/shacl#Shape",
"http://raml.org/vocabularies/shapes#Shape",
"http://raml.org/vocabularies/document#DomainElement"
],
"http://www.w3.org/ns/shacl#datatype": [
{
"@id": "http://www.w3.org/2001/XMLSchema#string"
}
],
"http://www.w3.org/ns/shacl#name": [
{
"@value": "component"
}
]
}
],
"http://www.w3.org/ns/shacl#minCount": [
{
"@value": 1
}
],
"http://www.w3.org/ns/shacl#name": [
{
"@value": "component"
}
]
}
],
"http://www.w3.org/ns/shacl#name": [
{
"@value": "Service"
}
]
}
]
}
]
}
],
"http://www.w3.org/ns/hydra/core#returns": [
{
"@id": "valkyr-for-humans-api.raml#/web-api/end-points/%2Fservice/post/201",
"@type": [
"http://raml.org/vocabularies/http#Response",
"http://raml.org/vocabularies/document#DomainElement"
],
"http://schema.org/name": [
{
"@value": "201"
}
],
"http://www.w3.org/ns/hydra/core#statusCode": [
{
"@value": "201"
}
],
"http://raml.org/vocabularies/http#payload": [
{
"@id": "valkyr-for-humans-api.raml#/web-api/end-points/%2Fservice/post/201/application/json",
"@type": [
"http://raml.org/vocabularies/http#Payload",
"http://raml.org/vocabularies/document#DomainElement"
],
"http://raml.org/vocabularies/http#mediaType": [
{
"@value": "application/json"
}
],
"http://raml.org/vocabularies/http#schema": [
{
"@id": "valkyr-for-humans-api.raml#/web-api/end-points/%2Fservice/post/201/application/json/any/schema",
"@type": [
"http://raml.org/vocabularies/shapes#AnyShape",
"http://www.w3.org/ns/shacl#Shape",
"http://raml.org/vocabularies/shapes#Shape"
],
"http://www.w3.org/ns/shacl#name": [
{
"@value": "schema"
}
]
}
]
}
]
},
{
"@id": "valkyr-for-humans-api.raml#/web-api/end-points/%2Fservice/post/409",
"@type": [
"http://raml.org/vocabularies/http#Response",
"http://raml.org/vocabularies/document#DomainElement"
],
"http://schema.org/name": [
{
"@value": "409"
}
],
"http://www.w3.org/ns/hydra/core#statusCode": [
{
"@value": "409"
}
]
}
]
},
{
"@id": "valkyr-for-humans-api.raml#/web-api/end-points/%2Fservice/delete",
"@type": [
"http://www.w3.org/ns/hydra/core#Operation",
"http://raml.org/vocabularies/document#DomainElement"
],
"http://www.w3.org/ns/hydra/core#method": [
{
"@value": "delete"
}
],
"http://www.w3.org/ns/hydra/core#returns": [
{
"@id": "valkyr-for-humans-api.raml#/web-api/end-points/%2Fservice/delete/204",
"@type": [
"http://raml.org/vocabularies/http#Response",
"http://raml.org/vocabularies/document#DomainElement"
],
"http://schema.org/name": [
{
"@value": "204"
}
],
"http://www.w3.org/ns/hydra/core#statusCode": [
{
"@value": "204"
}
]
}
]
}
]
}
]
}
],
"http://raml.org/vocabularies/document#declares": [
{
"@id": "types/Service.raml/type",
"@type": [
"http://www.w3.org/ns/shacl#NodeShape",
"http://www.w3.org/ns/shacl#Shape",
"http://raml.org/vocabularies/shapes#Shape",
"http://raml.org/vocabularies/document#DomainElement"
],
"http://www.w3.org/ns/shacl#closed": [
{
"@value": false
}
],
"http://www.w3.org/ns/shacl#property": [
{
"@id": "types/Service.raml/type/property/product",
"@type": [
"http://www.w3.org/ns/shacl#PropertyShape",
"http://www.w3.org/ns/shacl#Shape",
"http://raml.org/vocabularies/shapes#Shape"
],
"http://www.w3.org/ns/shacl#path": [
{
"@id": "http://raml.org/vocabularies/data#product"
}
],
"http://raml.org/vocabularies/shapes#range": [
{
"@id": "types/Service.raml/type/property/product/scalar/product",
"@type": [
"http://raml.org/vocabularies/shapes#ScalarShape",
"http://www.w3.org/ns/shacl#Shape",
"http://raml.org/vocabularies/shapes#Shape",
"http://raml.org/vocabularies/document#DomainElement"
],
"http://www.w3.org/ns/shacl#datatype": [
{
"@id": "http://www.w3.org/2001/XMLSchema#string"
}
],
"http://www.w3.org/ns/shacl#name": [
{
"@value": "product"
}
]
}
],
"http://www.w3.org/ns/shacl#minCount": [
{
"@value": 1
}
],
"http://www.w3.org/ns/shacl#name": [
{
"@value": "product"
}
]
},
{
"@id": "types/Service.raml/type/property/component",
"@type": [
"http://www.w3.org/ns/shacl#PropertyShape",
"http://www.w3.org/ns/shacl#Shape",
"http://raml.org/vocabularies/shapes#Shape"
],
"http://www.w3.org/ns/shacl#path": [
{
"@id": "http://raml.org/vocabularies/data#component"
}
],
"http://raml.org/vocabularies/shapes#range": [
{
"@id": "types/Service.raml/type/property/component/scalar/component",
"@type": [
"http://raml.org/vocabularies/shapes#ScalarShape",
"http://www.w3.org/ns/shacl#Shape",
"http://raml.org/vocabularies/shapes#Shape",
"http://raml.org/vocabularies/document#DomainElement"
],
"http://www.w3.org/ns/shacl#datatype": [
{
"@id": "http://www.w3.org/2001/XMLSchema#string"
}
],
"http://www.w3.org/ns/shacl#name": [
{
"@value": "component"
}
]
}
],
"http://www.w3.org/ns/shacl#minCount": [
{
"@value": 1
}
],
"http://www.w3.org/ns/shacl#name": [
{
"@value": "component"
}
]
}
],
"http://www.w3.org/ns/shacl#name": [
{
"@value": "Service"
}
]
}
],
"http://raml.org/vocabularies/document#references": [
{
"@id": "types/Service.raml",
"@type": [
"http://raml.org/vocabularies/document#DataType",
"http://raml.org/vocabularies/document#Fragment",
"http://raml.org/vocabularies/document#Unit"
],
"http://raml.org/vocabularies/document#encodes": [
{
"@id": "types/Service.raml/type",
"@type": [
"http://www.w3.org/ns/shacl#NodeShape",
"http://www.w3.org/ns/shacl#Shape",
"http://raml.org/vocabularies/shapes#Shape",
"http://raml.org/vocabularies/document#DomainElement"
],
"http://www.w3.org/ns/shacl#closed": [
{
"@value": false
}
],
"http://www.w3.org/ns/shacl#property": [
{
"@id": "types/Service.raml/type/property/product",
"@type": [
"http://www.w3.org/ns/shacl#PropertyShape",
"http://www.w3.org/ns/shacl#Shape",
"http://raml.org/vocabularies/shapes#Shape"
],
"http://www.w3.org/ns/shacl#path": [
{
"@id": "http://raml.org/vocabularies/data#product"
}
],
"http://raml.org/vocabularies/shapes#range": [
{
"@id": "types/Service.raml/type/property/product/scalar/product",
"@type": [
"http://raml.org/vocabularies/shapes#ScalarShape",
"http://www.w3.org/ns/shacl#Shape",
"http://raml.org/vocabularies/shapes#Shape",
"http://raml.org/vocabularies/document#DomainElement"
],
"http://www.w3.org/ns/shacl#datatype": [
{
"@id": "http://www.w3.org/2001/XMLSchema#string"
}
],
"http://www.w3.org/ns/shacl#name": [
{
"@value": "product"
}
]
}
],
"http://www.w3.org/ns/shacl#minCount": [
{
"@value": 1
}
],
"http://www.w3.org/ns/shacl#name": [
{
"@value": "product"
}
]
},
{
"@id": "types/Service.raml/type/property/component",
"@type": [
"http://www.w3.org/ns/shacl#PropertyShape",
"http://www.w3.org/ns/shacl#Shape",
"http://raml.org/vocabularies/shapes#Shape"
],
"http://www.w3.org/ns/shacl#path": [
{
"@id": "http://raml.org/vocabularies/data#component"
}
],
"http://raml.org/vocabularies/shapes#range": [
{
"@id": "types/Service.raml/type/property/component/scalar/component",
"@type": [
"http://raml.org/vocabularies/shapes#ScalarShape",
"http://www.w3.org/ns/shacl#Shape",
"http://raml.org/vocabularies/shapes#Shape",
"http://raml.org/vocabularies/document#DomainElement"
],
"http://www.w3.org/ns/shacl#datatype": [
{
"@id": "http://www.w3.org/2001/XMLSchema#string"
}
],
"http://www.w3.org/ns/shacl#name": [
{
"@value": "component"
}
]
}
],
"http://www.w3.org/ns/shacl#minCount": [
{
"@value": 1
}
],
"http://www.w3.org/ns/shacl#name": [
{
"@value": "component"
}
]
}
],
"http://www.w3.org/ns/shacl#name": [
{
"@value": "Service"
}
]
}
]
}
]
}
]
}
Get Assets By Groupid By Assetid By Version Api Root getAssetsByGroupidByAssetidByVersionApiRoot
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Redirects to path of root file for this API
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Response
Redirection to root file if available.
Get Assets By Groupid By Assetid By Version Api Filepath getAssetsByGroupidByAssetidByVersionApiFilepath
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets the API file content
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
filePath *:
string
The filePath to identify the target resource.
Response
Retrieved file contents for the specified file.
- For example, if api.raml was specified the response will be that raml.
Get Assets By Groupid By Assetid By Version Domain getAssetsByGroupidByAssetidByVersionDomain
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets domain
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Response
Gets the domain
Get Assets By Groupid By Assetid By Version Portal getAssetsByGroupidByAssetidByVersionPortal
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets an asset portal
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Response
success
draftStatus:
string
pages:
any
Examples
Pages
{
"value": {
"draftStatus": "PUBLISHED",
"pages": [
{
"path": "home.md",
"name": "Home page"
},
{
"path": "/examples/example.md",
"name": "Example Page"
}
]
}
}
Patch Assets By Groupid By Assetid By Version Portal patchAssetsByGroupidByAssetidByVersionPortal
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Publishes draft version.
This endpoint should be executed without specifying any body.
This endpoint should be executed without specifying any body.
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Response
Asset documentation updated
Get Assets By Groupid By Assetid By Version Portal Pages getAssetsByGroupidByAssetidByVersionPortalPages
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets a list of pages
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Response
success
items:
array
Array items
Examples
value
{
"value": [
{
"path": "home.md",
"name": "Home page"
},
{
"path": "/examples/example.md",
"name": "Example Page"
}
]
}
Get Assets By Groupid By Assetid By Version Portal Pages Pagepath getAssetsByGroupidByAssetidByVersionPortalPagesPagepath
GET
Try it out
Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Gets a particular page
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
pagePath *:
string
The pagePath to identify the target resource.
Header Parameters
x-public-portal-domain:
string
The x public portal domain header value.
x-forwarded-host:
string
The x forwarded host header value.
x-forwarded-path:
string
The x forwarded path header value.
Response
success to get a page
path:
string
name:
string
Examples
PageHTML
{
"value": "<h1>\n Salesforce to Salesforce, Workday, SAP and Database Account Broadcast\n</h1>\n<p>\n <em>\n Real time synchronization of accounts from one Salesforce org to another as well as a Workday HCM instance, an SAP instance and a Database using a non-persistent JMS topic.\n </em>\n</p>\n<h2>\n Description\n</h2>\n<p>\n This Anypoint Template should serve as a foundation for setting an online sync of accounts from a Salesforce instance to many destination systems, using the Publish-subscribe pattern. Every time there is a new account or a change in an already existing one, the integration will poll for changes in the Salesforce source Org, publish the changes to a JMS topic and each subscriber will be responsible for updating the accounts in the target systems.\\n\\nThe application has two different batch jobs consuming this JMS topic, one for migrating the changes to the second Salesforce Org and the other one for migrating the changes to the Database. During the Process stage, each Salesforce account will be matched with an existing account in the Salesforce Org B or the Database by Name. The last step of the Process stage will group the accounts and create/update them in Salesforce Org B.\\n\\nFinally during the On Complete stage the Anypoint Template will log output statistics data into the console.\\n\\nRead more about the Publish-Subscribe pattern in <a href=\"http://blogs.mulesoft.com/introducing-pubsub-pattern-anypoint-templates/\">this</a> blog post\n</p>\n"
}
PageHTML
{
"value": "# Salesforce to Salesforce, Workday, SAP and Database Account Broadcast\n\n_Real time synchronization of accounts from one Salesforce org to another as well as a Workday HCM instance, an SAP instance and a Database using a non-persistent JMS topic._\n\n## Description\n\nThis Anypoint Template should serve as a foundation for setting an online sync of accounts from a Salesforce instance to many destination systems, using the Publish-subscribe pattern. Every time there is a new account or a change in an already existing one, the integration will poll for changes in the Salesforce source Org, publish the changes to a JMS topic and each subscriber will be responsible for updating the accounts in the target systems.\n\nThe application has two different batch jobs consuming this JMS topic, one for migrating the changes to the second Salesforce Org and the other one for migrating the changes to the Database. During the Process stage, each Salesforce account will be matched with an existing account in the Salesforce Org B or the Database by Name. The last step of the Process stage will group the accounts and create/update them in Salesforce Org B.\n\nFinally during the On Complete stage the Anypoint Template will log output statistics data into the console.\n\nRead more about the Publish-Subscribe pattern in [this](http://blogs.mulesoft.com/introducing-pubsub-pattern-anypoint-templates/) blog post\n"
}
Page
{
"value": {
"path": "home",
"name": "Home page"
}
}
Get Assets By Groupid By Assetid By Version Portal Resources getAssetsByGroupidByAssetidByVersionPortalResources
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets portals resources
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Response
Retrieved list of resources
Examples
application/json
[
{
"path": "resources/file-a0a5db36-940e-447b-9100-05b166b2c084.jpg"
}
]
Get Assets By Groupid By Assetid By Version Portal Resources By Resourceid getAssetsByGroupidByAssetidByVersionPortalResourcesByResourceid
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets portals resource
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
resourceId *:
string
The resource ID to identify the target resource.
Response
Retrieved file as a binary content
Get Assets By Groupid By Assetid By Version Portal Draft getAssetsByGroupidByAssetidByVersionPortalDraft
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets an asset portal
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Response
success
draftStatus:
string
pages:
any
Examples
Pages
{
"value": {
"draftStatus": "PUBLISHED",
"pages": [
{
"path": "home.md",
"name": "Home page"
},
{
"path": "/examples/example.md",
"name": "Example Page"
}
]
}
}
Update Assets By Groupid By Assetid By Version Portal Draft updateAssetsByGroupidByAssetidByVersionPortalDraft
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Publishes asset documentation draft.
This endpoint should be executed without specifying any body.
This endpoint should be executed without specifying any body.
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Response
Asset documentation updated
Delete Assets By Groupid By Assetid By Version Portal Draft deleteAssetsByGroupidByAssetidByVersionPortalDraft
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Discards asset documentation draft
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Response
Draft deleted
Get Assets By Groupid By Assetid By Version Portal Draft Pages getAssetsByGroupidByAssetidByVersionPortalDraftPages
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets a list of pages
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Response
success
path:
string
name:
string
Examples
Page
{
"value": {
"path": "home",
"name": "Home page"
}
}
Create Assets By Groupid By Assetid By Version Portal Draft Pages createAssetsByGroupidByAssetidByVersionPortalDraftPages
POST
Try it out
Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates an empty page for a draft version. Remember that:
- A page cannot be moved/created to/in a path that already contains another page with the same name.
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Header Parameters
x-move-source:
string
The x move source header value.
Request Body
jsonpagePath *:
string
Examples
CreatePage
{
"value": {
"pagePath": "docs/faq"
}
}
Response
Page created.
Get Assets By Groupid By Assetid By Version Portal Draft Pages Pagepath getAssetsByGroupidByAssetidByVersionPortalDraftPagesPagepath
GET
Try it out
Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Gets particular pages for a specific version of an asset
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
pagePath *:
string
The pagePath to identify the target resource.
Header Parameters
x-public-portal-domain:
string
The x public portal domain header value.
x-forwarded-host:
string
The x forwarded host header value.
x-forwarded-path:
string
The x forwarded path header value.
Response
Get a page in specified format
path:
string
name:
string
Examples
PageHTML
{
"value": "<h1>\n Salesforce to Salesforce, Workday, SAP and Database Account Broadcast\n</h1>\n<p>\n <em>\n Real time synchronization of accounts from one Salesforce org to another as well as a Workday HCM instance, an SAP instance and a Database using a non-persistent JMS topic.\n </em>\n</p>\n<h2>\n Description\n</h2>\n<p>\n This Anypoint Template should serve as a foundation for setting an online sync of accounts from a Salesforce instance to many destination systems, using the Publish-subscribe pattern. Every time there is a new account or a change in an already existing one, the integration will poll for changes in the Salesforce source Org, publish the changes to a JMS topic and each subscriber will be responsible for updating the accounts in the target systems.\\n\\nThe application has two different batch jobs consuming this JMS topic, one for migrating the changes to the second Salesforce Org and the other one for migrating the changes to the Database. During the Process stage, each Salesforce account will be matched with an existing account in the Salesforce Org B or the Database by Name. The last step of the Process stage will group the accounts and create/update them in Salesforce Org B.\\n\\nFinally during the On Complete stage the Anypoint Template will log output statistics data into the console.\\n\\nRead more about the Publish-Subscribe pattern in <a href=\"http://blogs.mulesoft.com/introducing-pubsub-pattern-anypoint-templates/\">this</a> blog post\n</p>\n"
}
PageMarkdown
{
"value": "# Salesforce to Salesforce, Workday, SAP and Database Account Broadcast\n\n_Real time synchronization of accounts from one Salesforce org to another as well as a Workday HCM instance, an SAP instance and a Database using a non-persistent JMS topic._\n\n## Description\n\nThis Anypoint Template should serve as a foundation for setting an online sync of accounts from a Salesforce instance to many destination systems, using the Publish-subscribe pattern. Every time there is a new account or a change in an already existing one, the integration will poll for changes in the Salesforce source Org, publish the changes to a JMS topic and each subscriber will be responsible for updating the accounts in the target systems.\n\nThe application has two different batch jobs consuming this JMS topic, one for migrating the changes to the second Salesforce Org and the other one for migrating the changes to the Database. During the Process stage, each Salesforce account will be matched with an existing account in the Salesforce Org B or the Database by Name. The last step of the Process stage will group the accounts and create/update them in Salesforce Org B.\n\nFinally during the On Complete stage the Anypoint Template will log output statistics data into the console.\n\nRead more about the Publish-Subscribe pattern in [this](http://blogs.mulesoft.com/introducing-pubsub-pattern-anypoint-templates/) blog post\n"
}
Page
{
"value": {
"path": "home",
"name": "Home page"
}
}
Update Assets By Groupid By Assetid By Version Portal Draft Pages Pagepath updateAssetsByGroupidByAssetidByVersionPortalDraftPagesPagepath
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body text/markdown
Updates a page for a version of an asset portal
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
pagePath *:
string
The pagePath to identify the target resource.
Request Body
markdownExamples
PageMarkdown
{
"value": "# Salesforce to Salesforce, Workday, SAP and Database Account Broadcast\n\n_Real time synchronization of accounts from one Salesforce org to another as well as a Workday HCM instance, an SAP instance and a Database using a non-persistent JMS topic._\n\n## Description\n\nThis Anypoint Template should serve as a foundation for setting an online sync of accounts from a Salesforce instance to many destination systems, using the Publish-subscribe pattern. Every time there is a new account or a change in an already existing one, the integration will poll for changes in the Salesforce source Org, publish the changes to a JMS topic and each subscriber will be responsible for updating the accounts in the target systems.\n\nThe application has two different batch jobs consuming this JMS topic, one for migrating the changes to the second Salesforce Org and the other one for migrating the changes to the Database. During the Process stage, each Salesforce account will be matched with an existing account in the Salesforce Org B or the Database by Name. The last step of the Process stage will group the accounts and create/update them in Salesforce Org B.\n\nFinally during the On Complete stage the Anypoint Template will log output statistics data into the console.\n\nRead more about the Publish-Subscribe pattern in [this](http://blogs.mulesoft.com/introducing-pubsub-pattern-anypoint-templates/) blog post\n"
}
Response
Page updated
Delete Assets By Groupid By Assetid By Version Portal Draft Pages Pagepath deleteAssetsByGroupidByAssetidByVersionPortalDraftPagesPagepath
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes a page of a version of an asset portal
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
pagePath *:
string
The pagePath to identify the target resource.
Response
Page deleted
Update Assets By Groupid By Assetid By Version Portal Draft Pagesorder updateAssetsByGroupidByAssetidByVersionPortalDraftPagesorder
PUT
Try it out
Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Saves the pages order for portal
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Header Parameters
X-Pages-Order-Revision:
string
The X Pages Order Revision header value.
minLength: 1
Request Body
jsonitems:
array
Array items
Response
Pages order stored successfully
Get Assets By Groupid By Assetid By Version Portal Draft Resources getAssetsByGroupidByAssetidByVersionPortalDraftResources
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets portals resources
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Response
Retrieved list of resources
Examples
application/json
[
{
"path": "resources/file-a0a5db36-940e-447b-9100-05b166b2c084.jpg"
}
]
Create Assets By Groupid By Assetid By Version Portal Draft Resources createAssetsByGroupidByAssetidByVersionPortalDraftResources
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body */*
Creates a resource for the portal draft.
The required multipart fields in the body are the path of the resource and the content type. Ex:
-F "Content-Type=image/png"
-F "file=@/Users/llucas/Documents/image.png"
The required multipart fields in the body are the path of the resource and the content type. Ex:
-F "Content-Type=image/png"
-F "file=@/Users/llucas/Documents/image.png"
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Request Body
*/*Response
Successfully created the portal resource
Examples
application/json
{
"path": "resources/dog.jpg",
"commitId": "eda56891-efab-40e0-a9ff-064e79327d17"
}
Get Assets By Groupid By Assetid By Version Portal Draft Resources By Resourceid getAssetsByGroupidByAssetidByVersionPortalDraftResourcesByResourceid
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets portals resource
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
resourceId *:
string
The resource ID to identify the target resource.
Response
Retrieved file as a binary content
Delete Assets By Groupid By Assetid By Version Portal Draft Resources By Resourceid deleteAssetsByGroupidByAssetidByVersionPortalDraftResourcesByResourceid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes a resource
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
resourceId *:
string
The resource ID to identify the target resource.
Response
Resource deleted
Get Assets By Groupid By Assetid By Version Policies Instances getAssetsByGroupidByAssetidByVersionPoliciesInstances
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets an array of API instances affected by the policy
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Query Parameters
limit:
any
Amount of objects retrieved in the response
offset:
any
The offset specifies the offset of the first row to return
sort:
string
Property to sort by
ascending:
any
Order for sorting
Response
Successfully completed
Examples
application/json
[
{
"apiName": "8becfaac-7f03-4272-a5cd-fd83177af58d",
"environment": "production",
"instanceName": "v1:7",
"apiVersion": "v1",
"url": "localhost:8088/api/v1"
},
{
"apiName": "8becfaac-7f03-4272-a5cd-fd83177af58d",
"environment": "production",
"instanceName": "v1:8",
"apiVersion": "v1",
"url": "localhost:8088/api/v1"
}
]
Get Assets By Groupid By Assetid By Version Policies Implementations getAssetsByGroupidByAssetidByVersionPoliciesImplementations
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets an array with implementations of a specific policy
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Response
Successfully completed
Examples
application/json
[
{
"name": "skywalker saga - Mule 4 - implementation",
"groupId": "20a27e6b-79a5-4a0f-9c81-ce6b9784a15a",
"organizationId": "20a27e6b-79a5-4a0f-9c81-ce6b9784a15a",
"assetId": "skywalker-implementation",
"version": "1.0.0",
"technology": "mule4",
"permissions": [
"admin",
"view"
],
"createdDate": "2022-01-03T19:46:54.763000+00:00",
"minRuntimeVersion": "4.1.1",
"maxRuntimeVersion": "4.2.0"
},
{
"name": "skywalker saga - Mule 4 - implementation",
"groupId": "20a27e6b-79a5-4a0f-9c81-ce6b9784a15a",
"organizationId": "20a27e6b-79a5-4a0f-9c81-ce6b9784a15a",
"assetId": "skywalker-implementation",
"version": "1.1.0",
"technology": "mule4",
"permissions": [
"admin",
"view"
],
"createdDate": "2022-01-03T19:46:54.763000+00:00",
"minRuntimeVersion": "4.1.1"
},
{
"name": "skywalker saga - flex- implementation",
"groupId": "20a27e6b-79a5-4a0f-9c81-ce6b9784a15a",
"organizationId": "20a27e6b-79a5-4a0f-9c81-ce6b9784a15a",
"assetId": "skywalker-implementation-flex",
"version": "1.0.0",
"technology": "flexGateway",
"permissions": [
"admin",
"view"
],
"createdDate": "2022-01-03T19:46:54.763000+00:00",
"minRuntimeVersion": "1.0.0",
"maxRuntimeVersion": "2.0.0"
}
]
Get Assets By Groupid By Assetid By Version Policies Environments getAssetsByGroupidByAssetidByVersionPoliciesEnvironments
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets an array with environments affected by the policy
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Query Parameters
limit:
any
Amount of objects retrieved in the response
offset:
any
The offset specifies the offset of the first row to return
sort:
string
Property to sort by
ascending:
any
Order for sorting
Response
Successfully completed
Examples
application/json
[
{
"environment": "production",
"url": "localhost:8088/api/v1"
}
]
Update Assets By Groupid By Assetid By Version Tags updateAssetsByGroupidByAssetidByVersionTags
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Upserts asset tags
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Request Body
jsonitems:
array
Array items
Examples
Tags
Response
Tags updated
Update Assets By Groupid By Assetid By Version Tags Fields By Tagkey updateAssetsByGroupidByAssetidByVersionTagsFieldsByTagkey
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Update or create a custom field
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
tagKey *:
string
The tagKey to identify the target resource.
Response
Custom field updated
Delete Assets By Groupid By Assetid By Version Tags Fields By Tagkey deleteAssetsByGroupidByAssetidByVersionTagsFieldsByTagkey
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Delete a custom field
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
tagKey *:
string
The tagKey to identify the target resource.
Response
Custom field deleted
Update Assets By Groupid By Assetid By Version Tags Categories By Tagkey updateAssetsByGroupidByAssetidByVersionTagsCategoriesByTagkey
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates or creates a category.
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
tagKey *:
string
The tagKey to identify the target resource.
Request Body
jsonResponse
Successful operation.
Delete Assets By Groupid By Assetid By Version Tags Categories By Tagkey deleteAssetsByGroupidByAssetidByVersionTagsCategoriesByTagkey
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes a category
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
tagKey *:
string
The tagKey to identify the target resource.
Response
Operation completed successfully with no content returned.
Update Assets By Groupid By Assetid By Version Status updateAssetsByGroupidByAssetidByVersionStatus
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates asset status
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Request Body
jsonResponse
Asset status successfully updated
Get Assets By Groupid By Assetid By Version Actions getAssetsByGroupidByAssetidByVersionActions
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns list of available actions for this asset version
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Query Parameters
include *:
string
The include query parameter.
Response
Transition list was calculated and returned. Possible error codes are INVALID_TRANSITION, SNAPSHOT_TRANSITION, OLD_ASSET_HARD_DELETION, DEVELOPMENT_DEPENDENCIES, ASSET_HAS_DEPENDENTS
Examples
application/json
{
"statusTransitions": [
{
"affordance": "disallowed",
"affordanceDetails": [
{
"code": "INVALID_TRANSITION",
"description": "Transition from published to development is not allowed"
}
],
"targetStatus": "development"
},
{
"affordance": "allowed",
"affordanceDetails": [],
"targetStatus": "published"
},
{
"affordance": "allowed",
"affordanceDetails": [],
"targetStatus": "deprecated"
},
{
"affordance": "disallowed",
"affordanceDetails": [
{
"code": "ASSET_HAS_DEPENDENTS",
"description": "Asset has dependent assets"
}
],
"targetStatus": "deleted"
},
{
"affordance": "disallowed",
"affordanceDetails": [
{
"code": "ASSET_HAS_DEPENDENTS",
"description": "Asset has dependent assets"
},
{
"code": "OLD_ASSET_HARD_DELETION",
"description": "Cannot hard delete asset after more than 7 days"
}
],
"targetStatus": "hard-deleted"
}
]
}
Update Assets By Groupid By Assetid By Version Owner updateAssetsByGroupidByAssetidByVersionOwner
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Update Asset ownership
Path Parameters
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Request Body
jsoncreatedById *:
string
Response
success
Create Organizations Metrics Top createOrganizationsMetricsTop
POST
Try it out
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates top.
Header Parameters
content-type:
string
The content type header value.
default:
application/jsonaccept:
string
The accept header value.
default:
application/jsonRequest Body
jsonResponse
success
Examples
application/json
{
"periodType": "WEEK",
"fromDate": "2022-11-03T03:00:00+00:00",
"toDate": "2022-11-10T03:00:00+00:00",
"totalTopAssets": 3,
"pageNumber": 1,
"assets": [
{
"groupId": "cd7e8b06-e178-4167-9e36-1abf795a5b5e",
"assetId": "asssetname",
"ranking": 1,
"metrics": [
{
"metricId": "1621d354-bb5e-45b1-9ea3-767236c7dd08",
"score": 76,
"allTime": 1000,
"displayName": "Downloads",
"key": "assetDownload"
},
{
"metricId": "a57a91e6-5aaf-4863-b0fd-55b93318952a",
"score": 22,
"allTime": 2000,
"displayName": "Engagement",
"key": "engagement"
},
{
"metricId": "c07bba9e-8afc-4e44-9f99-ed9697c09272",
"displayName": "Imports from API Designer",
"key": "importsFromApid",
"score": 0,
"allTime": 0
},
{
"metricId": "283f0a5b-32d8-4cab-b18b-96477f2c1944",
"displayName": "Dependents",
"key": "assetDependent",
"score": 0,
"allTime": 0
},
{
"metricId": "bb572128-b2c6-45b4-814e-e9d84a834906",
"displayName": "Contracts",
"key": "assetContract",
"score": 0,
"allTime": 0
}
],
"organizationId": "cd7e8b06-e178-4167-9e36-1abf795a5b5e",
"version": "2.0.0",
"name": "AsssetName",
"description": "",
"type": "http-api",
"updatedDate": "2022-12-01T13:21:13.817000+00:00",
"contactEmail": null,
"contactName": null,
"assetCreatedDate": "2022-11-28T13:01:44.011000+00:00"
},
{
"groupId": "7f3d510c-bf27-4395-9b49-8ac8a9504d30",
"assetId": "asssetname",
"ranking": 2,
"metrics": [
{
"metricId": "1621d354-bb5e-45b1-9ea3-767236c7dd08",
"score": 76,
"allTime": 1000,
"displayName": "Downloads",
"key": "assetDownload"
},
{
"metricId": "a57a91e6-5aaf-4863-b0fd-55b93318952a",
"score": 22,
"allTime": 2000,
"displayName": "Engagement",
"key": "engagement"
},
{
"metricId": "c07bba9e-8afc-4e44-9f99-ed9697c09272",
"displayName": "Imports from API Designer",
"key": "importsFromApid",
"score": 0,
"allTime": 0
},
{
"metricId": "283f0a5b-32d8-4cab-b18b-96477f2c1944",
"displayName": "Dependents",
"key": "assetDependent",
"score": 0,
"allTime": 0
},
{
"metricId": "bb572128-b2c6-45b4-814e-e9d84a834906",
"displayName": "Contracts",
"key": "assetContract",
"score": 0,
"allTime": 0
}
],
"organizationId": "7f3d510c-bf27-4395-9b49-8ac8a9504d30",
"version": "1.0.0",
"name": "AsssetName",
"description": "",
"type": "http-api",
"updatedDate": "2022-10-13T14:54:32.507000+00:00",
"contactEmail": null,
"contactName": null,
"assetCreatedDate": "2022-10-13T14:54:32.716000+00:00"
}
]
}
Get Organizations By Masterorganizationid Clientproviders By Clientproviderid Granttypes getOrganizationsByMasterorganizationidClientprovidersByClientprovideridGranttypes
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets the grant types for the client provider
Path Parameters
masterOrganizationId *:
string(uuid)
The masterOrganization ID to identify the target resource.
Related Operations:
clientProviderId *:
string(uuid)
The clientProvider ID to identify the target resource.
Response
success
Examples
application/json
{
"type": {
"name": "ping"
},
"grant_types": [
{
"name": "password",
"label": "Resource Owner Grant",
"depends": [],
"exclude": [],
"required": false
},
{
"name": "implicit",
"label": "Implicit Grant",
"depends": [],
"exclude": [],
"required": false
},
{
"name": "client_credentials",
"label": "Client Credentials Grant",
"depends": [],
"exclude": [],
"required": false
},
{
"name": "authorization_code",
"label": "Authorization Code Grant",
"depends": [],
"exclude": [],
"required": false
},
{
"name": "refresh_token",
"label": "Refresh Token",
"depends": [
"authorization_code",
"password"
],
"exclude": [],
"required": false
}
]
}
Get Organizations By Organizationid Identities getOrganizationsByOrganizationidIdentities
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets identities for an organization
Path Parameters
organizationId *:
string(uuid)
Id of the organization
Query Parameters
search:
string
Search parameter used to filter facets
Response
success
Examples
application/json
[
{
"id": "3db3585a-db33-4fe6-b8e7-b91ac953e482",
"identityType": "user",
"username": "username",
"firstName": "Scott",
"lastName": "Lawson",
"email": "email@gmail.com",
"organization": {
"id": "d4e2bceb-baae-484c-92f3-3cc272256c7f",
"name": "Mulesoft Inc",
"domain": "mulesoft-inc"
}
}
]
Create Organizations By Organizationid Identities By Identityid Assets Authorize createOrganizationsByOrganizationidIdentitiesByIdentityidAssetsAuthorize
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body */*
return all assets a given identity has permission
Path Parameters
organizationId *:
string(uuid)
Id of the organization
identityId *:
string(uuid)
The identity ID to identify the target resource.
Request Body
*/*Response
success
Get Organizations By Masterorganizationid Applications getOrganizationsByMasterorganizationidApplications
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a list of client applications
Path Parameters
masterOrganizationId *:
string(uuid)
The masterOrganization ID to identify the target resource.
Related Operations:
Query Parameters
groupInstanceId:
any
This field is used to filter by API Group instance.
query:
string
Search or filter expression to narrow results.
includeContractsForApiVersion:
any
This field is used to filter by API version
ascending:
any
Order for sorting
apiInstanceId:
any
id of the api instance
offset:
any
The offset specifies the offset of the first row to return
limit:
any
Amount of objects retrieved in the response
sort:
string
Property to sort by
literalMatch:
any
Literal match
Response
success
items:
array
Array items
Examples
ClientApplications
{
"value": [
{
"masterOrganizationId": "40fbc081-bb0d-4aff-9fb7-f3a48fdeb958",
"id": 1,
"name": "The Amazing Application",
"description": "This is the description of The Amazing Application",
"grantTypes": [
"password",
"implicit",
"client_credentials",
"authorization_code",
"refresh_token"
],
"redirectUri": [
"http://localhost:9090",
"https://qax.anypoint.mulesoft.com/apiplatform/pingfederateqa/authentication/oauth2.html",
"https://qax.anypoint.mulesoft.com/apiplatform/pingfederateqa/admin/authentication/oauth2.html",
"https://api-notebook.anypoint.mulesoft.com/authenticate/oauth.html"
],
"contract": {
"id": 35885,
"status": "APPROVED",
"tier": {
"id": 1234,
"name": "Gold",
"description": null,
"limits": [
{
"timePeriodInMilliseconds": 60000,
"maximumRequests": 1000
},
{
"maximumRequests": 20000,
"timePeriodInMilliseconds": 3600000
}
],
"status": "ACTIVE"
}
}
}
]
}
Create Organizations By Masterorganizationid Applications createOrganizationsByMasterorganizationidApplications
POST
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Adds a client application
Path Parameters
masterOrganizationId *:
string(uuid)
The masterOrganization ID to identify the target resource.
Related Operations:
Query Parameters
apiGroupInstanceId:
any
The apiGroupInstance ID query parameter.
apiInstanceId:
any
id of the api instance
Request Body
jsonExamples
CreateClientApplication
{
"value": {
"description": "TestRequestAPIAccess description",
"name": "TestRequestAPIAccess",
"grantTypes": [
"password",
"implicit",
"client_credentials",
"authorization_code",
"refresh_token"
],
"redirectUri": [
"http://localhost:9090",
"https://qax.anypoint.mulesoft.com/apiplatform/pingfederateqa/authentication/oauth2.html",
"https://qax.anypoint.mulesoft.com/apiplatform/pingfederateqa/admin/authentication/oauth2.html",
"https://api-notebook.anypoint.mulesoft.com/authenticate/oauth.html"
],
"url": "https://localhost:8080"
}
}
Response
Application created
Examples
ClientApplication
{
"value": {
"description": "TestRequestAPIAccess description",
"name": "TestRequestAPIAccess",
"grantTypes": [
"password",
"implicit",
"client_credentials",
"authorization_code",
"refresh_token"
],
"redirectUri": [
"http://localhost:9090",
"https://qax.anypoint.mulesoft.com/apiplatform/pingfederateqa/authentication/oauth2.html",
"https://qax.anypoint.mulesoft.com/apiplatform/pingfederateqa/admin/authentication/oauth2.html",
"https://api-notebook.anypoint.mulesoft.com/authenticate/oauth.html"
],
"url": "https://localhost:8080",
"masterOrganizationId": "2f17a3df-a5f9-45e8-a8b4-41bd26d89236",
"clientId": "49670e55b98b4ad2be0b6fc20d2cafa2",
"clientSecret": "0fD00492a2554e5f9857598Dbd675472",
"id": 3
}
}
Get Organizations By Masterorganizationid Applications By Applicationid getOrganizationsByMasterorganizationidApplicationsByApplicationid
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets a client application
Path Parameters
masterOrganizationId *:
string(uuid)
The masterOrganization ID to identify the target resource.
Related Operations:
applicationId *:
string
The application ID to identify the target resource.
Response
Successful operation.
Examples
ClientApplication
{
"value": {
"description": "TestRequestAPIAccess description",
"name": "TestRequestAPIAccess",
"grantTypes": [
"password",
"implicit",
"client_credentials",
"authorization_code",
"refresh_token"
],
"redirectUri": [
"http://localhost:9090",
"https://qax.anypoint.mulesoft.com/apiplatform/pingfederateqa/authentication/oauth2.html",
"https://qax.anypoint.mulesoft.com/apiplatform/pingfederateqa/admin/authentication/oauth2.html",
"https://api-notebook.anypoint.mulesoft.com/authenticate/oauth.html"
],
"url": "https://localhost:8080",
"masterOrganizationId": "2f17a3df-a5f9-45e8-a8b4-41bd26d89236",
"clientId": "49670e55b98b4ad2be0b6fc20d2cafa2",
"clientSecret": "0fD00492a2554e5f9857598Dbd675472",
"id": 3
}
}
Patch Organizations By Masterorganizationid Applications By Applicationid patchOrganizationsByMasterorganizationidApplicationsByApplicationid
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates a client application
Path Parameters
masterOrganizationId *:
string(uuid)
The masterOrganization ID to identify the target resource.
Related Operations:
applicationId *:
string
The application ID to identify the target resource.
Request Body
jsonExamples
UpdateClientApplication
{
"value": {
"description": "TestRequestAPIAccess description",
"name": "TestRequestAPIAccess",
"grantTypes": [
"password",
"implicit",
"client_credentials",
"authorization_code",
"refresh_token"
],
"redirectUri": [
"http://localhost:9090",
"https://qax.anypoint.mulesoft.com/apiplatform/pingfederateqa/authentication/oauth2.html",
"https://qax.anypoint.mulesoft.com/apiplatform/pingfederateqa/admin/authentication/oauth2.html",
"https://api-notebook.anypoint.mulesoft.com/authenticate/oauth.html"
],
"url": "https://localhost:8080"
}
}
Response
Client application updated.
Examples
ClientApplication
{
"value": {
"description": "TestRequestAPIAccess description",
"name": "TestRequestAPIAccess",
"grantTypes": [
"password",
"implicit",
"client_credentials",
"authorization_code",
"refresh_token"
],
"redirectUri": [
"http://localhost:9090",
"https://qax.anypoint.mulesoft.com/apiplatform/pingfederateqa/authentication/oauth2.html",
"https://qax.anypoint.mulesoft.com/apiplatform/pingfederateqa/admin/authentication/oauth2.html",
"https://api-notebook.anypoint.mulesoft.com/authenticate/oauth.html"
],
"url": "https://localhost:8080",
"masterOrganizationId": "2f17a3df-a5f9-45e8-a8b4-41bd26d89236",
"clientId": "49670e55b98b4ad2be0b6fc20d2cafa2",
"clientSecret": "0fD00492a2554e5f9857598Dbd675472",
"id": 3
}
}
Delete Organizations By Masterorganizationid Applications By Applicationid deleteOrganizationsByMasterorganizationidApplicationsByApplicationid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes a client application
Path Parameters
masterOrganizationId *:
string(uuid)
The masterOrganization ID to identify the target resource.
Related Operations:
applicationId *:
string
The application ID to identify the target resource.
Response
Client application deleted.
Get Organizations By Masterorganizationid Applications By Applicationid Environments By Environmentid Apigroupinstances By Apigroupinstanceid Limits getOrganizationsByMasterorganizationidApplicationsByApplicationidEnvironmentsByEnvironmentidApigroupinstancesByApigroupinstanceidLimits
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets the list of instances of the API Group with their corresponding limit
Path Parameters
masterOrganizationId *:
string(uuid)
The masterOrganization ID to identify the target resource.
Related Operations:
applicationId *:
string
The application ID to identify the target resource.
environmentId *:
string
The environment ID to identify the target resource.
minLength: 36, maxLength: 36
Related Operations:
apiGroupInstanceId *:
any
The apiGroupInstance ID to identify the target resource.
Query Parameters
tierId *:
any
The tier ID query parameter.
Response
success
Examples
application/json
[
{
"apiVersionId": 307123,
"assetId": "oas-api-indexed",
"groupId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"assetVersion": "1.0.0",
"productVersion": "v1",
"organizationId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"environmentId": "90b78656-99e5-4754-a2ec-09f2eefc7d02",
"isPublic": true,
"tier": {
"audit": {
"created": {
"date": "2020-09-17T13:10:55.006000+00:00"
},
"updated": {}
},
"masterOrganizationId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"organizationId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"id": 173842,
"groupInstanceId": 1901,
"name": "Free",
"description": null,
"status": "ACTIVE",
"autoApprove": true,
"applicationCount": 0,
"limits": [
{
"visible": true,
"maximumRequests": 1,
"timePeriodInMilliseconds": 1000
}
]
}
}
]
Get Organizations By Masterorganizationid Applications By Applicationid Instances getOrganizationsByMasterorganizationidApplicationsByApplicationidInstances
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets the list of API instances for the application
Path Parameters
masterOrganizationId *:
string(uuid)
The masterOrganization ID to identify the target resource.
Related Operations:
applicationId *:
string
The application ID to identify the target resource.
Response
success
Examples
Instances
{
"value": [
{
"version": "1.0.0",
"audit": {
"created": {
"date": "2019-10-07T14:16:27.528000+00:00"
},
"updated": {
"date": "2019-12-20T17:57:59.147000+00:00"
}
},
"masterOrganizationId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"organizationId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"id": 300853,
"apiId": 242148,
"portalId": null,
"name": "v1:300853",
"instanceLabel": null,
"groupId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"assetId": "facebook",
"assetVersion": "1.0.0",
"productVersion": "v1",
"description": null,
"tags": [],
"order": 1,
"rootFileId": null,
"deprecated": false,
"lastActiveDate": null,
"endpointUri": null,
"environmentId": "90b78656-99e5-4754-a2ec-09f2eefc7d02",
"isPublic": true,
"stage": "release",
"terms": null,
"termsDate": null,
"fullname": "Facebook - QAx- v1:300853",
"assetName": "Facebook",
"environmentName": "QAx"
}
]
}
Get Organizations By Masterorganizationid Applications By Applicationid Instances By Instanceid Contracts getOrganizationsByMasterorganizationidApplicationsByApplicationidInstancesByInstanceidContracts
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets the list of contracts for an API instance
Path Parameters
masterOrganizationId *:
string(uuid)
The masterOrganization ID to identify the target resource.
Related Operations:
applicationId *:
string
The application ID to identify the target resource.
instanceId *:
any
The instance ID to identify the target resource.
Response
returns contracts of instance
Examples
InstanceContracts
{
"value": [
{
"audit": {
"created": {
"date": "2020-05-12T18:47:09.746000+00:00"
},
"updated": {
"date": "2020-07-27T14:35:16.685000+00:00"
}
},
"masterOrganizationId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"organizationId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"id": 298286,
"status": "APPROVED",
"approvedDate": "2020-07-27T14:35:16.685000+00:00",
"rejectedDate": null,
"revokedDate": null,
"applicationId": 213125,
"application": {
"audit": {
"created": {
"date": "2020-02-11T14:09:40.515000+00:00"
},
"updated": {
"date": "2020-07-28T20:54:51.546000+00:00"
}
},
"id": 213125,
"name": "Application",
"description": null,
"clientProvider": {},
"coreServicesId": "150bc7635a014fd38fc6deddee942561",
"url": null
},
"tierId": 138725,
"requestedTierId": null,
"apiVersionId": 699301,
"apiVersion": {
"audit": {
"created": {},
"updated": {}
},
"organizationId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"id": 699301,
"apiId": 309557,
"masterOrganizationId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"groupId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"assetId": "some-api",
"assetVersion": "1.0.0"
},
"partyId": null,
"partyName": null,
"condition": "APPLIED",
"tier": {
"id": 138725,
"name": "Free",
"description": null,
"limits": [
{
"timePeriodInMilliseconds": 60000,
"maximumRequests": 30
},
{
"timePeriodInMilliseconds": 86400000,
"maximumRequests": 1000
}
],
"status": "ACTIVE",
"autoApprove": true
},
"possibleTiers": [
{
"masterOrganizationId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"organizationId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"id": 138726,
"apiVersionId": 699301,
"name": "Improved",
"description": null,
"limits": [
{
"timePeriodInMilliseconds": 60000,
"maximumRequests": 30
}
],
"status": "ACTIVE",
"autoApprove": true,
"compareToActual": "LESS RESTRICTIVE"
},
{
"masterOrganizationId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"organizationId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"id": 138727,
"apiVersionId": 699301,
"name": "Premium",
"description": null,
"limits": [
{
"timePeriodInMilliseconds": 60000,
"maximumRequests": 60
}
],
"status": "ACTIVE",
"autoApprove": false,
"compareToActual": "LESS RESTRICTIVE"
}
],
"versionGroup": "v1",
"assetName": "Some API"
},
{
"audit": {
"created": {
"date": "2020-06-26T13:50:48.981000+00:00"
},
"updated": {}
},
"masterOrganizationId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"organizationId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"id": 336926,
"status": "APPROVED",
"approvedDate": "2020-06-26T13:50:48.995000+00:00",
"rejectedDate": null,
"revokedDate": null,
"applicationId": 213125,
"application": {
"audit": {
"created": {
"date": "2020-02-11T14:09:40.515000+00:00"
},
"updated": {
"date": "2020-07-28T20:54:51.546000+00:00"
}
},
"id": 213125,
"name": "Third application",
"description": null,
"clientProvider": {},
"coreServicesId": "150bc7635a014fd38fc6deddee942561",
"url": null
},
"tierId": 138733,
"requestedTierId": null,
"apiVersionId": null,
"partyId": null,
"partyName": null,
"condition": "NOT_APPLIED",
"apiGroupInstance": {
"audit": {
"created": {},
"updated": {}
},
"id": 3840,
"organizationId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"environmentId": "4b131683-a8d4-459d-8ada-deb6578dfaaa",
"assetId": "api-group",
"assetVersion": "1.0.0",
"productVersion": "v1",
"name": "undefined:3840",
"groupId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"apiGroupVersionId": 3689
},
"apiGroupInstanceId": 3840,
"tier": {
"id": 138733,
"name": "Group Free",
"description": null,
"status": "ACTIVE",
"autoApprove": true,
"limitsByApi": [
{
"apiId": 699301,
"groupId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"assetId": "some-api",
"assetVersion": "1.0.0",
"productVersion": "v1",
"organizationId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"limits": [
{
"timePeriodInMilliseconds": 60000,
"maximumRequests": 20
},
{
"timePeriodInMilliseconds": 86400000,
"maximumRequests": 500
}
]
}
],
"apiGroupInstanceId": 3840
},
"possibleTiers": [],
"versionGroup": "v1",
"assetName": "API Group"
}
]
}
Get Organizations By Masterorganizationid Applications By Applicationid Contracts getOrganizationsByMasterorganizationidApplicationsByApplicationidContracts
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets a list of applications with contracts with the application
Path Parameters
masterOrganizationId *:
string(uuid)
The masterOrganization ID to identify the target resource.
Related Operations:
applicationId *:
string
The application ID to identify the target resource.
Query Parameters
includeContractsForApiVersion:
any
This field is used to filter by API version
Response
Gets a list of contracts
items:
array
Array items
Examples
Contracts
{
"value": [
{
"id": 36444,
"status": "PENDING",
"requestedTier": {
"description": null,
"id": 14939,
"limits": [
{
"maximumRequests": 1000,
"timePeriodInMilliseconds": 60000
},
{
"maximumRequests": 20000,
"timePeriodInMilliseconds": 3600000
}
],
"name": "Gold"
}
},
{
"id": 13765,
"status": "APPROVED",
"tier": {
"description": null,
"id": 5770,
"limits": [
{
"maximumRequests": 5,
"timePeriodInMilliseconds": 60000
}
],
"name": "Silver"
}
}
]
}
Create Organizations By Masterorganizationid Applications By Applicationid Contracts createOrganizationsByMasterorganizationidApplicationsByApplicationidContracts
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a contract for an API or an API Group
Path Parameters
masterOrganizationId *:
string(uuid)
The masterOrganization ID to identify the target resource.
Related Operations:
applicationId *:
string
The application ID to identify the target resource.
Request Body
jsonExamples
CreateContract
{
"value": {
"acceptedTerms": true,
"apiId": 2345,
"environmentId": 1234,
"requestedTierId": 100,
"termsText": "These are the terms and conditions",
"productAPIVersion": "v1"
}
}
Response
Contract created
id:
integer
status:
string
requestedTier:
object
Examples
Contract
{
"value": {
"id": 1000,
"clientId": "314e6d88-4c0f-4259-95e1-2c9b06bffb6c",
"clientSecret": "2f17a3df-a5f9-45e8-a8b4-41bd26d89236",
"status": "ACTIVE",
"tier": {
"description": "est nihil magnam dolore et ipsa nulla omnis\ncupiditate consectetur qui tempore quaerat et consequatur sunt eos enim\nesse quasi et qui quis dolorum",
"id": 35,
"limits": [
{
"maximumRequests": 10000000,
"timePeriodInMilliseconds": 2592000000
}
],
"name": "enim 35",
"status": "DEPRECATED"
}
}
}
Patch Organizations By Masterorganizationid Applications By Applicationid Contracts By Contractid patchOrganizationsByMasterorganizationidApplicationsByApplicationidContractsByContractid
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates contract SLA tier for an API or an API Group
Path Parameters
masterOrganizationId *:
string(uuid)
The masterOrganization ID to identify the target resource.
Related Operations:
applicationId *:
string
The application ID to identify the target resource.
contractId *:
any
The contract ID to identify the target resource.
Request Body
jsonResponse
Contract updated
Examples
application/json
{
"id": 384818,
"status": "APPROVED",
"applicationId": 276068,
"clientId": "13d5201f05344a4193e1fe4b14e8cb4d",
"clientSecret": "285116794aE54Fa5C23BaE03D673EB09",
"tier": {
"id": 173842,
"groupInstanceId": 1901,
"name": "Free",
"description": null,
"defaultLimits": [
{
"visible": true,
"maximumRequests": 1,
"timePeriodInMilliseconds": 1000
}
],
"status": "ACTIVE",
"autoApprove": true
}
}
Create Organizations By Masterorganizationid Applications By Applicationid Secret Reset createOrganizationsByMasterorganizationidApplicationsByApplicationidSecretReset
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Resets the client secret for the application.
This endpoint should be executed without specifying any body.
This endpoint should be executed without specifying any body.
Path Parameters
masterOrganizationId *:
string(uuid)
The masterOrganization ID to identify the target resource.
Related Operations:
applicationId *:
string
The application ID to identify the target resource.
Response
Secret reseted
Delete Organizations By Organizationid deleteOrganizationsByOrganizationid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Unconditional delete organization
Path Parameters
organizationId *:
string(uuid)
Id of the organization
Response
Organization deleted
Create Organizations By Organizationid Assets By Groupid By Assetid By Version createOrganizationsByOrganizationidAssetsByGroupidByAssetidByVersion
POST
Try it out
Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Uploads an asset.
Available fields for describing the asset are: "name", "description", "type", "dependencies", "keywords", "files" and "status".
You can also add properties by prefixing them with “properties”, e.g: properties.apiVersion, properties.mainFile.
Available fields for describing the asset are: "name", "description", "type", "dependencies", "keywords", "files" and "status".
You can also add properties by prefixing them with “properties”, e.g: properties.apiVersion, properties.mainFile.
Path Parameters
organizationId *:
string(uuid)
Id of the organization
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Header Parameters
x-sync-publication:
any
The x sync publication header value.
default:
Falsex-allowed-api-spec-formats:
string
The x allowed api spec formats header value.
x-file-validation:
any
The x file validation header value.
default:
Truex-snapshots-allowed:
any
Indicates if snapshot publicataion is enabled.
x-strict-package:
any
Indicates if file is immutable.
default:
FalseContent-Type *:
string
The Content Type header value.
x-user-id:
string
The x user id header value.
x-assign-roles:
boolean
The x assign roles header value.
Response
Asset successfully created, If the publication was triggered as synchronic (through the header x-sync-publication)
Examples
application/json
{
"organizationId": "1da12ec1-7614-43a3-bf24-ff754cab8ddf",
"groupId": "1da12ec1-7614-43a3-bf24-ff754cab8ddf",
"assetId": "mulan",
"version": "1.0.9",
"name": "examplecitoSnap",
"type": "app"
}
Patch Organizations By Organizationid Assets By Groupid By Assetid By Version Mutabledata patchOrganizationsByOrganizationidAssetsByGroupidByAssetidByVersionMutabledata
PATCH
Try it out
Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Patch an asset mutable data
Path Parameters
organizationId *:
string(uuid)
Id of the organization
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Header Parameters
Content-Type *:
string
The Content Type header value.
Response
Asset asynchronous mutable data publication has been started, the link provided in the body will have the necessary information to know its status
Examples
application/json
{
"mutableDataStatusLink": "https://anypoint.mulesoft.com/exchange/api/v2/organizations/1da12ec1-7614-43a3-bf24-ff754cab8ddf/assets/1da12ec1-7614-43a3-bf24-ff754cab8ddf/mulapp/1.0.0/mutabledata/status/543254325432"
}
Get Organizations By Organizationid Groups By Groupid Assets By Assetid Nextavailableversion getOrganizationsByOrganizationidGroupsByGroupidAssetsByAssetidNextavailableversion
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Returns the highest next available version, considering soft-deleted and snapshot versions
Path Parameters
organizationId *:
string(uuid)
Id of the organization
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
Query Parameters
versionOrder:
string
Specifies the position by which the version should be increased (PATCH, MINOR, MAJOR)
default:
PATCHResponse
success
Examples
application/json
{
"nextAvailableVersion": "1.2.0"
}
Get Organizations By Organizationid Assets By Groupid By Assetid By Version Mutabledata Status By Runid getOrganizationsByOrganizationidAssetsByGroupidByAssetidByVersionMutabledataStatusByRunid
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets asset publication status
Path Parameters
assetId *:
string
assetId of the asset
Related Operations:
groupId *:
string
groupId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
organizationId *:
string(uuid)
Id of the organization
runId *:
string
The run ID to identify the target resource.
Response
success
Examples
application/json
{
"status": "running",
"assetType": "rest-api",
"steps": [
{
"description": "Files processing",
"status": "completed",
"errors": []
},
{
"description": "Inferring type",
"status": "completed",
"errors": []
}
]
}
Get Organizations By Organizationid Assets By Groupid By Assetid By Version Publication Extendedstatus By Runid getOrganizationsByOrganizationidAssetsByGroupidByAssetidByVersionPublicationExtendedstatusByRunid
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets extended asset publication extended status by runId
Path Parameters
assetId *:
string
assetId of the asset
Related Operations:
groupId *:
string
groupId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
organizationId *:
string(uuid)
Id of the organization
runId *:
string
The run ID to identify the target resource.
Response
Successful operation.
Get Organizations By Organizationid Assets By Groupid By Assetid By Version Publication Status getOrganizationsByOrganizationidAssetsByGroupidByAssetidByVersionPublicationStatus
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets asset publication status
Path Parameters
organizationId *:
string(uuid)
Id of the organization
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Response
success
Examples
application/json
{
"status": "running",
"assetType": "rest-api",
"steps": [
{
"description": "Files processing",
"status": "completed",
"errors": []
},
{
"description": "Inferring type",
"status": "completed",
"errors": []
}
]
}
Get Organizations By Organizationid Assets By Groupid By Assetid By Version Publication Status By Runid getOrganizationsByOrganizationidAssetsByGroupidByAssetidByVersionPublicationStatusByRunid
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets asset publication status
Path Parameters
assetId *:
string
assetId of the asset
Related Operations:
groupId *:
string
groupId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
organizationId *:
string(uuid)
Id of the organization
runId *:
string
The run ID to identify the target resource.
Response
Successful operation.
Examples
application/json
{
"status": "running",
"assetType": "rest-api",
"steps": [
{
"description": "Files processing",
"status": "completed",
"errors": []
},
{
"description": "Inferring type",
"status": "completed",
"errors": []
}
]
}
Get Organizations By Organizationid Fields getOrganizationsByOrganizationidFields
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets field configurations available for the organization
Path Parameters
organizationId *:
string(uuid)
Id of the organization
Query Parameters
limit:
any
Amount of objects retrieved in the response
offset:
any
The offset specifies the offset of the first row to return
Response
success
items:
array
Array items
Examples
Categories
{
"value": [
{
"id": "99691563-b5ce-448c-b450-82db6aab7037",
"organizationId": "f0c9b011-980e-4928-9430-e60e3a97c042",
"displayName": "Remus Lupin",
"dataType": "enum",
"tagKey": "remun",
"acceptedValues": [
"dogo",
"dosmangos"
],
"assetTypeRestrictions": [
"connector"
],
"createdDate": "2018-03-05T17:50:05.318000+00:00",
"updatedDate": "2018-03-05T17:50:05.318000+00:00"
},
{
"id": "59ad31bd-a3f4-4c86-b2f2-a9e619e55ce7",
"organizationId": "f0c9b011-980e-4928-9430-e60e3a97c042",
"displayName": "Remu \u00d1eracion",
"dataType": "enum",
"tagKey": "remunis",
"acceptedValues": null,
"assetTypeRestrictions": [
"connector",
"rest-api"
],
"createdDate": "2018-03-12T13:53:32.197000+00:00",
"updatedDate": "2018-03-12T13:53:32.197000+00:00"
}
]
}
Create Organizations By Organizationid Fields createOrganizationsByOrganizationidFields
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Adds a field configuration to the organization.
- Body should be application/json. This is not specified in the raml as it conflicts with Osprey.
Path Parameters
organizationId *:
string(uuid)
Id of the organization
Response
success
displayName:
string
maxLength: 512
dataType:
string
tagKey:
string
The tag key, should be a kebab cased string
maxLength: 512, pattern:
^[a-z0-9]+(-[a-z0-9]+)*$assetTypeRestrictions:
array
acceptedValues:
array
Examples
FieldConfiguration
{
"value": {
"displayName": "Medical Discipline",
"tagKey": "medical-discipline",
"dataType": "text",
"assetTypeRestrictions": [
"connector",
"rest-api"
]
}
}
Patch Organizations By Organizationid Fields By Id patchOrganizationsByOrganizationidFieldsById
PATCH
Try it out
Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Updates a custom field configuration
Path Parameters
organizationId *:
string(uuid)
Id of the organization
id *:
string
The id to identify the target resource.
Header Parameters
X-Force-Update:
any
Enforce update operation (possibly affecting many resources) to avoid Conflict response (409)
Response
Custom field updated
Delete Organizations By Organizationid Fields By Id deleteOrganizationsByOrganizationidFieldsById
DELETE
Try it out
Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Deletes a custom field configuration
Path Parameters
organizationId *:
string(uuid)
Id of the organization
id *:
string
The id to identify the target resource.
Header Parameters
X-Force-Delete:
any
The X Force Delete header value.
Response
Custom field deleted
Get Organizations By Organizationid Categories getOrganizationsByOrganizationidCategories
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get categories configurations available for the organization
Path Parameters
organizationId *:
string(uuid)
Id of the organization
Query Parameters
limit:
any
Amount of objects retrieved in the response
offset:
any
The offset specifies the offset of the first row to return
Response
Organization's categories
items:
array
Array items
Examples
Categories
{
"value": [
{
"id": "99691563-b5ce-448c-b450-82db6aab7037",
"organizationId": "f0c9b011-980e-4928-9430-e60e3a97c042",
"displayName": "Remus Lupin",
"tagKey": "remun",
"acceptedValues": [
"dogo",
"dosmangos"
],
"assetTypeRestrictions": [
"connector"
],
"createdDate": "2018-03-05T17:50:05.318000+00:00",
"updatedDate": "2018-03-05T17:50:05.318000+00:00"
},
{
"id": "59ad31bd-a3f4-4c86-b2f2-a9e619e55ce7",
"organizationId": "f0c9b011-980e-4928-9430-e60e3a97c042",
"displayName": "Remu \u00d1eracion",
"tagKey": "remunis",
"acceptedValues": null,
"assetTypeRestrictions": [
"connector",
"rest-api"
],
"createdDate": "2018-03-12T13:53:32.197000+00:00",
"updatedDate": "2018-03-12T13:53:32.197000+00:00"
}
]
}
Create Organizations By Organizationid Categories createOrganizationsByOrganizationidCategories
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Add a category configuration to the organization
Path Parameters
organizationId *:
string(uuid)
Id of the organization
Request Body
jsonResponse
Category created
displayName:
string
maxLength: 512
tagKey:
string
The tag key, should be a kebab cased string
maxLength: 512, pattern:
^[a-z0-9]+(-[a-z0-9]+)*$assetTypeRestrictions:
array
acceptedValues:
array
Examples
Category
{
"value": {
"displayName": "Medical Discipline",
"tagKey": "medical-discipline",
"assetTypeRestrictions": [
"connector",
"rest-api"
]
}
}
Patch Organizations By Organizationid Categories By Id patchOrganizationsByOrganizationidCategoriesById
PATCH
Try it out
Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Updates a category configuration
- Body should be application/json. This is not specified in the raml as it conflicts with Osprey.
Path Parameters
organizationId *:
string(uuid)
Id of the organization
id *:
string
The id to identify the target resource.
Header Parameters
X-Force-Update:
any
Enforce update operation (possibly affecting many resources) to avoid Conflict response (409)
Response
Category updated or created
Delete Organizations By Organizationid Categories By Id deleteOrganizationsByOrganizationidCategoriesById
DELETE
Try it out
Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Deletes a category configuration
Path Parameters
organizationId *:
string(uuid)
Id of the organization
id *:
string
The id to identify the target resource.
Header Parameters
X-Force-Delete:
any
The X Force Delete header value.
Response
Category deleted
Get Organizations By Organizationid Queries getOrganizationsByOrganizationidQueries
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets a list of queries
Path Parameters
organizationId *:
string(uuid)
Id of the organization
Query Parameters
limit:
any
Amount of objects retrieved in the response
offset:
any
The offset specifies the offset of the first row to return
sort:
string
Property to sort by
ascending:
any
Order for sorting
Response
Gets a list of queries
items:
array
Array items
Examples
SearchQueries
{
"value": [
{
"name": "name",
"types": [
"connector",
"rest-api"
],
"search": "salesforce"
}
]
}
Create Organizations By Organizationid Queries createOrganizationsByOrganizationidQueries
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new query
Path Parameters
organizationId *:
string(uuid)
Id of the organization
Request Body *
jsonname *:
string
minLength: 1, maxLength: 64
types:
array
search:
string
minLength: 0, maxLength: 1024
updatedAt:
string
minLength: 0, maxLength: 1024
categories:
array
tags:
array
status:
array
sort:
string
minLength: 0, maxLength: 16
organizationIds:
array
Examples
CreateSearchQuery
{
"value": {
"name": "name",
"types": [
"connector",
"rest-api"
],
"search": "salesforce"
}
}
Response
Creates a new query
Examples
SearchQuery
{
"value": {
"name": "name",
"types": [
"connector",
"rest-api"
],
"search": "salesforce"
}
}
Get Organizations By Organizationid Softdeleted getOrganizationsByOrganizationidSoftdeleted
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Get organization's soft deleted assets
Path Parameters
organizationId *:
string(uuid)
Id of the organization
Query Parameters
limit:
any
Amount of objects retrieved in the response
offset:
any
The offset specifies the offset of the first row to return
Response
Soft Deleted assets
items:
array
Array items
Examples
SoftDeletedAssets
{
"value": [
{
"organizationId": "9efb6531-9fa2-4a45-ac42-bd157773ce95",
"groupId": "9efb6531-9fa2-4a45-ac42-bd157773aa00",
"assetId": "endpoints-review",
"version": "1.0.0"
}
]
}
Get Organizations By Organizationid Settings getOrganizationsByOrganizationidSettings
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets root organization level settings
Path Parameters
organizationId *:
string
UUID
pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$Query Parameters
settings *:
array
Settings to be retrieved
Response
Organization level settings retrieved
Examples
application/json
{
"externalValue": "examples/org-level-settings.yaml#/FetchOrgLevelSettings"
}
Patch Organizations By Organizationid Settings patchOrganizationsByOrganizationidSettings
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates root organization level settings
Path Parameters
organizationId *:
string
UUID
pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$Request Body *
jsondeletionSettings:
object
Examples
application/json
{
"externalValue": "examples/org-level-settings.yaml#/UpdateOrgLevelSettings"
}
Response
assetCountLimit updated
Patch Organizations By Organizationid Queries By Queryid patchOrganizationsByOrganizationidQueriesByQueryid
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Edits a saved search query
Path Parameters
organizationId *:
string(uuid)
Id of the organization
queryId *:
string
The query ID to identify the target resource.
Request Body
jsonname:
string
minLength: 1, maxLength: 64
types:
array
search:
string
minLength: 0, maxLength: 1024
updatedAt:
string
minLength: 0, maxLength: 1024
categories:
array
fields:
array
tags:
array
status:
array
sort:
string
minLength: 0, maxLength: 16
organizationIds:
array
Examples
SearchQuery
{
"value": {
"name": "name",
"types": [
"connector",
"rest-api"
],
"search": "salesforce"
}
}
Response
Search query updated
name:
string
types:
array
search:
string
updatedAt:
string
categories:
array
tags:
array
status:
array
sort:
string
organizationIds:
array
Examples
SearchQuery
{
"value": {
"name": "name",
"types": [
"connector",
"rest-api"
],
"search": "salesforce"
}
}
Delete Organizations By Organizationid Queries By Queryid deleteOrganizationsByOrganizationidQueriesByQueryid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes the query
Path Parameters
organizationId *:
string(uuid)
Id of the organization
queryId *:
string
The query ID to identify the target resource.
Response
Saved search query deleted
Get Portals By Organizationdomain getPortalsByOrganizationdomain
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets the customization portal
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
Response
Gets customization
Examples
Customization
{
"value": {
"customization": {
"home": {
"heroImage": "",
"welcomeTitle": "Welcome to the Portal",
"welcomeText": "content",
"textColor": "#000000"
}
},
"pages": [
{
"path": "home.md",
"name": "Home page"
},
{
"path": "/examples/example.md",
"name": "Example Page"
}
]
}
}
Patch Portals By Organizationdomain patchPortalsByOrganizationdomain
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Publishes draft portal customization.
This endpoint should be executed without specifying any body.
This endpoint should be executed without specifying any body.
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
Response
Portal updated
Get Portals By Organizationdomain Metadata getPortalsByOrganizationdomainMetadata
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets organization domain metadata from authentication service
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
Response
Gets organization metadata
Examples
application/json
{
"isFederated": false,
"name": "Mulesoft Inc"
}
Get Portals By Organizationdomain Resources getPortalsByOrganizationdomainResources
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets portals resources
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
Response
Retrieved list of resources
Examples
application/json
[
{
"path": "resources/file-a0a5db36-940e-447b-9100-05b166b2c084.jpg"
}
]
Get Portals By Organizationdomain Resources By Resourceid getPortalsByOrganizationdomainResourcesByResourceid
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets portals resource
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
resourceId *:
string
The resource ID to identify the target resource.
Response
Retrieved file as a binary content
Get Portals By Organizationdomain Assets Search getPortalsByOrganizationdomainAssetsSearch
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets a paginated set of assets
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
Query Parameters
limit:
any
Amount of objects retrieved in the response
offset:
any
The offset specifies the offset of the first row to return
sort:
string
Property to sort by
ascending:
any
Order for sorting
Response
Successful operation.
items:
array
Array items
Examples
SearchResult
{
"value": [
{
"organizationId": "9efb6531-9fa2-4a45-ac42-bd157773ce95",
"groupId": "9efb6531-9fa2-4a45-ac42-bd157773aa00",
"assetId": "endpoints-review",
"version": "1.0.0",
"minorVersion": "1.0",
"description": "description of the asset",
"versionGroup": "1.0.0",
"isPublic": false,
"name": "Endpoints Review",
"type": "custom",
"status": "published",
"createdById": "102d0953-9cca-475e-1919-768cd7aa7695",
"createdAt": "2020-09-07T17:48:33.995Z"
}
]
}
Get Portals By Organizationdomain Assets By Groupid By Assetid getPortalsByOrganizationdomainAssetsByGroupidByAssetid
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Retrieves a assets.
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
Query Parameters
status:
array
Filter versions that matches the status indicated. Should be one of deprecated, development or published
strict:
any
Asset related versions populated into
otherVersions property will also have the filters for this query applied, e.g.: if status filter is applied, then related versions will have the status filter also applied, otherwise all possible status will be returned. Defaults to trueResponse
success
Get Portals By Organizationdomain Assets By Groupid By Assetid Asset getPortalsByOrganizationdomainAssetsByGroupidByAssetidAsset
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets an asset
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
Response
Gets a simple asset
Examples
AssetWithFiles
{
"value": {
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "2.0.0",
"minorVersion": "2.0",
"description": "My asset description",
"versionGroup": "v2",
"isPublic": false,
"name": "Asset with files",
"type": "rest-api",
"isSnapshot": false,
"status": "published",
"externalFile": {
"url": null
},
"createdDate": "2020-09-08T16:44:04.238000+00:00",
"updatedDate": "2020-09-08T16:44:04.217000+00:00",
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"labels": [
"asset-tag",
"another-tag"
],
"categories": [
{
"value": [
"value"
],
"displayName": "Category",
"key": "Category"
}
],
"customFields": [],
"mule3ConnectorMetadata": {
"fullVersion": null,
"featureId": null
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "d2dd14a6cbbb15869105d9755d2f8345",
"sha1": "d2dd14a6cbbb15869105d9755d2f8345",
"createdDate": "2020-09-08T16:44:03.861000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "d2dd14a6cbbb15869105d9755d2f8345",
"sha1": "d2dd14a6cbbb15869105d9755d2f8345",
"createdDate": "2020-09-08T16:44:03.887000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "d2dd14a6cbbb15869105d9755d2f8345",
"sha1": "d2dd14a6cbbb15869105d9755d2f8345",
"createdDate": "2020-09-08T16:44:04.117000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"rating": 5,
"numberOfRates": 1,
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"instances": [
{
"versionGroup": "v2",
"organizationId": "org.mule.modules",
"id": "mocking-service",
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "2.0.0",
"minorVersion": "2.0",
"productAPIVersion": "v2",
"environmentId": null,
"providerId": null,
"endpointUri": "https://anypoint.mulesoft.com/mocking/api/v1/sources/exchange/assets/org.mule.modules/asset-with-files/2.0.0/m",
"name": "Mocking Service",
"isPublic": true,
"type": "mocked",
"fullname": "Mocking Service",
"deprecated": false
}
],
"dependencies": [],
"generated": [
{
"roupId": "org.mule.modules",
"assetId": "mule-plugin-asset-with-files",
"version": "2.0.0",
"versionGroup": "2.0.0",
"name": "Asset with files",
"type": "extension",
"minMuleVersion": "4.1.1",
"files": [
{
"classifier": "icon",
"packaging": "svg",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/icon/svg",
"externalLink": "https://localhost/org.mule.modules/Dmule-plugin-asset-with-files-2.0.0-icon.svg",
"md5": "4e66d7d9944fae99cd10d802a9c02207",
"sha1": "00b2b3da2a1a886eeefc4d5fa5d8f049cef4e7e8",
"createdDate": "2020-09-08T16:37:12.435000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": "mule-plugin",
"packaging": "jar",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/mule-plugin/jar",
"externalLink": "https://localhost/org.mule.modules/mule-plugin-asset-with-files-2.0.0-mule-plugin.jar",
"md5": "a94d53d0a5522a83bcc7b8c6c7118ae0",
"sha1": "be58dd541aa71c947de488c174c44b016f13698c",
"createdDate": "2020-09-08T16:44:05.420000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": null,
"packaging": "pom",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/pom",
"externalLink": "https://localhost/org.mule.modules/mule-plugin-asset-with-files-2.0.0.pom",
"md5": "45ae05e606e34293314a4a189f9bbb92",
"sha1": "1d50e4a549975cb712ec56d9e7516a9a6849f025",
"createdDate": "2020-09-08T16:44:05.745000+00:00",
"mainFile": null,
"isGenerated": false
}
]
},
{
"groupId": "org.mule.modules",
"assetId": "mule-module-asset-with-files",
"version": "2.0.0",
"versionGroup": "2.0.0",
"name": "instagram Connector",
"type": "connector",
"minMuleVersion": "3.6.0",
"files": [
{
"classifier": null,
"packaging": "jar",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/jar",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0.jar",
"md5": "26ab438e482e032bb0187b5208ebc733",
"sha1": "72b1f94bafc6d71d92767315edbd3d4899498cb0",
"createdDate": "2020-09-08T16:44:19.813000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": null,
"packaging": "pom",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/pom",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0.pom",
"md5": "c92f82a5690cf7e129127ce77e10c4b0",
"sha1": "2b47d576700d141749d36f7fa4f9aae3f4bd94bf",
"createdDate": "2020-09-08T16:44:20.250000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": "studio-plugin",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/studio-plugin/zip",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0-studio-plugin.zip",
"md5": "abafce8dd4817861aea26c1d4ae37e8f",
"sha1": "cdba899a66202fed3683736ec91beb195e17faba",
"createdDate": "2020-09-08T16:44:21.680000+00:00",
"mainFile": null,
"isGenerated": false
}
]
}
],
"otherVersions": [
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "1.0.1",
"minorVersion": "1.0",
"versionGroup": "v1",
"isPublic": false,
"type": "rest-api",
"status": "published",
"createdDate": "2020-09-08T16:55:28.130000+00:00",
"updatedDate": "2020-09-08T16:55:28.115000+00:00",
"isSnapshot": false,
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"externalFile": {
"url": null
},
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "347f9598e3fed6e428e58380186ea294",
"sha1": "c4e5f88e56e66ba61d25ccb9fa0a81688bc7ec8f",
"createdDate": "2020-09-08T16:55:26.660000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "347f9598e3fed6e428e58380186ea294",
"sha1": "c4e5f88e56e66ba61d25ccb9fa0a81688bc7ec8f",
"createdDate": "2020-09-08T16:55:26.681000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "d4af802fbf1a35e0feb85ebc775582b9",
"sha1": "eb72390d770fe89d711ce295fb2973aa97ba0889",
"createdDate": "2020-09-08T16:55:27.956000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"dependencies": []
},
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "1.0.0",
"minorVersion": "1.0",
"versionGroup": "v1",
"isPublic": false,
"type": "rest-api",
"status": "published",
"createdDate": "2020-09-08T16:37:11.194000+00:00",
"updatedDate": "2020-09-08T16:44:04.217000+00:00",
"isSnapshot": false,
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"externalFile": {
"url": null
},
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "ec57fff8e8abd7169f20b9c0f3a65c03",
"sha1": "3f75b6252ba42a502bcd41771f9d847b09ea126e",
"createdDate": "2020-09-08T16:37:10.781000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "ec57fff8e8abd7169f20b9c0f3a65c03",
"sha1": "3f75b6252ba42a502bcd41771f9d847b09ea126e",
"createdDate": "2020-09-08T16:37:10.824000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "e6658956af113a1ce7771f649f1e1370",
"sha1": "73897231991441f0d0e0d9c15e2b30ebcb29d09d",
"createdDate": "2020-09-08T16:37:11.001000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"dependencies": []
}
],
"id": "org.mule.modules/asset-with-files/2.0.0",
"icon": "http://www.icon.com.ar",
"createdAt": "2020-09-08T16:44:04.238000+00:00",
"modifiedAt": "2020-09-08T16:44:04.217000+00:00",
"organization": {
"id": "org.mule.modules",
"name": "Mulesoft",
"parentOrganizationIds": [],
"subOrganizationIds": [],
"tenantOrganizationIds": [],
"isMaster": true,
"domain": "mulesoft-0000",
"isMulesoftOrganization": false
},
"permissions": [
"admin",
"edit"
],
"versions": [
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "2.0.0",
"minorVersion": "2.0",
"description": "",
"versionGroup": "v2",
"isPublic": false,
"name": "Asset with files",
"type": "rest-api",
"isSnapshot": false,
"status": "published",
"externalFile": {
"url": null
},
"createdDate": "2020-09-08T16:44:04.238000+00:00",
"updatedDate": "2020-09-08T16:44:04.217000+00:00",
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"labels": [
"asset-tag",
"another-tag"
],
"categories": [
{
"value": [
"value"
],
"displayName": "Category",
"key": "Category"
}
],
"customFields": [],
"mule3ConnectorMetadata": {
"fullVersion": null,
"featureId": null
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "b2fb0ee5430cf3947432ebdee9383c38",
"sha1": "c57be838629921bcdf7c0de4f56798205d0178c4",
"createdDate": "2020-09-08T16:44:03.861000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "b2fb0ee5430cf3947432ebdee9383c38",
"sha1": "c57be838629921bcdf7c0de4f56798205d0178c4",
"createdDate": "2020-09-08T16:44:03.887000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "d5e9236adfea9ef8b54c053795bf768b",
"sha1": "08bdcca2179479d385a772dfe0654253a3e2ac80",
"createdDate": "2020-09-08T16:44:04.117000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"rating": 5,
"numberOfRates": 1,
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"instances": [
{
"versionGroup": "v2",
"organizationId": "org.mule.modules",
"id": "mocking-service",
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "2.0.0",
"minorVersion": "2.0",
"productAPIVersion": "v2",
"environmentId": null,
"providerId": null,
"endpointUri": "https://anypoint.mulesoft.com/mocking/api/v1/sources/exchange/assets/org.mule.modules/asset-with-files/2.0.0/m",
"name": "Mocking Service",
"isPublic": true,
"type": "mocked",
"fullname": "Mocking Service",
"deprecated": false
}
],
"dependencies": [],
"generated": [
{
"groupId": "org.mule.modules",
"assetId": "mule-plugin-asset-with-files",
"version": "2.0.0",
"versionGroup": "2.0.0",
"name": "Asset with files",
"type": "extension",
"minMuleVersion": "4.1.1",
"files": [
{
"classifier": "icon",
"packaging": "svg",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/icon/svg",
"externalLink": "https://localhost/org.mule.modules/Dmule-plugin-asset-with-files-2.0.0-icon.svg",
"md5": "4e66d7d9944fae99cd10d802a9c02207",
"sha1": "00b2b3da2a1a886eeefc4d5fa5d8f049cef4e7e8",
"createdDate": "2020-09-08T16:37:12.435000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": "mule-plugin",
"packaging": "jar",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/mule-plugin/jar",
"externalLink": "https://localhost/org.mule.modules/mule-plugin-asset-with-files-2.0.0-mule-plugin.jar",
"md5": "a94d53d0a5522a83bcc7b8c6c7118ae0",
"sha1": "be58dd541aa71c947de488c174c44b016f13698c",
"createdDate": "2020-09-08T16:44:05.420000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": null,
"packaging": "pom",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/pom",
"externalLink": "https://localhost/org.mule.modules/mule-plugin-asset-with-files-2.0.0.pom",
"md5": "45ae05e606e34293314a4a189f9bbb92",
"sha1": "1d50e4a549975cb712ec56d9e7516a9a6849f025",
"createdDate": "2020-09-08T16:44:05.745000+00:00",
"mainFile": null,
"isGenerated": false
}
]
},
{
"groupId": "org.mule.modules",
"assetId": "mule-module-asset-with-files",
"version": "2.0.0",
"versionGroup": "2.0.0",
"name": "instagram Connector",
"type": "connector",
"minMuleVersion": "3.6.0",
"files": [
{
"classifier": null,
"packaging": "jar",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/jar",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0.jar",
"md5": "26ab438e482e032bb0187b5208ebc733",
"sha1": "72b1f94bafc6d71d92767315edbd3d4899498cb0",
"createdDate": "2020-09-08T16:44:19.813000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": null,
"packaging": "pom",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/pom",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0.pom",
"md5": "c92f82a5690cf7e129127ce77e10c4b0",
"sha1": "2b47d576700d141749d36f7fa4f9aae3f4bd94bf",
"createdDate": "2020-09-08T16:44:20.250000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": "studio-plugin",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/studio-plugin/zip",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0-studio-plugin.zip",
"md5": "abafce8dd4817861aea26c1d4ae37e8f",
"sha1": "cdba899a66202fed3683736ec91beb195e17faba",
"createdDate": "2020-09-08T16:44:21.680000+00:00",
"mainFile": null,
"isGenerated": false
}
]
}
],
"otherVersions": [
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "1.0.1",
"minorVersion": "1.0",
"versionGroup": "v1",
"isPublic": false,
"type": "rest-api",
"status": "published",
"createdDate": "2020-09-08T16:55:28.130000+00:00",
"updatedDate": "2020-09-08T16:55:28.115000+00:00",
"isSnapshot": false,
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"externalFile": {
"url": null
},
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "347f9598e3fed6e428e58380186ea294",
"sha1": "c4e5f88e56e66ba61d25ccb9fa0a81688bc7ec8f",
"createdDate": "2020-09-08T16:55:26.660000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "347f9598e3fed6e428e58380186ea294",
"sha1": "c4e5f88e56e66ba61d25ccb9fa0a81688bc7ec8f",
"createdDate": "2020-09-08T16:55:26.681000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "d4af802fbf1a35e0feb85ebc775582b9",
"sha1": "eb72390d770fe89d711ce295fb2973aa97ba0889",
"createdDate": "2020-09-08T16:55:27.956000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"dependencies": []
},
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "1.0.0",
"minorVersion": "1.0",
"versionGroup": "v1",
"isPublic": false,
"type": "rest-api",
"status": "published",
"createdDate": "2020-09-08T16:37:11.194000+00:00",
"updatedDate": "2020-09-08T16:44:04.217000+00:00",
"isSnapshot": false,
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"externalFile": {
"url": null
},
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "ec57fff8e8abd7169f20b9c0f3a65c03",
"sha1": "3f75b6252ba42a502bcd41771f9d847b09ea126e",
"createdDate": "2020-09-08T16:37:10.781000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "ec57fff8e8abd7169f20b9c0f3a65c03",
"sha1": "3f75b6252ba42a502bcd41771f9d847b09ea126e",
"createdDate": "2020-09-08T16:37:10.824000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "e6658956af113a1ce7771f649f1e1370",
"sha1": "73897231991441f0d0e0d9c15e2b30ebcb29d09d",
"createdDate": "2020-09-08T16:37:11.001000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"dependencies": []
}
],
"id": "org.mule.modules/asset-with-files/2.0.0",
"icon": "http://www.icon.com.ar",
"createdAt": "2020-09-08T16:44:04.238000+00:00",
"modifiedAt": "2020-09-08T16:44:04.217000+00:00",
"organization": {
"id": "org.mule.modules",
"name": "Mulesoft",
"parentOrganizationIds": [],
"subOrganizationIds": [],
"tenantOrganizationIds": [],
"isMaster": true,
"domain": "mulesoft-0000",
"isMulesoftOrganization": false
},
"permissions": [
"admin",
"edit"
]
}
]
}
}
Get Portals By Organizationdomain Assets By Groupid By Assetid Versiongroups By Versiongroup Apigroupinstances getPortalsByOrganizationdomainAssetsByGroupidByAssetidVersiongroupsByVersiongroupApigroupinstances
GET
Try it out
Path Parameters
Query Parameters
Custom Query Parameters
Custom Headers
Gets API Group Instance
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
versionGroup *:
string
Version group of the asset
Query Parameters
limit:
any
Amount of objects retrieved in the response
offset:
any
The offset specifies the offset of the first row to return
sort:
string
Property to sort by
ascending:
any
Order for sorting
Response
Successful operation.
Examples
APIGroupInstances
{
"value": [
{
"organizationId": "26c17b05-c2da-4ad6-b1d1-34bde9e74e6e",
"groupId": "group-id",
"assetId": "some-asset-id",
"versionGroup": "v2",
"major": 2,
"isPublic": true
},
{
"organizationId": "26c17b05-c2da-4ad6-b1d1-34bde9e74e6e",
"groupId": "group-id",
"assetId": "some-asset-id",
"versionGroup": "v1",
"major": 1,
"isPublic": true
}
]
}
Get Portals By Organizationdomain Assets By Groupid By Assetid Versiongroups By Versiongroup Environments By Environmentid Apigroupinstances By Apigroupinstanceid Tiers getPortalsByOrganizationdomainAssetsByGroupidByAssetidVersiongroupsByVersiongroupEnvironmentsByEnvironmentidApigroupinstancesByApigroupinstanceidTiers
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets a list of tiers
Path Parameters
versionGroup *:
string
Version group of the asset
assetId *:
string
assetId of the asset
Related Operations:
groupId *:
string
groupId of the asset
Related Operations:
organizationDomain *:
string
Domain of the root organization
maxLength: 255
apiGroupInstanceId *:
any
The apiGroupInstance ID to identify the target resource.
environmentId *:
string
The environment ID to identify the target resource.
minLength: 36, maxLength: 36
Related Operations:
Response
Successful operation.
Examples
CompleteTiers
{
"value": [
{
"audit": {
"created": {
"date": "2017-08-04T15:11:13.070000+00:00"
},
"updated": {}
},
"masterOrganizationId": "40fbc081-bb0d-4aff-9fb7-f3a48fdeb958",
"organizationId": "643c5d65-93ab-404d-9c13-efab34cf2a60",
"id": 23,
"apiGroupVersionId": 34,
"name": "Free",
"description": "This is some description text",
"limitsByApi": [
{
"apiId": 2,
"organizationId": "643c5d65-93ab-404d-9c13-efab34cf2a60",
"groupId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a",
"assetId": "facebook-api",
"assetVersion": "1.0.0",
"limits": [
{
"visible": true,
"maximumRequests": 2,
"timePeriodInMilliseconds": 1000
}
]
},
{
"apiId": 3,
"organizationId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a",
"groupId": "ba3dd49c-9bd3-43a3-bb54-226715e9c57a",
"assetId": "instagram-api",
"assetVersion": "1.0.1",
"limits": [
{
"visible": true,
"maximumRequests": 2,
"timePeriodInMilliseconds": 1000
}
]
}
],
"status": "ACTIVE",
"autoApprove": false,
"applicationCount": 0
}
]
}
Get Portals By Organizationdomain Assets By Groupid By Assetid Versiongroups By Versiongroup Terms getPortalsByOrganizationdomainAssetsByGroupidByAssetidVersiongroupsByVersiongroupTerms
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets Terms and Conditions associated to the API
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
versionGroup *:
string
Version group of the asset
Response
Successful operation.
Examples
Terms
{
"value": [
{
"groupId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"assetId": "inimputability",
"assetVersion": "1.0.0",
"versionGroup": "v1",
"id": 7183,
"underlyingTerms": [
{
"groupId": "be1e07e2-a230-424b-93c4-a95829767d5d",
"assetId": "american-flights",
"minorVersion": "2.0",
"version": "2.0.2",
"name": "American Flights",
"termsText": "<h2>Dwelling and speedily ignorant any steepest</h2>\n<p>His followed carriage proposal entrance directly had elegance.</p>\n"
},
{
"groupId": "be1e07e2-a230-424b-93c4-a95829767d5d",
"assetId": "delta-flights",
"minorVersion": "1.0",
"version": "1.0.0",
"name": "Delta Flights",
"termsText": "<h2>Dwelling and speedily ignorant any steepest</h2>\n<p>His followed carriage proposal entrance directly had elegance.</p>\n"
}
]
},
{
"groupId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"assetId": "inimputability",
"assetVersion": "1.0.0",
"versionGroup": "v1",
"id": 7184,
"underlyingTerms": [
{
"groupId": "be1e07e2-a230-424b-93c4-a95829767d5d",
"assetId": "delta-flights",
"minorVersion": "1.1",
"version": "1.1.1",
"name": "Delta Flights",
"termsText": "<h2>Dwelling and speedily ignorant any steepest</h2>\n<p>His followed carriage proposal entrance directly had elegance.</p>\n"
}
]
}
]
}
Get Portals By Organizationdomain Assets By Groupid By Assetid By Version Asset getPortalsByOrganizationdomainAssetsByGroupidByAssetidByVersionAsset
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets an asset
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
groupId *:
string
groupId of the asset
Related Operations:
assetId *:
string
assetId of the asset
Related Operations:
version *:
string
version of the asset
pattern:
^v{0,1}(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Related Operations:
Response
Successful operation.
Examples
Asset
{
"value": {
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "2.0.0",
"minorVersion": "2.0",
"description": "My asset description",
"versionGroup": "v2",
"isPublic": false,
"name": "Asset with files",
"type": "rest-api",
"isSnapshot": false,
"status": "published",
"externalFile": {
"url": null
},
"createdDate": "2020-09-08T16:44:04.238000+00:00",
"updatedDate": "2020-09-08T16:44:04.217000+00:00",
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"labels": [
"asset-tag",
"another-tag"
],
"categories": [
{
"value": [
"value"
],
"displayName": "Category",
"key": "Category"
}
],
"customFields": [],
"mule3ConnectorMetadata": {
"fullVersion": null,
"featureId": null
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "d2dd14a6cbbb15869105d9755d2f8345",
"sha1": "d2dd14a6cbbb15869105d9755d2f8345",
"createdDate": "2020-09-08T16:44:03.861000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "d2dd14a6cbbb15869105d9755d2f8345",
"sha1": "d2dd14a6cbbb15869105d9755d2f8345",
"createdDate": "2020-09-08T16:44:03.887000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "d2dd14a6cbbb15869105d9755d2f8345",
"sha1": "d2dd14a6cbbb15869105d9755d2f8345",
"createdDate": "2020-09-08T16:44:04.117000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"rating": 5,
"numberOfRates": 1,
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"instances": [
{
"versionGroup": "v2",
"organizationId": "org.mule.modules",
"id": "mocking-service",
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "2.0.0",
"minorVersion": "2.0",
"productAPIVersion": "v2",
"environmentId": null,
"providerId": null,
"endpointUri": "https://anypoint.mulesoft.com/mocking/api/v1/sources/exchange/assets/org.mule.modules/asset-with-files/2.0.0/m",
"name": "Mocking Service",
"isPublic": true,
"type": "mocked",
"fullname": "Mocking Service",
"deprecated": false
}
],
"dependencies": [],
"generated": [
{
"roupId": "org.mule.modules",
"assetId": "mule-plugin-asset-with-files",
"version": "2.0.0",
"versionGroup": "2.0.0",
"name": "Asset with files",
"type": "extension",
"minMuleVersion": "4.1.1",
"files": [
{
"classifier": "icon",
"packaging": "svg",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/icon/svg",
"externalLink": "https://localhost/org.mule.modules/Dmule-plugin-asset-with-files-2.0.0-icon.svg",
"md5": "4e66d7d9944fae99cd10d802a9c02207",
"sha1": "00b2b3da2a1a886eeefc4d5fa5d8f049cef4e7e8",
"createdDate": "2020-09-08T16:37:12.435000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": "mule-plugin",
"packaging": "jar",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/mule-plugin/jar",
"externalLink": "https://localhost/org.mule.modules/mule-plugin-asset-with-files-2.0.0-mule-plugin.jar",
"md5": "a94d53d0a5522a83bcc7b8c6c7118ae0",
"sha1": "be58dd541aa71c947de488c174c44b016f13698c",
"createdDate": "2020-09-08T16:44:05.420000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": null,
"packaging": "pom",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/pom",
"externalLink": "https://localhost/org.mule.modules/mule-plugin-asset-with-files-2.0.0.pom",
"md5": "45ae05e606e34293314a4a189f9bbb92",
"sha1": "1d50e4a549975cb712ec56d9e7516a9a6849f025",
"createdDate": "2020-09-08T16:44:05.745000+00:00",
"mainFile": null,
"isGenerated": false
}
]
},
{
"groupId": "org.mule.modules",
"assetId": "mule-module-asset-with-files",
"version": "2.0.0",
"versionGroup": "2.0.0",
"name": "instagram Connector",
"type": "connector",
"minMuleVersion": "3.6.0",
"files": [
{
"classifier": null,
"packaging": "jar",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/jar",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0.jar",
"md5": "26ab438e482e032bb0187b5208ebc733",
"sha1": "72b1f94bafc6d71d92767315edbd3d4899498cb0",
"createdDate": "2020-09-08T16:44:19.813000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": null,
"packaging": "pom",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/pom",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0.pom",
"md5": "c92f82a5690cf7e129127ce77e10c4b0",
"sha1": "2b47d576700d141749d36f7fa4f9aae3f4bd94bf",
"createdDate": "2020-09-08T16:44:20.250000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": "studio-plugin",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/studio-plugin/zip",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0-studio-plugin.zip",
"md5": "abafce8dd4817861aea26c1d4ae37e8f",
"sha1": "cdba899a66202fed3683736ec91beb195e17faba",
"createdDate": "2020-09-08T16:44:21.680000+00:00",
"mainFile": null,
"isGenerated": false
}
]
}
],
"otherVersions": [
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "1.0.1",
"minorVersion": "1.0",
"versionGroup": "v1",
"isPublic": false,
"type": "rest-api",
"status": "published",
"createdDate": "2020-09-08T16:55:28.130000+00:00",
"updatedDate": "2020-09-08T16:55:28.115000+00:00",
"isSnapshot": false,
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"externalFile": {
"url": null
},
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "347f9598e3fed6e428e58380186ea294",
"sha1": "c4e5f88e56e66ba61d25ccb9fa0a81688bc7ec8f",
"createdDate": "2020-09-08T16:55:26.660000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "347f9598e3fed6e428e58380186ea294",
"sha1": "c4e5f88e56e66ba61d25ccb9fa0a81688bc7ec8f",
"createdDate": "2020-09-08T16:55:26.681000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "d4af802fbf1a35e0feb85ebc775582b9",
"sha1": "eb72390d770fe89d711ce295fb2973aa97ba0889",
"createdDate": "2020-09-08T16:55:27.956000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"dependencies": []
},
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "1.0.0",
"minorVersion": "1.0",
"versionGroup": "v1",
"isPublic": false,
"type": "rest-api",
"status": "published",
"createdDate": "2020-09-08T16:37:11.194000+00:00",
"updatedDate": "2020-09-08T16:44:04.217000+00:00",
"isSnapshot": false,
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"externalFile": {
"url": null
},
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "ec57fff8e8abd7169f20b9c0f3a65c03",
"sha1": "3f75b6252ba42a502bcd41771f9d847b09ea126e",
"createdDate": "2020-09-08T16:37:10.781000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "ec57fff8e8abd7169f20b9c0f3a65c03",
"sha1": "3f75b6252ba42a502bcd41771f9d847b09ea126e",
"createdDate": "2020-09-08T16:37:10.824000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "e6658956af113a1ce7771f649f1e1370",
"sha1": "73897231991441f0d0e0d9c15e2b30ebcb29d09d",
"createdDate": "2020-09-08T16:37:11.001000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"dependencies": []
}
],
"id": "org.mule.modules/asset-with-files/2.0.0",
"icon": "http://www.icon.com.ar",
"createdAt": "2020-09-08T16:44:04.238000+00:00",
"modifiedAt": "2020-09-08T16:44:04.217000+00:00",
"organization": {
"id": "org.mule.modules",
"name": "Mulesoft",
"parentOrganizationIds": [],
"subOrganizationIds": [],
"tenantOrganizationIds": [],
"isMaster": true,
"domain": "mulesoft-0000",
"isMulesoftOrganization": false
},
"permissions": [
"admin",
"edit"
],
"versions": [
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "2.0.0",
"minorVersion": "2.0",
"description": "",
"versionGroup": "v2",
"isPublic": false,
"name": "Asset with files",
"type": "rest-api",
"isSnapshot": false,
"status": "published",
"externalFile": {
"url": null
},
"createdDate": "2020-09-08T16:44:04.238000+00:00",
"updatedDate": "2020-09-08T16:44:04.217000+00:00",
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"labels": [
"asset-tag",
"another-tag"
],
"categories": [
{
"value": [
"value"
],
"displayName": "Category",
"key": "Category"
}
],
"customFields": [],
"mule3ConnectorMetadata": {
"fullVersion": null,
"featureId": null
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "b2fb0ee5430cf3947432ebdee9383c38",
"sha1": "c57be838629921bcdf7c0de4f56798205d0178c4",
"createdDate": "2020-09-08T16:44:03.861000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "b2fb0ee5430cf3947432ebdee9383c38",
"sha1": "c57be838629921bcdf7c0de4f56798205d0178c4",
"createdDate": "2020-09-08T16:44:03.887000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/2.0.0/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "d5e9236adfea9ef8b54c053795bf768b",
"sha1": "08bdcca2179479d385a772dfe0654253a3e2ac80",
"createdDate": "2020-09-08T16:44:04.117000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"rating": 5,
"numberOfRates": 1,
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"instances": [
{
"versionGroup": "v2",
"organizationId": "org.mule.modules",
"id": "mocking-service",
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "2.0.0",
"minorVersion": "2.0",
"productAPIVersion": "v2",
"environmentId": null,
"providerId": null,
"endpointUri": "https://anypoint.mulesoft.com/mocking/api/v1/sources/exchange/assets/org.mule.modules/asset-with-files/2.0.0/m",
"name": "Mocking Service",
"isPublic": true,
"type": "mocked",
"fullname": "Mocking Service",
"deprecated": false
}
],
"dependencies": [],
"generated": [
{
"groupId": "org.mule.modules",
"assetId": "mule-plugin-asset-with-files",
"version": "2.0.0",
"versionGroup": "2.0.0",
"name": "Asset with files",
"type": "extension",
"minMuleVersion": "4.1.1",
"files": [
{
"classifier": "icon",
"packaging": "svg",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/icon/svg",
"externalLink": "https://localhost/org.mule.modules/Dmule-plugin-asset-with-files-2.0.0-icon.svg",
"md5": "4e66d7d9944fae99cd10d802a9c02207",
"sha1": "00b2b3da2a1a886eeefc4d5fa5d8f049cef4e7e8",
"createdDate": "2020-09-08T16:37:12.435000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": "mule-plugin",
"packaging": "jar",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/mule-plugin/jar",
"externalLink": "https://localhost/org.mule.modules/mule-plugin-asset-with-files-2.0.0-mule-plugin.jar",
"md5": "a94d53d0a5522a83bcc7b8c6c7118ae0",
"sha1": "be58dd541aa71c947de488c174c44b016f13698c",
"createdDate": "2020-09-08T16:44:05.420000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": null,
"packaging": "pom",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-plugin-asset-with-files/2.0.0/pom",
"externalLink": "https://localhost/org.mule.modules/mule-plugin-asset-with-files-2.0.0.pom",
"md5": "45ae05e606e34293314a4a189f9bbb92",
"sha1": "1d50e4a549975cb712ec56d9e7516a9a6849f025",
"createdDate": "2020-09-08T16:44:05.745000+00:00",
"mainFile": null,
"isGenerated": false
}
]
},
{
"groupId": "org.mule.modules",
"assetId": "mule-module-asset-with-files",
"version": "2.0.0",
"versionGroup": "2.0.0",
"name": "instagram Connector",
"type": "connector",
"minMuleVersion": "3.6.0",
"files": [
{
"classifier": null,
"packaging": "jar",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/jar",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0.jar",
"md5": "26ab438e482e032bb0187b5208ebc733",
"sha1": "72b1f94bafc6d71d92767315edbd3d4899498cb0",
"createdDate": "2020-09-08T16:44:19.813000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": null,
"packaging": "pom",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/pom",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0.pom",
"md5": "c92f82a5690cf7e129127ce77e10c4b0",
"sha1": "2b47d576700d141749d36f7fa4f9aae3f4bd94bf",
"createdDate": "2020-09-08T16:44:20.250000+00:00",
"mainFile": null,
"isGenerated": false
},
{
"classifier": "studio-plugin",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/mule-module-asset-with-files/2.0.0/studio-plugin/zip",
"externalLink": "https://localhost/org.mule.modules/mule-module-asset-with-files-2.0.0-studio-plugin.zip",
"md5": "abafce8dd4817861aea26c1d4ae37e8f",
"sha1": "cdba899a66202fed3683736ec91beb195e17faba",
"createdDate": "2020-09-08T16:44:21.680000+00:00",
"mainFile": null,
"isGenerated": false
}
]
}
],
"otherVersions": [
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "1.0.1",
"minorVersion": "1.0",
"versionGroup": "v1",
"isPublic": false,
"type": "rest-api",
"status": "published",
"createdDate": "2020-09-08T16:55:28.130000+00:00",
"updatedDate": "2020-09-08T16:55:28.115000+00:00",
"isSnapshot": false,
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"externalFile": {
"url": null
},
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "347f9598e3fed6e428e58380186ea294",
"sha1": "c4e5f88e56e66ba61d25ccb9fa0a81688bc7ec8f",
"createdDate": "2020-09-08T16:55:26.660000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "347f9598e3fed6e428e58380186ea294",
"sha1": "c4e5f88e56e66ba61d25ccb9fa0a81688bc7ec8f",
"createdDate": "2020-09-08T16:55:26.681000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.1/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "d4af802fbf1a35e0feb85ebc775582b9",
"sha1": "eb72390d770fe89d711ce295fb2973aa97ba0889",
"createdDate": "2020-09-08T16:55:27.956000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"dependencies": []
},
{
"groupId": "org.mule.modules",
"assetId": "asset-with-files",
"version": "1.0.0",
"minorVersion": "1.0",
"versionGroup": "v1",
"isPublic": false,
"type": "rest-api",
"status": "published",
"createdDate": "2020-09-08T16:37:11.194000+00:00",
"updatedDate": "2020-09-08T16:44:04.217000+00:00",
"isSnapshot": false,
"originalFormat": "raml",
"originalFormatVersion": "1.0",
"minMuleVersion": null,
"isMozartTemplate": false,
"externalFile": {
"url": null
},
"createdBy": {
"id": "102d0953-9cca-475e-8767-768cd7aa7695",
"userName": "Char",
"firstName": "Charlie",
"lastName": "Brown"
},
"files": [
{
"classifier": "raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "ec57fff8e8abd7169f20b9c0f3a65c03",
"sha1": "3f75b6252ba42a502bcd41771f9d847b09ea126e",
"createdDate": "2020-09-08T16:37:10.781000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "fat-raml",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/fat-raml/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-raml.zip",
"md5": "ec57fff8e8abd7169f20b9c0f3a65c03",
"sha1": "3f75b6252ba42a502bcd41771f9d847b09ea126e",
"createdDate": "2020-09-08T16:37:10.824000+00:00",
"mainFile": "instagram-secure.raml",
"isGenerated": false
},
{
"classifier": "oas",
"packaging": "zip",
"downloadURL": "https://anypoint.mulesoft.com/exchange/files/api/v1/organizations/org.mule.modules/assets/org.mule.modules/asset-with-files/1.0.0/oas/zip",
"externalLink": "http://localhost/org.mule.modules/asset-with-files-2.0.0-oas.zip",
"md5": "e6658956af113a1ce7771f649f1e1370",
"sha1": "73897231991441f0d0e0d9c15e2b30ebcb29d09d",
"createdDate": "2020-09-08T16:37:11.001000+00:00",
"mainFile": "api.json",
"isGenerated": true
}
],
"dependencies": []
}
],
"id": "org.mule.modules/asset-with-files/2.0.0",
"icon": "http://www.icon.com.ar",
"createdAt": "2020-09-08T16:44:04.238000+00:00",
"modifiedAt": "2020-09-08T16:44:04.217000+00:00",
"organization": {
"id": "org.mule.modules",
"name": "Mulesoft",
"parentOrganizationIds": [],
"subOrganizationIds": [],
"tenantOrganizationIds": [],
"isMaster": true,
"domain": "mulesoft-0000",
"isMulesoftOrganization": false
},
"permissions": [
"admin",
"edit"
]
}
]
}
}
Get Portals By Organizationdomain Applications By Applicationid Instances getPortalsByOrganizationdomainApplicationsByApplicationidInstances
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets the list of API instances for the application
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
applicationId *:
string
The application ID to identify the target resource.
Response
Successful operation.
Examples
Instances
{
"value": [
{
"version": "1.0.0",
"audit": {
"created": {
"date": "2019-10-07T14:16:27.528000+00:00"
},
"updated": {
"date": "2019-12-20T17:57:59.147000+00:00"
}
},
"masterOrganizationId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"organizationId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"id": 300853,
"apiId": 242148,
"portalId": null,
"name": "v1:300853",
"instanceLabel": null,
"groupId": "f68e6165-99ce-4499-97e2-2d1d45498c73",
"assetId": "facebook",
"assetVersion": "1.0.0",
"productVersion": "v1",
"description": null,
"tags": [],
"order": 1,
"rootFileId": null,
"deprecated": false,
"lastActiveDate": null,
"endpointUri": null,
"environmentId": "90b78656-99e5-4754-a2ec-09f2eefc7d02",
"isPublic": true,
"stage": "release",
"terms": null,
"termsDate": null,
"fullname": "Facebook - QAx- v1:300853",
"assetName": "Facebook",
"environmentName": "QAx"
}
]
}
Get Portals By Organizationdomain Domain getPortalsByOrganizationdomainDomain
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets domain
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
Response
Doamin obtained
Update Portals By Organizationdomain Domain updatePortalsByOrganizationdomainDomain
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body text/plain
Updates a domain for an organization
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
Request Body
plainResponse
Domain updated
Delete Portals By Organizationdomain Domain deletePortalsByOrganizationdomainDomain
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Removes a domain
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
Response
Domain deleted
Get Portals By Organizationdomain Cookieconsentid getPortalsByOrganizationdomainCookieconsentid
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets cookie consent id
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
Response
Cookie consent id obtained
Update Portals By Organizationdomain Cookieconsentid updatePortalsByOrganizationdomainCookieconsentid
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body text/plain
Updates a cookie consent id for an organization
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
Request Body
plainResponse
Cookie consent id updated
Delete Portals By Organizationdomain Cookieconsentid deletePortalsByOrganizationdomainCookieconsentid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Removes a cookie consent id
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
Response
Cookie consent id deleted
Get Portals By Organizationdomain Status getPortalsByOrganizationdomainStatus
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets a public portal status
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
Response
Status obtained
Update Portals By Organizationdomain Status updatePortalsByOrganizationdomainStatus
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body text/plain
Updates a public portal status for an organization
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
Request Body
plainResponse
Status updated
Get Portals By Organizationdomain Draft getPortalsByOrganizationdomainDraft
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets the customization portal
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
Response
Customization obtained
Examples
Customization
{
"value": {
"customization": {
"home": {
"heroImage": "",
"welcomeTitle": "Welcome to the Portal",
"welcomeText": "content",
"textColor": "#000000"
}
},
"pages": [
{
"path": "home.md",
"name": "Home page"
},
{
"path": "/examples/example.md",
"name": "Example Page"
}
]
}
}
Update Portals By Organizationdomain Draft updatePortalsByOrganizationdomainDraft
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Updates the portal customization draft
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
Request Body
jsonExamples
UpdateCustomization
{
"value": {
"customization": {
"home": {
"heroImage": "",
"welcomeTitle": "Welcome to the Portal",
"welcomeText": "content",
"textColor": "#000000"
}
}
}
}
Response
Custom portal updated
Delete Portals By Organizationdomain Draft deletePortalsByOrganizationdomainDraft
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes the portal customization draft
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
Response
Draft portal deleted
Create Portals By Organizationdomain Draft Pages createPortalsByOrganizationdomainDraftPages
POST
Try it out
Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Creates an empty page for a draft version. Remember that:
- A page cannot be moved/created to/in a path that already contains another page with the same name.
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
Header Parameters
x-move-source:
string
The x move source header value.
Request Body
jsonpagePath *:
string
Examples
CreatePage
{
"value": {
"pagePath": "docs/faq"
}
}
Response
Page created.
Get Portals By Organizationdomain Draft Pages Pagepath getPortalsByOrganizationdomainDraftPagesPagepath
GET
Try it out
Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Gets a particular page
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
pagePath *:
string
The pagePath to identify the target resource.
Header Parameters
x-public-portal-domain:
string
The x public portal domain header value.
x-forwarded-host:
string
The x forwarded host header value.
x-forwarded-path:
string
The x forwarded path header value.
Response
Gets the page
path:
string
name:
string
Examples
PageHTML
{
"value": "<h1>\n Salesforce to Salesforce, Workday, SAP and Database Account Broadcast\n</h1>\n<p>\n <em>\n Real time synchronization of accounts from one Salesforce org to another as well as a Workday HCM instance, an SAP instance and a Database using a non-persistent JMS topic.\n </em>\n</p>\n<h2>\n Description\n</h2>\n<p>\n This Anypoint Template should serve as a foundation for setting an online sync of accounts from a Salesforce instance to many destination systems, using the Publish-subscribe pattern. Every time there is a new account or a change in an already existing one, the integration will poll for changes in the Salesforce source Org, publish the changes to a JMS topic and each subscriber will be responsible for updating the accounts in the target systems.\\n\\nThe application has two different batch jobs consuming this JMS topic, one for migrating the changes to the second Salesforce Org and the other one for migrating the changes to the Database. During the Process stage, each Salesforce account will be matched with an existing account in the Salesforce Org B or the Database by Name. The last step of the Process stage will group the accounts and create/update them in Salesforce Org B.\\n\\nFinally during the On Complete stage the Anypoint Template will log output statistics data into the console.\\n\\nRead more about the Publish-Subscribe pattern in <a href=\"http://blogs.mulesoft.com/introducing-pubsub-pattern-anypoint-templates/\">this</a> blog post\n</p>\n"
}
PageHTML
{
"value": "# Salesforce to Salesforce, Workday, SAP and Database Account Broadcast\n\n_Real time synchronization of accounts from one Salesforce org to another as well as a Workday HCM instance, an SAP instance and a Database using a non-persistent JMS topic._\n\n## Description\n\nThis Anypoint Template should serve as a foundation for setting an online sync of accounts from a Salesforce instance to many destination systems, using the Publish-subscribe pattern. Every time there is a new account or a change in an already existing one, the integration will poll for changes in the Salesforce source Org, publish the changes to a JMS topic and each subscriber will be responsible for updating the accounts in the target systems.\n\nThe application has two different batch jobs consuming this JMS topic, one for migrating the changes to the second Salesforce Org and the other one for migrating the changes to the Database. During the Process stage, each Salesforce account will be matched with an existing account in the Salesforce Org B or the Database by Name. The last step of the Process stage will group the accounts and create/update them in Salesforce Org B.\n\nFinally during the On Complete stage the Anypoint Template will log output statistics data into the console.\n\nRead more about the Publish-Subscribe pattern in [this](http://blogs.mulesoft.com/introducing-pubsub-pattern-anypoint-templates/) blog post\n"
}
Page
{
"value": {
"path": "home",
"name": "Home page"
}
}
Update Portals By Organizationdomain Draft Pages Pagepath updatePortalsByOrganizationdomainDraftPagesPagepath
PUT
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body text/markdown
Updates a page for a custom draft portal
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
pagePath *:
string
The pagePath to identify the target resource.
Request Body
markdownExamples
PageMarkdown
{
"value": "# Salesforce to Salesforce, Workday, SAP and Database Account Broadcast\n\n_Real time synchronization of accounts from one Salesforce org to another as well as a Workday HCM instance, an SAP instance and a Database using a non-persistent JMS topic._\n\n## Description\n\nThis Anypoint Template should serve as a foundation for setting an online sync of accounts from a Salesforce instance to many destination systems, using the Publish-subscribe pattern. Every time there is a new account or a change in an already existing one, the integration will poll for changes in the Salesforce source Org, publish the changes to a JMS topic and each subscriber will be responsible for updating the accounts in the target systems.\n\nThe application has two different batch jobs consuming this JMS topic, one for migrating the changes to the second Salesforce Org and the other one for migrating the changes to the Database. During the Process stage, each Salesforce account will be matched with an existing account in the Salesforce Org B or the Database by Name. The last step of the Process stage will group the accounts and create/update them in Salesforce Org B.\n\nFinally during the On Complete stage the Anypoint Template will log output statistics data into the console.\n\nRead more about the Publish-Subscribe pattern in [this](http://blogs.mulesoft.com/introducing-pubsub-pattern-anypoint-templates/) blog post\n"
}
Response
Page updated
Delete Portals By Organizationdomain Draft Pages Pagepath deletePortalsByOrganizationdomainDraftPagesPagepath
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes a page of a custom draft portal
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
pagePath *:
string
The pagePath to identify the target resource.
Response
Page deleted
Update Portals By Organizationdomain Draft Pagesorder updatePortalsByOrganizationdomainDraftPagesorder
PUT
Try it out
Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Saves the pages order for portal
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
Header Parameters
X-Pages-Order-Revision:
string
The X Pages Order Revision header value.
minLength: 1
Request Body
jsonitems:
array
Array items
Response
Pages order stored successfully
Get Portals By Organizationdomain Draft Resources getPortalsByOrganizationdomainDraftResources
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets portals resources
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
Response
Retrieved list of resources
Examples
application/json
[
{
"path": "resources/file-a0a5db36-940e-447b-9100-05b166b2c084.jpg"
}
]
Create Portals By Organizationdomain Draft Resources createPortalsByOrganizationdomainDraftResources
POST
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body */*
Creates a resource for the portal draft.
The required multipart fields in the body are the path of the resource and the content type. Ex:
-F "Content-Type=image/png"
-F "file=@/Users/llucas/Documents/image.png"
The required multipart fields in the body are the path of the resource and the content type. Ex:
-F "Content-Type=image/png"
-F "file=@/Users/llucas/Documents/image.png"
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
Request Body
*/*Response
Successfully created the portal resource
Examples
application/json
{
"path": "resources/dog.jpg",
"commitId": "eda56891-efab-40e0-a9ff-064e79327d17"
}
Get Portals By Organizationdomain Draft Resources By Resourceid getPortalsByOrganizationdomainDraftResourcesByResourceid
GET
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Gets portals resource
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
resourceId *:
string
The resource ID to identify the target resource.
Response
Retrieved file as a binary content
Delete Portals By Organizationdomain Draft Resources By Resourceid deletePortalsByOrganizationdomainDraftResourcesByResourceid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes portals resource
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
resourceId *:
string
The resource ID to identify the target resource.
Response
Resource deleted
Get Portals By Organizationdomain Pages Pagepath getPortalsByOrganizationdomainPagesPagepath
GET
Try it out
Path Parameters
Header Parameters
Custom Query Parameters
Custom Headers
Gets a particular page
Path Parameters
organizationDomain *:
string
Domain of the root organization
maxLength: 255
pagePath *:
string
The pagePath to identify the target resource.
Header Parameters
x-public-portal-domain:
string
The x public portal domain header value.
x-forwarded-host:
string
The x forwarded host header value.
x-forwarded-path:
string
The x forwarded path header value.
Response
success
path:
string
name:
string
Examples
PageHTML
{
"value": "<h1>\n Salesforce to Salesforce, Workday, SAP and Database Account Broadcast\n</h1>\n<p>\n <em>\n Real time synchronization of accounts from one Salesforce org to another as well as a Workday HCM instance, an SAP instance and a Database using a non-persistent JMS topic.\n </em>\n</p>\n<h2>\n Description\n</h2>\n<p>\n This Anypoint Template should serve as a foundation for setting an online sync of accounts from a Salesforce instance to many destination systems, using the Publish-subscribe pattern. Every time there is a new account or a change in an already existing one, the integration will poll for changes in the Salesforce source Org, publish the changes to a JMS topic and each subscriber will be responsible for updating the accounts in the target systems.\\n\\nThe application has two different batch jobs consuming this JMS topic, one for migrating the changes to the second Salesforce Org and the other one for migrating the changes to the Database. During the Process stage, each Salesforce account will be matched with an existing account in the Salesforce Org B or the Database by Name. The last step of the Process stage will group the accounts and create/update them in Salesforce Org B.\\n\\nFinally during the On Complete stage the Anypoint Template will log output statistics data into the console.\\n\\nRead more about the Publish-Subscribe pattern in <a href=\"http://blogs.mulesoft.com/introducing-pubsub-pattern-anypoint-templates/\">this</a> blog post\n</p>\n"
}
PageHTML
{
"value": "# Salesforce to Salesforce, Workday, SAP and Database Account Broadcast\n\n_Real time synchronization of accounts from one Salesforce org to another as well as a Workday HCM instance, an SAP instance and a Database using a non-persistent JMS topic._\n\n## Description\n\nThis Anypoint Template should serve as a foundation for setting an online sync of accounts from a Salesforce instance to many destination systems, using the Publish-subscribe pattern. Every time there is a new account or a change in an already existing one, the integration will poll for changes in the Salesforce source Org, publish the changes to a JMS topic and each subscriber will be responsible for updating the accounts in the target systems.\n\nThe application has two different batch jobs consuming this JMS topic, one for migrating the changes to the second Salesforce Org and the other one for migrating the changes to the Database. During the Process stage, each Salesforce account will be matched with an existing account in the Salesforce Org B or the Database by Name. The last step of the Process stage will group the accounts and create/update them in Salesforce Org B.\n\nFinally during the On Complete stage the Anypoint Template will log output statistics data into the console.\n\nRead more about the Publish-Subscribe pattern in [this](http://blogs.mulesoft.com/introducing-pubsub-pattern-anypoint-templates/) blog post\n"
}
Page
{
"value": {
"path": "home",
"name": "Home page"
}
}
Get Users Me Queries getUsersMeQueries
GET
Try it out
Query Parameters
Custom Query Parameters
Custom Headers
Gets a list of queries
Query Parameters
limit:
any
Amount of objects retrieved in the response
offset:
any
The offset specifies the offset of the first row to return
sort:
string
Property to sort by
ascending:
any
Order for sorting
Response
success
items:
array
Array items
Examples
SearchQueries
{
"value": [
{
"name": "name",
"types": [
"connector",
"rest-api"
],
"search": "salesforce"
}
]
}
Create Users Me Queries createUsersMeQueries
POST
Try it out
Custom Query Parameters
Custom Headers
Request Body application/json
Creates a new query
Request Body *
jsonname *:
string
minLength: 1, maxLength: 64
types:
array
search:
string
minLength: 0, maxLength: 1024
updatedAt:
string
minLength: 0, maxLength: 1024
categories:
array
tags:
array
status:
array
sort:
string
minLength: 0, maxLength: 16
organizationIds:
array
Examples
CreateSearchQuery
{
"value": {
"name": "name",
"types": [
"connector",
"rest-api"
],
"search": "salesforce"
}
}
Response
created
Examples
SearchQuery
{
"value": {
"name": "name",
"types": [
"connector",
"rest-api"
],
"search": "salesforce"
}
}
Patch Users Me Queries By Queryid patchUsersMeQueriesByQueryid
PATCH
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Request Body application/json
Edits a saved search query
Path Parameters
queryId *:
string
The query ID to identify the target resource.
Request Body
jsonname:
string
minLength: 1, maxLength: 64
types:
array
search:
string
minLength: 0, maxLength: 1024
updatedAt:
string
minLength: 0, maxLength: 1024
categories:
array
fields:
array
tags:
array
status:
array
sort:
string
minLength: 0, maxLength: 16
organizationIds:
array
Examples
UpdateSearchQuery
{
"value": {
"name": "name",
"search": "connector"
}
}
Response
Resource created successfully.
Examples
application/json
{
"name": "name",
"types": [
"connector",
"rest-api"
],
"search": "salesforce"
}
Delete Users Me Queries By Queryid deleteUsersMeQueriesByQueryid
DELETE
Try it out
Path Parameters
Custom Query Parameters
Custom Headers
Deletes the query
Path Parameters
queryId *:
string
The query ID to identify the target resource.
Response
Saved search query deleted
Get Featureflags getFeatureflags
GET
Try it out
Custom Query Parameters
Custom Headers
Lists featureFlags.
Response
Successful operation.
Get Graphql getGraphql
GET
Try it out
Custom Query Parameters
Custom Headers
Lists graphql.
Response
Successful operation.
Post Graphql postGraphql
POST
Try it out
Custom Query Parameters
Custom Headers
Creates graphql.
Response
Successful operation.