AssetFormTypes

APIDescription
GET AssetFormTypes?assetId={assetId}&formTypeId={formTypeId}

Retrives asset form types for the given parameters. All parameters are optional. Asset form types represent a particular asset's overrides of the form types of its asset type.

GET AssetFormTypes?assetId={assetId}

Retrieves all asset form types for the given asset. This includes asset form types of that asset that may not have a value.

GET AssetFormTypes?assetFormTypeId={assetFormTypeId}

Retrieves an asset form type by its Id.

PUT AssetFormTypes

Updates an asset form type.

AssetGroups

APIDescription
GET AssetGroups?parentGroupId={parentGroupId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}

Retrieves asset groups for the given parameters. All parameters are optional.

GET AssetGroups?assetGroupId={assetGroupId}

Retrieves an asset group by its Id.

POST AssetGroups

Creates a new group.

PUT AssetGroups

Updates the given group.

DELETE AssetGroups

Deletes the given group, including its assets.

AssetMeasurementTypes

APIDescription
GET AssetMeasurementTypes?assetId={assetId}&measurementTypeId={measurementTypeId}

Retrives asset measurement types for the given parameters. All parameters are optional. Asset measurement types represent a particular asset's overrides of the measurement types of its asset type.

GET AssetMeasurementTypes?assetId={assetId}

Retrieves all asset measurement types for the given asset. This includes asset measurement types of that asset that may not have a value.

GET AssetMeasurementTypes?assetMeasurementTypeId={assetMeasurementTypeId}

Retrieves an asset measurement type by its Id.

PUT AssetMeasurementTypes

Updates an asset measurement type.

Assets

APIDescription
PUT Assets/UpdateLocation

Updates the given asset's location.

PUT Assets/UpdateBarcode

Updates the given asset's barcode.

GET Assets?assetTypeId={assetTypeId}&assetGroupId={assetGroupId}&parentAssetId={parentAssetId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}

Retrieves the assets for the given parameters. All parameters are optional.

GET Assets?assetId={assetId}&includeAllAncestors={includeAllAncestors}

Retrieves an asset by its Id.

POST Assets

Creates a new asset.

PUT Assets

Updates the given asset.

DELETE Assets

Deletes the given asset.

AssetTypes

APIDescription
GET AssetTypes?take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}

Retrieves asset types for the given parameters. All parameters are optional.

GET AssetTypes?assetTypeId={assetTypeId}

Retrieves an asset type by its Id.

POST AssetTypes

Creates a new asset type.

PUT AssetTypes

Updates the given asset type.

DELETE AssetTypes

Deletes the given asset type, including all assets of that type.

Attachments

APIDescription
GET Attachments/GetFile?attachmentId={attachmentId}

Retrieves a file stream of an attachment's content.

GET Attachments/GetContent?attachmentId={attachmentId}&startIndex={startIndex}&chunkSize={chunkSize}

Retrieves a specified chunk of an attachment's content.

GET Attachments/ByUploadDate?assetId={assetId}&beginDate={beginDate}&endDate={endDate}

Retrieves attachments for the given parameters. All parameters are optional.

GET Attachments/ByLastModifiedDate?assetId={assetId}&beginDate={beginDate}&endDate={endDate}

Retrieves attachments for the given parameters. All parameters are optional.

GET Attachments?assetId={assetId}&includeContent={includeContent}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}

Retrieves the attachments for the given parameters. All parameters are optional.

GET Attachments?attachmentId={attachmentId}

Retrieves an attachment by its Id.

POST Attachments

Creates a new attachment.

PUT Attachments

Updates the given attachment. Only the Name and Description of the attachment may be updated.

DELETE Attachments

Deletes the given attachment.

DataTypes

APIDescription
GET DataTypes

Retrieves Greyswift's data types. These are read-only.

GET DataTypes?dataTypeId={dataTypeId}

Retrieves a data type by its Id.

Events

APIDescription
GET Events?eventTypeId={eventTypeId}&startDate={startDate}&endDate={endDate}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}

Retrieves the events for the given parameters. All parameters are optional.

GET Events?eventId={eventId}

Retrieves an event by its Id.

POST Events

Creates a new event.

PUT Events

Updates the given event.

DELETE Events

Deletes the given event.

EventTypes

APIDescription
GET EventTypes?take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}

Retrieves event types for the given parameters. All parameters are optional.

GET EventTypes?eventTypeId={eventTypeId}

Retrieves an event type by its Id.

POST EventTypes

Creates a new event type.

PUT EventTypes

Updates the given event type.

DELETE EventTypes

Deletes the given event type, including all events of that type.

Forms

APIDescription
GET Forms/GetFile?formFieldValueId={formFieldValueId}&maxWidth={maxWidth}&maxHeight={maxHeight}

Retrieves a file stream of a form field value's attachment content.

GET Forms/GetContent?formFieldValueId={formFieldValueId}&startIndex={startIndex}&chunkSize={chunkSize}

Retrieves a specified chunk of an attachment form field value's content

GET Forms/ByEffectiveDate?assetId={assetId}&formTypeId={formTypeId}&beginDate={beginDate}&endDate={endDate}

Retrieves forms for the given parameters. All parameters are optional.

GET Forms/ByLastModifiedDate?assetId={assetId}&formTypeId={formTypeId}&beginDate={beginDate}&endDate={endDate}

Retrieves forms for the given parameters. All parameters are optional.

GET Forms?assetId={assetId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}&includeAttachmentContent={includeAttachmentContent}

Retrieves forms for the given parameters. All parameters are optional.

GET Forms?formId={formId}

Retrieves a form by its Id.

POST Forms

Creates a new form.

PUT Forms

Updates the given form.

DELETE Forms

Deletes the given form.

FormTypes

APIDescription
PUT FormTypes/UpdateValueNeededDate

Updates the given form types's value needed date.

GET FormTypes?assetTypeId={assetTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}

Retrieves form types for the given parameters. All parameters are optional.

GET FormTypes?formTypeId={formTypeId}

Retrieves an form type by its Id.

POST FormTypes

Creates a new form type.

PUT FormTypes

Updates the given form type.

DELETE FormTypes

Deletes the given form type, including all forms of that type.

Measurements

APIDescription
GET Measurements/ByEffectiveDate?assetId={assetId}&measurementTypeId={measurementTypeId}&beginDate={beginDate}&endDate={endDate}

Retrieves measurements for the given parameters. All parameters are optional.

GET Measurements/ByLastModifiedDate?assetId={assetId}&measurementTypeId={measurementTypeId}&beginDate={beginDate}&endDate={endDate}

Retrieves measurements for the given parameters. All parameters are optional.

GET Measurements?assetId={assetId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}

Retrieves measurements for the given parameters. All parameters are optional.

GET Measurements?measurementId={measurementId}

Retrieves a measurement by its Id.

POST Measurements

Creates a new measurement.

PUT Measurements

Updates the given measurement.

DELETE Measurements

Deletes the given measurement.

MeasurementTypes

APIDescription
PUT MeasurementTypes/UpdateValueNeededDate

Updates the given measurement types's value needed date.

GET MeasurementTypes?assetTypeId={assetTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}

Retrieves the measurement types for the given parameters. All parameters are optional.

GET MeasurementTypes?measurementTypeId={measurementTypeId}

Retrieves a measurement type by its Id.

POST MeasurementTypes

Creates a new measurement type.

PUT MeasurementTypes

Updates the given measurement type.

DELETE MeasurementTypes

Deletes the given measurement type. This will also delete any measurements of that type.

Notes

APIDescription
GET Notes/ByEffectiveDate?assetId={assetId}&beginDate={beginDate}&endDate={endDate}

Retrieves notes for the given parameters. All parameters are optional.

GET Notes/ByLastModifiedDate?assetId={assetId}&beginDate={beginDate}&endDate={endDate}

Retrieves notes for the given parameters. All parameters are optional.

GET Notes?assetId={assetId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}

Retrieves the notes for the given parameters. All parameters are optional.

GET Notes?noteId={noteId}

Retrieves a note by its Id

POST Notes

Creates a new note.

PUT Notes

Updates the given note.

DELETE Notes

Deletes the given note.

Profiles

APIDescription
GET Profiles?take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}

Retrieves the profiles for the given parameters. All parameters are optional.

GET Profiles?profileId={profileId}

Retrieves a profile by its Id.

POST Profiles

Creates a new profile.

PUT Profiles

Updates the given profile.

DELETE Profiles

Deletes the given profile.

Properties

APIDescription
GET Properties?assetId={assetId}&propertyTypeId={propertyTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}

Retrieves properties for the given parameters. This will only retrieve properties that have a value. All parameters are optional.

GET Properties?assetId={assetId}

Retrieves all properties for the given asset. This includes properties of that asset that may not have a value.

GET Properties?propertyId={propertyId}

Retrieves a property by its Id.

POST Properties

Creates a new property.

PUT Properties

Updates the given property.

DELETE Properties

Deletes the given property.

PropertyTypes

APIDescription
GET PropertyTypes?assetTypeId={assetTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}

Retrieves property types for the given parameters.

GET PropertyTypes?propertyTypeId={propertyTypeId}

Retrieves a property type by its Id.

POST PropertyTypes

Creates a new property type.

PUT PropertyTypes

Updates the given property type.

DELETE PropertyTypes

Deletes the given property type, including all properties of that type.

Units

APIDescription
GET Units?take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}

Retrieves units for the given parameters. All parameters are optional.

GET Units?unitId={unitId}

Retrieves a unit by its Id.

POST Units

Creates a unit.

PUT Units

Updates the given unit.

DELETE Units

Deletes the given unit. This will not delete property types or measurement types that use this unit.

Users

APIDescription
GET Users?take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}

Retrieves the users for the given parameters. All parameters are optional.

GET Users?userId={userId}

Retrieves a user by their Id.

POST Users

Creates a new user.

PUT Users

Updates the given user.

DELETE Users

Deletes the given user. The user to delete cannot be in the Administrator or Owner role. Also, the user making this request cannot delete their own account.