Description

Create an app pack with this api.

Request Endpoint

POST https://<Example api server address>/admin/app/pack

Parameters

None.

cURL syntax

curl --include \
     --request POST \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"title\":\"Watsapp\",
    \"backgroundImage\":\"AppImage\",
    \"applicationIds\": [\"6bf866f9-59ba-4fde-ab5c-600ff217da42\"],
    \"startDate\" : 1467112085
}" \
'https://core.dev.Example.net/api/admin/app/pack'

POST body attributes (JSON)

Attribute	Type	Use	Description
title	String	Required	Title for the app pack.
backgroundImage	String	Optional	An image.
applicationIds	String	Required	List of application Ids.
startDate	String	Optional	A new date.

POST body

Headers: Content-Type: application/json

{
  "title": "Watsapp",
  "backgroundImage": "AppImage",
  "applicationIds": [
    "6bf866f9-59ba-4fde-ab5c-600ff217da42"
  ],
  "startDate": 1467112085
}

Response body

Headers: Content-Type: application/json | HTTPS Status Code: 200

{
  "data": {
    "id": "b696b10a-648e-40d2-9724-9241aa3a4ee0",
    "updatedBy": "",
    "title": "Watsapp",
    "backgroundImage": "AppImage",
    "applicationIds": [
      "6bf866f9-59ba-4fde-ab5c-600ff217da42"
    ]
  },
  "detail": null,
  "error": false,
  "message": "Creating app pack successful"
}

Return to top

Description

Deletes an existing App Pack.

Request Endpoint

DELETE https://<Example api server address>/admin/app/packs/{id}

Parameters

Parameter	Type	Use	Description
id	String	Required	AppPAckId of an existing App Pack.

cURL syntax

curl --include \
     --request DELETE \
'https://core.dev.Example.net/api/admin/app/packs/id'

Response body

Headers: Content-Type: application/json | HTTPS Status Code: 200

{
  "data": null,
  "detail": null,
  "error": false,
  "message": "Deleting app pack successful"
}

Return to top

Description

Fetch all the packs existing in the app.

Request Endpoint

GET https://<Example api server address>/admin/app/pack?{offset}&{limit}

Parameters

Parameter	Type	Use	Description
offset	Number	Optional	Offset to control the results.
limit	Number	Optional	Limit to control the results.

cURL syntax

curl --include \
'https://core.dev.Example.net/api/admin/app/pack'

Response body

Headers: Content-Type: application/json | HTTPS Status Code: 200

{
  "data": [
    {
      "id": "09ded9c2-36aa-4d51-bf72-ebd1bc198d1f",
      "updatedBy": "",
      "title": "ABC",
      "backgroundImage": "image23cv12",
      "applicationIds": null
    },
    {
      "id": "5c95b530-eb3d-4709-bb54-8d80ff326362",
      "updatedBy": "",
      "title": "App45",
      "backgroundImage": "dfj",
      "applicationIds": null
    },
    {
      "id": "b696b10a-648e-40d2-9724-9241aa3a4ee0",
      "updatedBy": "",
      "title": "Watsapp",
      "backgroundImage": "AppImage",
      "applicationIds": null
    }
  ],
  "detail": null,
  "error": false,
  "message": "Fetching app packs successful"
}

Return to top

Description

This API will fetch an existing app pack by the id passed.

Request Endpoint

GET https://<Example api server address>/admin/app/packs/{id}

Parameters

Parameter	Type	Use	Description
id	String	Required	appPackId of an existing app pack.

cURL syntax

curl --include \
'https://core.dev.Example.net/api/admin/app/packs/id'

Response body

Headers: Content-Type: application/json | HTTPS Status Code: 200

{
  "data": {
    "id": "09ded9c2-36aa-4d51-bf72-ebd1bc198d1f",
    "updatedBy": "",
    "title": "Facebook",
    "backgroundImage": "fb image",
    "applicationIds": null
  },
  "detail": null,
  "error": false,
  "message": "Fetching app packs detail successful"
}

Return to top

Description

Fetches an existing app pack by the title passed.

Request Endpoint

GET https://<Example api server address>/admin/find/app/packs/{title}

Parameters

Parameter	Type	Use	Description
title	String	Required	Title of an existing app pack.

cURL syntax

curl --include \
'https://core.dev.Example.net/api/admin/find/app/packs/title'

Response body

Headers: Content-Type: application/json | HTTPS Status Code: 200

{
  "data": {
    "id": "b696b10a-648e-40d2-9724-9241aa3a4ee0",
    "updatedBy": "",
    "title": "Watsapp",
    "backgroundImage": "AppImage",
    "applicationIds": null
  },
  "detail": null,
  "error": false,
  "message": "Fetching app packs detail successful"
}

Return to top

Description

Update the app packs with this api.

Request Endpoint

PUT https://<Example api server address>/admin/app/packs/{id}

Parameters

Parameter	Type	Use	Description
id	String	Required	The appPackId of an existing pack.

cURL syntax

curl --include \
     --request PUT \
     --header "Content-Type: application/json" \
     --data-binary "{
    \"title\":\"Facebook\",
    \"backgroundImage\":\"fb image\",
    \"applicationIds\": [\"d5d2a034-dcac-4484-bcc1-9bd5f5d73ab5\"],
    \"startDate\": 1467112085
}" \
'https://core.dev.Example.net/api/admin/app/packs/id'

PUT body attributes (JSON)

Attribute	Type	Use	Description
title	String	Optional	Title for the app pack.
backgroundImage	String	Optional	A background image.
applicationIds	String	Optional	A list of application Ids.
startDate	String	Optional	A new Date.

PUT body

Headers: Content-Type: application/json

{
  "title": "Facebook",
  "backgroundImage": "fb image",
  "applicationIds": [
    "d5d2a034-dcac-4484-bcc1-9bd5f5d73ab5"
  ],
  "startDate": 1467112085
}

Response body

Headers: Content-Type: application/json | HTTPS Status Code: 200

{
  "data": {
    "id": "09ded9c2-36aa-4d51-bf72-ebd1bc198d1f",
    "updatedBy": "",
    "title": "Facebook",
    "backgroundImage": "fb image",
    "applicationIds": null
  },
  "detail": null,
  "error": false,
  "message": "Editing app packs successful"
}

Return to top