Smartapp.com

Projects

operations about projects in an AppZone

Returns all projects of an appZone

Request
query Parameters
globalID
string <uuid>

user unique identifier. If passed in then returns projects associated with the user

Example: globalID=00000000-0000-0000-0000-000000000000
skip
integer <int32>
Default: 0

Number of records to skip from the result set. if not passed in then will default to 0

Example: skip=10
take
integer <int32>
Default: 25

Number of records to return. if not passed in then will default to 25

Example: take=20
Responses
200

Returned Array of Project Summary

400

Invalid projectId

get/projects/getprojects
Request samples
Response samples
application/json
[
  • {
    }
]
Returns all SmartApp Instances in the given project
Request
path Parameters
projectID
required
string <uuid> 
project unique identifier


 
 Example:  00000000-0000-0000-0000-000000000000
query Parameters
instanceName
string
Name of the instance that you are looking for under the project


 
 Example:  instanceName=contentTypeBulk
Responses
200
Returned an array of SmartApp Summaries


get/projects/getsmartappinstances/{projectID}
Request samples
Response samples
application/json
[
  • {
    }
]
Returns the metadata and system fields associated with project
Request
query Parameters
smartAppID
required
string <uuid> 
Id of the smartapp


 
 Example:  smartAppID=00000000-0000-0000-0000-000000000000
Array of objects (fieldData) 
Array of field data . If not passed in then returns all the metadata and system fields along with the values


 
Array of objects (metadataFilterParams) 
Array of filter parameters


 
skip
integer <int32> 
 Default:  0
Number of records to skip from the result set. If not passed in then defaults to 0


 
 Example:  skip=10
take
integer <int32> 
 Default:  25
Number of records to return. if not passed in then defaults to 25


 
 Example:  take=20
Responses
200
Returned Project Field Summary


400
Invalid SmartAppId


post/projects/getprojectfielddata
Request samples
Response samples
application/json
[
  • {
    }
]
Returns project from id
Request
query Parameters
id
required
string <uuid> 
The unique identifier of the project


 
 Example:  id=00000000-0000-0000-0000-000000000000
globalID
string <uuid> 
User unique identifier. If passed in then returns the project only if the user is associated with it


 
 Example:  globalID=00000000-0000-0000-0000-000000000000
Responses
200
returned project summary


get/projects/get
Request samples
Response samples
application.json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "name": "PR-0005-School",
  • "description": "string",
  • "descriptionText": "string",
  • "Pmold": "d244e551-c992-4a8c-b8d0-6c9ab4dd26ca",
  • "imageURL": "string",
  • "createdOn": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "modifiedOn": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "path": "/Project/"
}
➔ Next to Smart Item