Composite Application groups
  • 30 May 2020
  • 2 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Composite Application groups

  • Dark
    Light
  • PDF

Exposed API’s for Composite Application Groups

With the help of API’s exposed for composite application group you can Create / Delete / Update any composite application group in Serverless360.

1. Get All Composite Application Groups

API Suffix and Method

Suffix : /CompositeApplicationGroups
Method : GET

This API can be used to get all the composite application group details.
Response Body
Response Body contains all the details regarding the composite application groups available in your serverless360 account.

[
  {
    "id": "a0151fbf7-b6e0-44c9-98e6-def2aaf0a70c",
    "parentId": null,
    "name": "OrganisationName",
    "description": "",
    "createdAt": "2020-03-24T07:53:11",
    "modifiedAt": "2020-03-24T07:53:11"
  },
  {
    "id": "b0000000-0000-0000-0000-000000000000",
    "parentId": "a0000000-0000-0000-0000-000000000000",
    "name": "Demo Environment",
    "description": "",
    "createdAt": "2020-03-24T07:53:11",
    "modifiedAt": "2020-03-24T07:53:11"
  }
]

composite application groups

2. Create a Composite Application Group

API Suffix and Method

Suffix : /CompositeApplicationGroups
Method : POST

This API can be used to create a composite application group.

Request Body Format

{
  "id": "0151fbf7-b6e0-44c9-98e6-def2aaf0a70c",
  "parentId": "0151fbf7-b6e0-44c9-98e6-def2aaf0a70c",
  "name": "string",
  "description": "string",
  "createdAt": "2020-05-27T14:38:14.880Z",
  "modifiedAt": "2020-05-27T14:38:14.880Z"
}
Mandatory Fields

"name": "string"

Response Body
Response body of this API will be the unique Id generated by Serverless360 for the newly created composite application group. Later this unique composite application group Id can be used to perform the Update / Delete operation

"0151fbf7-b6e0-44c9-98e6-def2aaf0a70c"

3. Update a Composite Application Group

API Suffix and Method

Suffix : /CompositeApplicationGroups
Method : PUT

This API can be used to update an existing composite application group.

Request Body Format

{
  "id": "0151fbf7-b6e0-44c9-98e6-def2aaf0a70c",
  "parentId": "b5a90529-a042-4e19-b9fa-bf446c242eba",
  "name": "string",
  "description": "string",
  "createdAt": "2020-05-27T14:38:14.889Z",
  "modifiedAt": "2020-05-27T14:38:14.889Z"
}
Mandatory Fields

"id": "00000000-0000-0000-0000-000000000000" (Composite Application Group Id)
"name": "string" (Name for the Composite application Group)

Response Body

"Composite Application Group [CompositeApplicationGroupName] updated successfully"

4. Delete a Composite application group and its members

API Suffix and Method

Suffix : /CompositeApplicationGroups/{compositeApplicationGroupId}
Method : DELETE

This API can be used to Delete an existing composite application group along with all its composite application members.

Request Body Format

compositeApplicationGroupId should be passsed in the Suffix URL 

Response Body

"Composite Application Group [CompositeApplicationGroupName] deleted successfully"

5. Get Composite Application Group of the provided Id

API Suffix and Method

Suffix : /CompositeApplicationGroups/{compositeApplicationGroupId}
Method : GET

This API can be used to get individual Composite application group by providing the unique compositeApplicationGroupId.

Request Body Format

compositeApplicationGroupId should be passsed in the Suffix URL 

Response Body

{
  "id": "0151fbf7-b6e0-44c9-98e6-def2aaf0a70c",
  "parentId": null,
  "name": "Composite Application Group Name",
  "description": "",
  "createdAt": "2020-03-24T07:53:11",
  "modifiedAt": "2020-03-24T07:53:11"
}
We'd love to hear your thoughts
Please visit our feedback system to suggest new Features or Enhancements. You can also take a look at our Roadmap

Was this article helpful?