Skip to main content
Version: v4.5

FileItem

A FileItem is a RelatedItem sub-type. It represents a file in the Item Service and points to the source file in the File Service.

A FileItem has the same characteristics as a RelatedItem but also has "fileId" and "_fileVersionId" properties:

{  "_id": "f3e36c5e-5d9f-4d5d-a692-b25ce180438b",  "_fileId": "c997e41f-d937-4722-a588-ee86262879bc",  "_fileVersionId": "t787e41f-d937-4722-a588-ee86262879ju"}
ParameterTypeDescriptionRequired
_idStringThe RelatedItem's IDRequired
_fileIdStringThe source file's ID. The source files are stored in the file service.Required
_fileVersionIdStringThe ID of the specific version.Required

Custom properties#

Like a RelatedItem, you can add your own properties:

{  "_id": "f3e36c5e-5d9f-4d5d-a692-b25ce180438b",  "_fileId": "c997e41f-d937-4722-a588-ee86262879bc",  "_fileVersionId": "t787e41f-d937-4722-a588-ee86262879ju",   "name": "your file’s name",  // Custom property  "description": "a description of your file" // Custom property}

Collections#

Group FileItems in a NamedFileCollection. When your FileItems are in a collection, you can create relationships between them and items in the same or other collection.

Schema#

For more information on the FileItem type and its properties, see the FileItem schema.

API#

You can create and manage FileItems using the IafItemSvc JavaScript Platform API or the Item Service REST API.