Application Groups Resource

Provides access and management of application groups.

GET /{tenantGuid}/api/v1/applicationGroups

Available Since:
12.10.0

Get all application groups or application groups with a specific query. If no application groups are found, an empty application group list is included in the response body.

Sample request

 GET /SRP00000/api/v1/applicationGroups?query=name=TestAppGroup

Sample response body

 
 {
  "applicationGroups" : [ {
    "guid" : "6d0c4ddb-10ae-471d-948d-df27868dcf8a",
    "name" : "TestAppGroup",
    "description" : "Test group description"
   } ]
 }

Request Parameters
Name Location Description
query query (Optional) A query for filtering the application group results by name. Commas or backslashes in query values must be escaped with a backslash.
Field Type Description
name string Name of the application group. Case insensitive exact match.
Response Codes
Code Condition Data type
200 OK (even if no application groups are found).
400 Invalid search query.
Response Body
Media type Data type Description
application/vnd.blackberry.applicationgroups-v1+json Application groups (JSON)

POST /{tenantGuid}/api/v1/applicationGroups

Available Since:
12.10.0

Create an application group. Only the name field of the group is required. The description field is optional.

Samples

Sample request body

 
 {
  "name":"Test application group name",
  "description":"Test application group description"
 }

Sample response body

 
 {
  "guid":"6d0c4ddb-10ae-471d-948d-df27868dcf8a",
  "name":"Test application group name",
  "description":"Test application group description",
 }

Request Body
Media type Data type
application/vnd.blackberry.applicationgroup-v1+json ApplicationGroup (JSON)
Response Codes
Code Condition Data type
201 Application group created.
400 Invalid request. For example, invalid field semantics or missing required field.
409 Application group already exists.
Response Body
Media type Data type Description
application/vnd.blackberry.applicationgroup-v1+json ApplicationGroup (JSON)
Response Headers
Name Description
Location Location of the created application group. Can be used to perform a GET request to retrieve the application group. Only present when status is 201.

DELETE /{tenantGuid}/api/v1/applicationGroups/{appGroupGuid}

Available Since:
12.11.0

Delete an application group.

Request Parameters
Name Location Description
appGroupGuid path GUID of the application group.
Response Codes
Code Condition Data type
204 Application group removed.
    404 Application group not found.

    GET /{tenantGuid}/api/v1/applicationGroups/{appGroupGuid}

    Available Since:
    12.10.0

    Get an application group by a specific GUID.

    Sample response body

     
 {
  "guid":"6d0c4ddb-10ae-471d-948d-df27868dcf8a",
  "name":"Test application group name",
  "description":"Test group description"
 }

    Request Parameters
    Name Location Description
    appGroupGuid path
    Response Codes
    Code Condition Data type
    200 OK.
    404 Application group not found.
    Response Body
    Media type Data type Description
    application/vnd.blackberry.applicationgroup-v1+json ApplicationGroup (JSON)

    PUT /{tenantGuid}/api/v1/applicationGroups/{appGroupGuid}

    Available Since:
    12.10.0

    Update an existing application group. Name or description should be provided.

    Samples

    Sample request body

     
 {
  "name":"Test application group name",
  "description":"Test application group description"
 }

    Sample response body

     
 {
  "guid":"6d0c4ddb-10ae-471d-948d-df27868dcf8a",
  "name":"Test application group name",
  "description":"Test application group description",
 }

    Request Parameters
    Name Location Description
    appGroupGuid path
    Request Body
    Media type Data type
    application/vnd.blackberry.applicationgroup-v1+json ApplicationGroup (JSON)
    Response Codes
    Code Condition Data type
    200 Application group updated.
    400 Invalid request. For example, invalid field semantics or missing required field.
    404 Application group not found.
    409 Application group already exists.
    Response Body
    Media type Data type Description
    application/vnd.blackberry.applicationgroup-v1+json ApplicationGroup (JSON)

    GET /{tenantGuid}/api/v1/applicationGroups/{appGroupGuid}/applications

    Available Since:
    12.11.0

    Get all the applications assigned to an application group by a specific GUID.

    Sample response body

     
 {
  "applications" : [ {
    "guid" : "aa291d31-3b51-4424-a09c-7b127ee398a8",
    "name":"BBM",
    "os": "BB",
    "sourceName": "In Store",
    "storeName": "BlackBerry World",
    "vendorName": "BlackBerry Limited",
    "version": "10.15.7.5"
   } ]
 }

    Request Parameters
    Name Location Description
    appGroupGuid path
    Response Codes
    Code Condition Data type
    200 OK.
    404 Application group not found.
    Response Body
    Media type Data type Description
    application/vnd.blackberry.applications-v1+json Applications (JSON)

    POST /{tenantGuid}/api/v1/applicationGroups/{appGroupGuid}/applications

    Available Since:
    12.10.0

    Add applications to an application group.

    The application GUID is used to identify the applications that will be added to the application group. All other fields will be ignored if they are provided.

    Samples

    Sample request body

     
 {
   "applications" :
   [
     {
       "guid" : "aa291d31-3b51-4424-a09c-7b127ee398a8"
     },
     {
       "guid" : "38fa866a-f7f3-4d52-a609-d4304a0bcc34"
     }
   ]
 }

    Request Parameters
    Name Location Description
    appGroupGuid path
    Request Body
    Media type Data type
    application/vnd.blackberry.applications-v1+json Applications (JSON)
    Response Codes
    Code Condition Data type
    204 Applications added to application group.
      400 Invalid request. For example, invalid field semantics or missing required field.
      404 Application group not found.
      404 Application not found.

      PUT /{tenantGuid}/api/v1/applicationGroups/{appGroupGuid}/applications

      Available Since:
      12.10.0

      Replace all applications in an application group.

      The application GUID is used to identify the applications that will be replacing all the existing applications in the application group. All other fields will be ignored if they are provided.

      Samples

      Sample request body

       
 {
   "applications" :
   [
     {
       "guid" : "aa291d31-3b51-4424-a09c-7b127ee398a8"
     },
     {
       "guid" : "38fa866a-f7f3-4d52-a609-d4304a0bcc34"
     }
   ]
 }

      Request Parameters
      Name Location Description
      appGroupGuid path
      Request Body
      Media type Data type
      application/vnd.blackberry.applications-v1+json Applications (JSON)
      Response Codes
      Code Condition Data type
      204 Applications replaced in application group.
        400 Invalid request. For example, invalid field semantics or missing required field.
        404 Application group not found.
        404 Application not found.