0
0
Fork 0
mirror of https://github.com/salesagility/SuiteCRM.git synced 2025-02-06 23:10:03 +00:00
salesagility_SuiteCRM/Api/docs/postman/SalesAgility.postman_collection.json
j.dang cd0aabc705 Fix - API Create Relationship via Link
- Revert old endpoint code for backward compatibility.
- Add new createRelationshipByLink endpoint and test.
- Update Postman collection with new endpoint.
- Remove access tokens in Postman collection.
- Replace IDs with placeholders in Postman collection.
2019-08-21 11:50:32 +01:00

1036 lines
No EOL
20 KiB
JSON

{
"info": {
"name": "SalesAgility",
"_postman_id": "{ID}",
"description": "",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "SuiteCRM/V8",
"description": "",
"item": [
{
"name": "Get module",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "accessToken",
"value": "",
"type": "string"
},
{
"key": "tokenType",
"value": "Bearer",
"type": "string"
},
{
"key": "addTokenTo",
"value": "header",
"type": "string"
},
{
"key": "callBackUrl",
"type": "any"
},
{
"key": "authUrl",
"type": "any"
},
{
"key": "accessTokenUrl",
"type": "any"
},
{
"key": "clientId",
"type": "any"
},
{
"key": "clientSecret",
"type": "any"
},
{
"key": "clientAuth",
"type": "any"
},
{
"key": "grantType",
"type": "any"
},
{
"key": "scope",
"type": "any"
},
{
"key": "username",
"type": "any"
},
{
"key": "password",
"type": "any"
},
{
"key": "redirectUri",
"type": "any"
},
{
"key": "refreshToken",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\n}"
},
"url": {
"raw": "{{suitecrm.url}}/V8/module/Accounts/{ID}?fields[Accounts]=name,account_type",
"host": [
"{{suitecrm.url}}"
],
"path": [
"V8",
"module",
"Accounts",
"{ID}"
],
"query": [
{
"key": "fields[Accounts]",
"value": "name,account_type",
"equals": true
}
]
},
"description": null
},
"response": []
},
{
"name": "Get modules",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "accessToken",
"value": "",
"type": "string"
},
{
"key": "tokenType",
"value": "Bearer",
"type": "string"
},
{
"key": "addTokenTo",
"value": "header",
"type": "string"
},
{
"key": "callBackUrl",
"type": "any"
},
{
"key": "authUrl",
"type": "any"
},
{
"key": "accessTokenUrl",
"type": "any"
},
{
"key": "clientId",
"type": "any"
},
{
"key": "clientSecret",
"type": "any"
},
{
"key": "clientAuth",
"type": "any"
},
{
"key": "grantType",
"type": "any"
},
{
"key": "scope",
"type": "any"
},
{
"key": "username",
"type": "any"
},
{
"key": "password",
"type": "any"
},
{
"key": "redirectUri",
"type": "any"
},
{
"key": "refreshToken",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\n}"
},
"url": {
"raw": "{{suitecrm.url}}/V8/module/Accounts?fields[Accounts]=name,account_type&page[size]=4&page[number]=4&sort=name&filter[operator]=and&filter[account_type][eq]=Customer",
"host": [
"{{suitecrm.url}}"
],
"path": [
"V8",
"module",
"Accounts"
],
"query": [
{
"key": "fields[Accounts]",
"value": "name,account_type",
"equals": true
},
{
"key": "page[size]",
"value": "4",
"equals": true
},
{
"key": "page[number]",
"value": "4",
"equals": true
},
{
"key": "sort",
"value": "name",
"equals": true
},
{
"key": "filter[operator]",
"value": "and",
"equals": true
},
{
"key": "filter[account_type][eq]",
"value": "Customer",
"equals": true
}
]
},
"description": null
},
"response": []
},
{
"name": "Create module",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "accessToken",
"value": "",
"type": "string"
},
{
"key": "tokenType",
"value": "Bearer",
"type": "string"
},
{
"key": "addTokenTo",
"value": "header",
"type": "string"
},
{
"key": "callBackUrl",
"type": "any"
},
{
"key": "authUrl",
"type": "any"
},
{
"key": "accessTokenUrl",
"type": "any"
},
{
"key": "clientId",
"type": "any"
},
{
"key": "clientSecret",
"type": "any"
},
{
"key": "clientAuth",
"type": "any"
},
{
"key": "grantType",
"type": "any"
},
{
"key": "scope",
"type": "any"
},
{
"key": "username",
"type": "any"
},
{
"key": "password",
"type": "any"
},
{
"key": "redirectUri",
"type": "any"
},
{
"key": "refreshToken",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"Accounts\",\n \"id\": \"{ID}\",\n \"attributes\": {\n \"name\": \"Muhahaha\"\n }\n }\n}"
},
"url": {
"raw": "{{suitecrm.url}}/V8/module",
"host": [
"{{suitecrm.url}}"
],
"path": [
"V8",
"module"
]
},
"description": null
},
"response": []
},
{
"name": "Update module",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "accessToken",
"value": "",
"type": "string"
},
{
"key": "tokenType",
"value": "Bearer",
"type": "string"
},
{
"key": "addTokenTo",
"value": "header",
"type": "string"
},
{
"key": "callBackUrl",
"type": "any"
},
{
"key": "authUrl",
"type": "any"
},
{
"key": "accessTokenUrl",
"type": "any"
},
{
"key": "clientId",
"type": "any"
},
{
"key": "clientSecret",
"type": "any"
},
{
"key": "clientAuth",
"type": "any"
},
{
"key": "grantType",
"type": "any"
},
{
"key": "scope",
"type": "any"
},
{
"key": "username",
"type": "any"
},
{
"key": "password",
"type": "any"
},
{
"key": "redirectUri",
"type": "any"
},
{
"key": "refreshToken",
"type": "any"
}
]
},
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"Accounts\",\n \"id\": \"{ID}\",\n \"attributes\": {\n \"name\": \"hapff111fff\"\n }\n }\n}"
},
"url": {
"raw": "{{suitecrm.url}}/V8/module",
"host": [
"{{suitecrm.url}}"
],
"path": [
"V8",
"module"
]
},
"description": ""
},
"response": []
},
{
"name": "Delete module",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "accessToken",
"value": "",
"type": "string"
},
{
"key": "tokenType",
"value": "Bearer",
"type": "string"
},
{
"key": "addTokenTo",
"value": "header",
"type": "string"
},
{
"key": "callBackUrl",
"type": "any"
},
{
"key": "authUrl",
"type": "any"
},
{
"key": "accessTokenUrl",
"type": "any"
},
{
"key": "clientId",
"type": "any"
},
{
"key": "clientSecret",
"type": "any"
},
{
"key": "clientAuth",
"type": "any"
},
{
"key": "grantType",
"type": "any"
},
{
"key": "scope",
"type": "any"
},
{
"key": "username",
"type": "any"
},
{
"key": "password",
"type": "any"
},
{
"key": "redirectUri",
"type": "any"
},
{
"key": "refreshToken",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{suitecrm.url}}/V8/module/Accounts/{ID}",
"host": [
"{{suitecrm.url}}"
],
"path": [
"V8",
"module",
"Accounts",
"{ID}"
]
},
"description": ""
},
"response": []
},
{
"name": "Get relationship",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "accessToken",
"value": "",
"type": "string"
},
{
"key": "tokenType",
"value": "Bearer",
"type": "string"
},
{
"key": "addTokenTo",
"value": "header",
"type": "string"
},
{
"key": "callBackUrl",
"type": "any"
},
{
"key": "authUrl",
"type": "any"
},
{
"key": "accessTokenUrl",
"type": "any"
},
{
"key": "clientId",
"type": "any"
},
{
"key": "clientSecret",
"type": "any"
},
{
"key": "clientAuth",
"type": "any"
},
{
"key": "grantType",
"type": "any"
},
{
"key": "scope",
"type": "any"
},
{
"key": "username",
"type": "any"
},
{
"key": "password",
"type": "any"
},
{
"key": "redirectUri",
"type": "any"
},
{
"key": "refreshToken",
"type": "any"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\n}"
},
"url": {
"raw": "{{suitecrm.url}}/V8/module/Accounts/{ID}/relationships/contacts",
"host": [
"{{suitecrm.url}}"
],
"path": [
"V8",
"module",
"Accounts",
"{ID}",
"relationships",
"contacts"
]
},
"description": null
},
"response": []
},
{
"name": "Create relationship",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "accessToken",
"value": "",
"type": "string"
},
{
"key": "tokenType",
"value": "Bearer",
"type": "string"
},
{
"key": "addTokenTo",
"value": "header",
"type": "string"
},
{
"key": "callBackUrl",
"type": "any"
},
{
"key": "authUrl",
"type": "any"
},
{
"key": "accessTokenUrl",
"type": "any"
},
{
"key": "clientId",
"type": "any"
},
{
"key": "clientSecret",
"type": "any"
},
{
"key": "clientAuth",
"type": "any"
},
{
"key": "grantType",
"type": "any"
},
{
"key": "scope",
"type": "any"
},
{
"key": "username",
"type": "any"
},
{
"key": "password",
"type": "any"
},
{
"key": "redirectUri",
"type": "any"
},
{
"key": "refreshToken",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"Contacts\",\n \"id\": \"{ID}\"\n }\n}"
},
"url": {
"raw": "{{suitecrm.url}}/V8/module/Accounts/{ID}/relationships",
"host": [
"{{suitecrm.url}}"
],
"path": [
"V8",
"module",
"Accounts",
"{ID}",
"relationships"
]
},
"description": null
},
"response": []
},
{
"name": "Create relationship by link",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "accessToken",
"value": "",
"type": "string"
},
{
"key": "tokenType",
"value": "Bearer",
"type": "string"
},
{
"key": "addTokenTo",
"value": "header",
"type": "string"
},
{
"key": "callBackUrl",
"type": "any"
},
{
"key": "authUrl",
"type": "any"
},
{
"key": "accessTokenUrl",
"type": "any"
},
{
"key": "clientId",
"type": "any"
},
{
"key": "clientSecret",
"type": "any"
},
{
"key": "clientAuth",
"type": "any"
},
{
"key": "grantType",
"type": "any"
},
{
"key": "scope",
"type": "any"
},
{
"key": "username",
"type": "any"
},
{
"key": "password",
"type": "any"
},
{
"key": "redirectUri",
"type": "any"
},
{
"key": "refreshToken",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"data\": {\n \"type\": \"Contacts\",\n \"id\": \"{ID}\"\n }\n}"
},
"url": {
"raw": "{{suitecrm.url}}/V8/module/Accounts/{ID}/relationships/{linkName}",
"host": [
"{{suitecrm.url}}"
],
"path": [
"V8",
"module",
"Accounts",
"{ID}",
"relationships",
"{linkName}"
]
},
"description": null
},
"response": []
},
{
"name": "Delete relationship",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "accessToken",
"value": "",
"type": "string"
},
{
"key": "tokenType",
"value": "Bearer",
"type": "string"
},
{
"key": "addTokenTo",
"value": "header",
"type": "string"
},
{
"key": "callBackUrl",
"type": "any"
},
{
"key": "authUrl",
"type": "any"
},
{
"key": "accessTokenUrl",
"type": "any"
},
{
"key": "clientId",
"type": "any"
},
{
"key": "clientSecret",
"type": "any"
},
{
"key": "clientAuth",
"type": "any"
},
{
"key": "grantType",
"type": "any"
},
{
"key": "scope",
"type": "any"
},
{
"key": "username",
"type": "any"
},
{
"key": "password",
"type": "any"
},
{
"key": "redirectUri",
"type": "any"
},
{
"key": "refreshToken",
"type": "any"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "{{suitecrm.url}}/V8/module/Accounts/{ID}/relationships/contacts/{ID}",
"host": [
"{{suitecrm.url}}"
],
"path": [
"V8",
"module",
"Accounts",
"{ID}",
"relationships",
"contacts",
"{ID}"
]
},
"description": null
},
"response": []
},
{
"name": "Logout",
"request": {
"auth": {
"type": "oauth2",
"oauth2": [
{
"key": "accessToken",
"value": "",
"type": "string"
},
{
"key": "tokenType",
"value": "Bearer",
"type": "string"
},
{
"key": "addTokenTo",
"value": "header",
"type": "string"
},
{
"key": "callBackUrl",
"type": "any"
},
{
"key": "authUrl",
"type": "any"
},
{
"key": "accessTokenUrl",
"type": "any"
},
{
"key": "clientId",
"type": "any"
},
{
"key": "clientSecret",
"type": "any"
},
{
"key": "clientAuth",
"type": "any"
},
{
"key": "grantType",
"type": "any"
},
{
"key": "scope",
"type": "any"
},
{
"key": "username",
"type": "any"
},
{
"key": "password",
"type": "any"
},
{
"key": "redirectUri",
"type": "any"
},
{
"key": "refreshToken",
"type": "any"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\n}"
},
"url": {
"raw": "{{suitecrm.url}}/V8/logout",
"host": [
"{{suitecrm.url}}"
],
"path": [
"V8",
"logout"
]
},
"description": ""
},
"response": []
}
]
}
]
}