Smartapp.com

Smart Item

operations about Smart items

creates a new Smart item Instance

Request
Request Body schema: application/json
name
required
string

name of smart item

smartAppInstanceId
required
string <uuid>

Unique id associated with the smartapp

parentId
string <uuid>

Unique parent id for the smart item

smartAppInstanceInternalId
integer <int64>

Numeric id associated with the smartapp

object (smartItemStatus)
contentType
string
stamp
string <uuid>
description
string

Description for the item

object

System properties for the item.

object

metadata for the item

object

Location of the item

object
Array of objects (fileData)
object (scheduleMetadata)
Responses
200

Returned Smart item Summary

400

Invalid arguments, smartappInstanceId, parentItemId

401

You do not have sufficient appzone api transactions to perform the action

post/smartitems/create
Request samples
application/json
{
  • "name": "name of smart item",
  • "smartAppInstanceId": "00000000-0000-0000-0000-000000000000",
  • "parentId": "00000000-0000-0000-0000-000000000000",
  • "smartAppInstanceInternalId": 637606,
  • "status": {
    },
  • "contentType": "string",
  • "stamp": "00000000-0000-0000-0000-000000000000",
  • "description": "Description-4",
  • "systemProperties": { },
  • "metadata": { },
  • "location": { },
  • "metadataFields": { },
  • "files": [
    ],
  • "scheduleData": {
    }
}
Response samples
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "itemID": 4827593,
  • "name": "item-4",
  • "description": "string",
  • "stamp": "6c279aea-e303-44a2-988e-07f7940dddbf",
  • "modifiedOn": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    }
}

Updates an existing Smart Item

Request
query Parameters
itemID
required
string <uuid>

id of the smart item to be updated

Example: itemID=00000000-0000-0000-0000-000000000000
stage
required
string

smart item stage

stamp
string <uuid>
Example: stamp=00000000-0000-0000-0000-000000000000
object (smartItemStatus)

status of the smart item

object

System properties of the item.

object

Metadata for the item

object

Location of the item

object
Array of objects (fileData)
object (scheduleMetadata)

Schedule metadata

Responses
200

Returns a Smart Item Summary

400

Invalid itemId or status

401

You do not have sufficient appzone api transactions to perform the action

post/smartitems/update
Request samples
Response samples
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "itemID": 4827593,
  • "name": "item-4",
  • "description": "string",
  • "stamp": "6c279aea-e303-44a2-988e-07f7940dddbf",
  • "modifiedOn": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    }
}
Update the stream of the file smart item
Request
query Parameters
id
required
string <uuid> 
the uniwue identifier of the smart item


 
 Example:  id=00000000-0000-0000-0000-000000000000
stream
required
string <binary> 
the contents of the incoming HTTP entity body


 
Responses
200
Returns a Smart item Summary


400
invalid id or document type


post/smartitems/updatestream
Request samples
Response samples
application/json
{
  • "ID": "3892eb50-4697-4c72-aadc-32b766bce3c0",
  • "itemID": 4827593,
  • "name": "item-4",
  • "description": "string",
  • "stamp": "6c279aea-e303-44a2-988e-07f7940dddbf",
  • "modifiedOn": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    }
}
get Location ID from name of SmartItem
Request
query Parameters
appName
required
string
name of the smartapp


 
 Example:  appName=ContentTypeBulk
propertyName
required
string
property name


 
 Example:  propertyName=Invoicetracking
Responses
200
returned object id


get/smartitems/getLocationIdFromName
Request samples
Response samples
application/json
0
0
Returns the Smart item's metadata and system fields that matches the filters passed in
Request
query Parameters
smartAppID
required
string <uuid> 
id of the smartapp


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


 
object (metadataFilterParams) 
Array of filter params


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


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


 
 Example:  take=20
projectID
string <uuid> 
Unique identifier of the project.


 
 Example:  projectID=00000000-0000-0000-0000-000000000000
Responses
200
Retuns Smart Item Field Summary


400
invalid smartappId, guid, or smart folder path


get/smartitems/GetItemsFieldData
Request samples
Response samples
application/json
[
  • {
    }
]
Returns the Smart Item and its metadata and system fields of the smart item id passsed in
Request
query Parameters
smartItemID
required
string <uuid> 
Id of the smart item


 
 Example:  smartItemID=00000000-0000-0000-0000-000000000000
object (fieldData) 
array of field data


 
Responses
200
returns Smart Item Details


400
Invalid smartItemId


post/smartitems/getsmartitem
Request samples
Response samples
application/json
{ }
deletes a smart item
Request
query Parameters
itemID
required
string <uuid> 
unique identifier of the smart item to be deleted


 
 Example:  itemID=00000000-0000-0000-0000-000000000000
Responses
200
The content was deleted


400
Invalid itemID


401
You do not have sufficient appzone api transactions to perform the action


post/smartitems/delete
Request samples
Returns the list of attachments associated with the smart items id passed in
Request
path Parameters
id
required
string <uuid> 
id of the smart item


 
 Example:  00000000-0000-0000-0000-000000000000
Responses
200
returned an array of attachments


400
Invalid smartitemId


get/smartitems/getattachments/{id}
Request samples
Response samples
application/json
[
  • { }
]
Returns the list of subitems associated with the smart item id passed in
Request
path Parameters
id
required
string <uuid> 
id of the smart item for which subitems summary is required


 
 Example:  00000000-0000-0000-0000-000000000000
Responses
200
returned array of subitems


400
Invalid smart item or smartitemId


get/smartitems/getsubitems/{id}
Request samples
Response samples
application/json
[
  • {
    }
]
Allows to add download request
Request
query Parameters
includeAttachments
required
boolean
Includes or excludes attachments


 
 Example:  includeAttachments=true
includeItemMarkups
required
boolean
includes or excludes markups


 
itemIDs
Array of integers
Array of ids (longs)


 
downloadType
required
integer
padd 1 to download as files, pass 2 to download as pdf


 Enum: 1 2  
itemUniqueIDs
Array of strings <uuid> 
Array of item unique ids (guids)


 
Responses
200
returned ID


post/downloaditem/CreateDownloadRequest
Request samples
Response samples
application/json
0
0
Allows to check the download status based on the id
Request
path Parameters
requestID
required
string <uuid> 
Id that was generated in the create download request api call


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


get/downloaditem/status/{requestID}
Request samples
Response samples
application/json
{
  • "url": "string",
  • "status": 1
}
Allows to download the content based on the requestid
Request
path Parameters
requestID
required
string <uuid> 
Id that was generated in the Create Download Request api call


 
 Example:  00000000-0000-0000-0000-000000000000
Responses
200
returned a file stream


get/downloaditem/download/{requestID}
Request samples
Allows to send email notification if user chooses to notify later
Request
query Parameters
requestID
required
string <uuid> 
Id that was generated in the Create Download Request api call


 
 Example:  requestID=00000000-0000-0000-0000-000000000000
Responses
200
success


post/downloaditem/NotifyMeLater
Request samples
➔ Next to Attachment