SmartApps

operations about SmartApps

Returns all SmartApps of an Appzone

Responses
200

returned SmartApps

get/spartapps/index
Request samples
Response samples
application/json
[
  • {
    }
]

Return SmartApp by name

Request
path Parameters
name
required
string

name of the smartapp that you want the summary

Example: A Mobile Grid Test
Responses
200

Returned SmartApp Summary

get/smartapps/getbyname/{name}
Request samples
Response samples
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "name": "A Mobile Grid Test",
  • "description": "string",
  • "imageUrl": "string"
}

Return metadata associated with the SmartApp

Request
query Parameters
id
required
string <uuid>

name of the smartapp that you want the metadata details

Example: id=00000000-0000-0000-0000-000000000000
Responses
200

returned metadata summary

get/smartapps/getmetadatafields
Request samples
Response samples
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "name": "fldf09832509",
  • "label": "EmpName",
  • "type": "String",
  • "collectionID": "0fb8fcb1-bc90-4b76-a120-82877862d996",
  • "collectionName": "mdcb4af6414d7cf44e1988f2a10c76fa97e",
  • "collectionLabel": "sub_item"
}

Return all reports with the specified SmartApp

Request
query Parameters
id
required
string <uuid>

unbique identifier associated with the smartapp

Example: id=00000000-0000-0000-0000-000000000000
reportType
string

If not passed in then returns all the reports, else returns the specified one

Enum: "ApplicationReport" "GridPrintViewReport" "SmartitemDefinitionReport"
Responses
200

Returned Report Summary

get/smartapps/getreports
Request samples
Response samples
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "name": "string",
  • "type": "ApplicationReport"
}

Return all stages associated with the specified SmartApps of the active definition version

Request
query Parameters
id
required
string <uuid>

unique identifier associated with the smartapp

Example: id=00000000-0000-0000-0000-000000000000
Responses
200

Returns array of stage objects

get/smartapps/getstages
Request samples
Response samples
application/json
[
  • {
    }
]

Return SmartApp by ID

Request
path Parameters
id
required
string <uuid>

Unique Id of the smartapp that you want the summary

Example: 00000000-0000-0000-0000-000000000000
Responses
200

Returns SmartApp Summary

get/smartapps/getbyid/{id}
Request samples
Response samples
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "name": "A Mobile Grid Test",
  • "description": "string",
  • "imageUrl": "string"
}

Return all advanced settings associated with the specified smartapp

Request
query Parameters
id
required
string <uuid>

unique identifier associated with the smartapp

Example: id=00000000-0000-0000-000000000000
Responses
200

returns array key value pairs of main and subitem

get/smartapps/getadvancedsettings
Request samples
Response samples
application/json
[
  • { }
]