Class ApiResponse<T>
Type Parameters
Index
Constructors
Properties
Methods
as
Constructors
constructor
- new
Api Response<T>(statusCode, message, data): ApiResponse<T> Type Parameters
Parameters
- statusCode: number
The status code of the response.
+ - message: string
The message of the response.
+ - data: null | T
The data of the response.
+
Returns ApiResponse<T>
-
+
- A new instance of the ApiResponse class. +
- statusCode: number
Properties
data
is
is
message
message: string
status
status
Methods
as
- as
App Collection Type(): ApiResponse<CollectionResponse<App>> Returns ApiResponse<CollectionResponse<App>>
-
+
- An ApiResponse<CollectionResponse
>.
+
Method
asAppCollectionType - Converts the ApiResponse to an ApiResponse<CollectionResponse
+>. - An ApiResponse<CollectionResponse
as
- as
App Type(): ApiResponse<App> Returns ApiResponse<App>
-
+
- An ApiResponse
.
+
Method
asAppType - Converts the ApiResponse to an ApiResponse
+. - An ApiResponse
as
- as
Created With Id Response Type<T>(): ApiResponse<CreatedWithIdResponse<T>> Type Parameters
Returns ApiResponse<CreatedWithIdResponse<T>>
-
+
- An ApiResponse<CreatedWithIdResponse
>.
+
Method
asCreatedWithIdResponseType - Converts the ApiResponse to an ApiResponse<CreatedWithIdResponse
+>. - An ApiResponse<CreatedWithIdResponse
as
- as
Field Collection Type(): ApiResponse<CollectionResponse<Field>> Returns ApiResponse<CollectionResponse<Field>>
-
+
- An ApiResponse<CollectionResponse
>.
+
Method
asFieldCollectionType - Converts the ApiResponse to an ApiResponse<CollectionResponse
+>. - An ApiResponse<CollectionResponse
as
- as
Field Type(): ApiResponse<Field> Returns ApiResponse<Field>
-
+
- An ApiResponse
.
+
Method
asFieldType - Converts the ApiResponse to an ApiResponse
+. - An ApiResponse
as
- as
File Info Type(): ApiResponse<FileInfo> Returns ApiResponse<FileInfo>
-
+
- An ApiResponse
.
+
Method
asFileInfoType - Converts the ApiResponse to an ApiResponse
+. - An ApiResponse
as
- as
File Type(response): ApiResponse<File> Parameters
- response: AxiosResponse<any, any>
Returns ApiResponse<File>
-
+
- An ApiResponse
.
+
Method
asFileType - Converts the ApiResponse to an ApiResponse
+.
as
- as
Get Paged Apps Response Type(): ApiResponse<GetPagedAppsResponse> Returns ApiResponse<GetPagedAppsResponse>
-
+
- An ApiResponse
.
+
Method
asGetPagedAppsResponseType - Converts the ApiResponse to an ApiResponse
+. - An ApiResponse
as
- as
Get Paged Fields Response Type(): ApiResponse<GetPagedFieldsResponse> Returns ApiResponse<GetPagedFieldsResponse>
-
+
- An ApiResponse
.
+
Method
asGetPagedFieldsResponseType - Converts the ApiResponse to an ApiResponse
+. - An ApiResponse
as
- as
Get Paged Records Response Type(): ApiResponse<GetPagedRecordsResponse> Returns ApiResponse<GetPagedRecordsResponse>
-
+
- An ApiResponse
.
+
Method
asGetPagedRecordsResponseType - Converts the ApiResponse to an ApiResponse
+. - An ApiResponse
as
- as
Get Paged Reports Response Type(): ApiResponse<GetPagedReportsResponse> Returns ApiResponse<GetPagedReportsResponse>
-
+
- An ApiResponse
.
+
Method
asGetPagedReportsResponseType - Converts the ApiResponse to an ApiResponse
+. - An ApiResponse
as
- as
List Item Response Type(): ApiResponse<ListItemResponse> Returns ApiResponse<ListItemResponse>
-
+
- An ApiResponse
.
+
Method
asListItemResponseType - Converts the ApiResponse to an ApiResponse
+. - An ApiResponse
as
- as
Record Collection Type(): ApiResponse<CollectionResponse<Record>> Returns ApiResponse<CollectionResponse<Record>>
-
+
- An ApiResponse<CollectionResponse
>.
+
Method
asRecordCollectionType - Converts the ApiResponse to an ApiResponse<CollectionResponse
+>. - An ApiResponse<CollectionResponse
as
- as
Record Type(): ApiResponse<Record> Returns ApiResponse<Record>
-
+
- An ApiResponse
.
+
Method
asRecordType - Converts the ApiResponse to an ApiResponse
+. - An ApiResponse
as
- as
Report Data Type(): ApiResponse<ReportData> Returns ApiResponse<ReportData>
-
+
- An ApiResponse
.
+
Method
asReportDataType - Converts the ApiResponse to an ApiResponse
+. - An ApiResponse
as
- as
Save Record Response Type(): ApiResponse<SaveRecordResponse> Returns ApiResponse<SaveRecordResponse>
-
+
- An ApiResponse
.
+
Method
asSaveRecordResponseType - Converts the ApiResponse to an ApiResponse
+. - An ApiResponse
Static Private convert
- convert
To Attachment(attachmentItem): Attachment Parameters
- attachmentItem: any
The attachment item to convert.
+
Returns Attachment
-
+
- The converted attachment object. +
Method
convertToAttachment - Converts the attachment item to the appropriate attachment object.
+- attachmentItem: any
Static Private convert
Static Private convert
- convert
To Scoring Group(scoringGroupItem): ScoringGroup Parameters
- scoringGroupItem: any
The scoring group item to convert.
+
Returns ScoringGroup
-
+
- The converted scoring group object. +
Method
convertToScoringGroup - Converts the scoring group item to the appropriate scoring group object.
+- scoringGroupItem: any
Static Private convert
- convert
To Time Span Data(timeSpanItem): TimeSpanData Parameters
- timeSpanItem: any
The time span item to convert.
+
Returns TimeSpanData
-
+
- The converted time span data object. +
Method
convertToTimeSpanData - Converts the time span item to the appropriate time span data object.
+- timeSpanItem: any
Static Private get
Static Private get
Static Private get
- get
Record Value By Type(recordValueItem): RecordValue<any> Parameters
- recordValueItem: any
The record value item.
+
Returns RecordValue<any>
-
+
- The RecordValue. +
Method
getRecordValueByType - Gets the RecordValue by by type.
+- recordValueItem: any
Generated using TypeDoc
Generated using TypeDoc
Class Attachment
Attachment - Represents an attachment.
+ Index
Constructors
Properties
Constructors
constructor
- new
Attachment(fileId, fileName, notes, storageLocation): Attachment Parameters
- fileId: number
The id of the file.
+ - fileName: string
The name of the file.
+ - notes: null | string
The notes associated with the file.
+ - storageLocation: FileStorageSite
The storage location of the file.
+
Returns Attachment
-
+
- A new instance of Attachment. +
- fileId: number
Properties
file
file
file
file
notes
notes: null | string
storage
Generated using TypeDoc
Class AttachmentListRecordValue
AttachmentListRecordValue - A record value represented by a list of attachments.
+Hierarchy (view full)
- RecordValue<Attachment[]>
- AttachmentListRecordValue
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Attachment List Record Value(fieldId, value): AttachmentListRecordValue Parameters
- fieldId: number
The id of the field.
+ - value: Attachment[]
The value of the field.
+
Returns AttachmentListRecordValue
-
+
- A new instance of AttachmentListRecordValue. +
- fieldId: number
Properties
field
field
type
value
Methods
as
- as
Attachment Array(): Attachment[] Returns Attachment[]
-
+
- The value as an array of attachments. +
Method
asAttachmentArray - Gets the value as an array of attachments.
+Throws
-
+
- If the value is not an array of attachments. +
Throws
-
+
- If the storage location is not a valid FileStorageSite. +
as
as
as
as
as
- as
Scoring Group Array(): ScoringGroup[] Returns ScoringGroup[]
-
+
- The value as an array of scoring groups. +
Method
asScoringGroupArray - Gets the value as an array of scoring groups.
+Throws
-
+
- If the value is not an array of scoring groups. +
as
as
as
- as
Time Span Data(): TimeSpanData Returns TimeSpanData
-
+
- The value as a TimeSpanData object. +
Method
asTimeSpanData - Gets the value as a TimeSpanData object.
+Throws
-
+
- If the value is not a TimeSpanData object. +
Generated using TypeDoc
Class CollectionResponse<T>
CollectionResponse - A generic object for responses that contain collections of objects.
+Type Parameters
Index
Constructors
Properties
Constructors
constructor
- new
Collection Response<T>(count, items): CollectionResponse<T> Type Parameters
Parameters
- count: number
The total count of items in the collection.
+ - items: T[]
The items in the collection.
+
Returns CollectionResponse<T>
-
+
- A new instance of the CollectionResponse. +
- count: number
Properties
count
count: number
items
Generated using TypeDoc
Class CreatedWithIdResponse<T>
CreatedWithIdResponse
Type Parameters
Hierarchy (view full)
- CreatedWithIdResponse
Index
Constructors
Properties
id
+
Constructors
constructor
- new
Created With Id Response<T>(id): CreatedWithIdResponse<T> Type Parameters
Parameters
- id: T
The id of the created object.
+
Returns CreatedWithIdResponse<T>
-
+
- A new instance of the CreatedWithIdResponse class. +
- id: T
Properties
id
Generated using TypeDoc
Class DateRecordValue
DateRecordValue - A value for a date field in a record.
+Hierarchy (view full)
- RecordValue<Date>
- DateRecordValue
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Date Record Value(fieldId, value): DateRecordValue Parameters
- fieldId: number
The id of the field.
+ - value: Date
The value of the field.
+
Returns DateRecordValue
-
+
- A new instance of DateRecordValue. +
- fieldId: number
Properties
field
field
type
value
value: Date
Methods
as
- as
Attachment Array(): Attachment[] Returns Attachment[]
-
+
- The value as an array of attachments. +
Method
asAttachmentArray - Gets the value as an array of attachments.
+Throws
-
+
- If the value is not an array of attachments. +
Throws
-
+
- If the storage location is not a valid FileStorageSite. +
as
as
as
as
as
- as
Scoring Group Array(): ScoringGroup[] Returns ScoringGroup[]
-
+
- The value as an array of scoring groups. +
Method
asScoringGroupArray - Gets the value as an array of scoring groups.
+Throws
-
+
- If the value is not an array of scoring groups. +
as
as
as
- as
Time Span Data(): TimeSpanData Returns TimeSpanData
-
+
- The value as a TimeSpanData object. +
Method
asTimeSpanData - Gets the value as a TimeSpanData object.
+Throws
-
+
- If the value is not a TimeSpanData object. +
Generated using TypeDoc
Class DecimalRecordValue
DecimalRecordValue - Represents a decimal record value
+Hierarchy (view full)
- RecordValue<number>
- DecimalRecordValue
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Decimal Record Value(fieldId, value): DecimalRecordValue Parameters
- fieldId: number
The id of the field
+ - value: number
The value of the field
+
Returns DecimalRecordValue
-
+
- A new instance of DecimalRecordValue +
- fieldId: number
Properties
field
field
type
value
value: number
Methods
as
- as
Attachment Array(): Attachment[] Returns Attachment[]
-
+
- The value as an array of attachments. +
Method
asAttachmentArray - Gets the value as an array of attachments.
+Throws
-
+
- If the value is not an array of attachments. +
Throws
-
+
- If the storage location is not a valid FileStorageSite. +
as
as
as
as
as
- as
Scoring Group Array(): ScoringGroup[] Returns ScoringGroup[]
-
+
- The value as an array of scoring groups. +
Method
asScoringGroupArray - Gets the value as an array of scoring groups.
+Throws
-
+
- If the value is not an array of scoring groups. +
as
as
as
- as
Time Span Data(): TimeSpanData Returns TimeSpanData
-
+
- The value as a TimeSpanData object. +
Method
asTimeSpanData - Gets the value as a TimeSpanData object.
+Throws
-
+
- If the value is not a TimeSpanData object. +
Generated using TypeDoc
Class Delegate
Delegate - Represents a delegate.
+ Index
Constructors
Properties
Constructors
constructor
- new
Delegate(delegateType, name, emailAddress, delegationDateTime, delegationCompletedDateTime): Delegate Parameters
- delegateType: DelegateType
The type of delegate.
+ - name: null | string
The name of the delegate.
+ - emailAddress: string
The email address of the delegate.
+ - delegationDateTime: Date
The date and time the delegate was assigned.
+ - delegationCompletedDateTime: null | Date
The date and time the delegate completed the survey.
+
Returns Delegate
-
+
- A new instance of Delegate. +
- delegateType: DelegateType
Properties
delegate
delegation
delegation
delegation
delegation
email
email
name
name: null | string
Generated using TypeDoc
Class DelegateListRecordValue
DelegateListRecordValue - Represents a delegate list record value.
+Hierarchy (view full)
- RecordValue<Delegate[]>
- DelegateListRecordValue
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Delegate List Record Value(fieldId, value): DelegateListRecordValue Parameters
- fieldId: number
The id of the field.
+ - value: Delegate[]
The value of the field.
+
Returns DelegateListRecordValue
-
+
- A new instance of DelegateListRecordValue. +
- fieldId: number
Properties
field
field
type
value
Methods
as
- as
Attachment Array(): Attachment[] Returns Attachment[]
-
+
- The value as an array of attachments. +
Method
asAttachmentArray - Gets the value as an array of attachments.
+Throws
-
+
- If the value is not an array of attachments. +
Throws
-
+
- If the storage location is not a valid FileStorageSite. +
as
as
as
as
as
- as
Scoring Group Array(): ScoringGroup[] Returns ScoringGroup[]
-
+
- The value as an array of scoring groups. +
Method
asScoringGroupArray - Gets the value as an array of scoring groups.
+Throws
-
+
- If the value is not an array of scoring groups. +
as
as
as
- as
Time Span Data(): TimeSpanData Returns TimeSpanData
-
+
- The value as a TimeSpanData object. +
Method
asTimeSpanData - Gets the value as a TimeSpanData object.
+Throws
-
+
- If the value is not a TimeSpanData object. +
Generated using TypeDoc
Class EndpointFactory
EndpointFactory - A factory class for creating endpoints.
+ Index
Constructors
Methods
get
Constructors
constructor
- new
Endpoint Factory(): EndpointFactory Returns EndpointFactory
Methods
Static get
Static get
Static get
Static get
Static get
Static get
- get
Delete File By Id Endpoint(recordId, fieldId, fileId): string Parameters
- recordId: number
The id of the record.
+ - fieldId: number
The id of the field.
+ - fileId: number
The id of the file.
+
Returns string
-
+
- The delete file by id endpoint. +
Method
getDeleteFileByIdEndpoint - Gets the delete file by id endpoint.
+- recordId: number
Static get
Static get
Static get
Static get
Static get
Static get
Static get
Static get
Static get
Static get
Static get
Static get
Static get
Static get
Static get
Static get
Generated using TypeDoc
Class Field
Field - Represents a Field.
+Hierarchy (view full)
Index
Constructors
Properties
Constructors
constructor
- new
Field(id, appId, name, type, status, isRequired, isUnique): Field Parameters
- id: number
The id of the Field.
+ - appId: number
The id of the App that the Field belongs to.
+ - name: string
The name of the Field.
+ - type: FieldType
The type of the Field.
+ - status: FieldStatus
The status of the Field.
+ - isRequired: boolean
Indicates whether or not the Field is required.
+ - isUnique: boolean
Indicates whether or not the Field is required to be unique.
+
Returns Field
-
+
- A new Field. +
- id: number
Properties
app
app
id
id: number
is
is
is
is
name
name: string
status
type
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Class FileListRecordValue
FileListRecordValue - Represents a file list record value.
+Hierarchy (view full)
- RecordValue<File[]>
- FileListRecordValue
Index
Constructors
Properties
Methods
Constructors
constructor
- new
File List Record Value(fieldId, value): FileListRecordValue Parameters
- fieldId: number
The id of the field.
+ - value: File[]
The value of the field.
+
Returns FileListRecordValue
-
+
- A new instance of FileListRecordValue. +
- fieldId: number
Properties
field
field
type
value
Methods
as
- as
Attachment Array(): Attachment[] Returns Attachment[]
-
+
- The value as an array of attachments. +
Method
asAttachmentArray - Gets the value as an array of attachments.
+Throws
-
+
- If the value is not an array of attachments. +
Throws
-
+
- If the storage location is not a valid FileStorageSite. +
as
as
as
as
as
- as
Scoring Group Array(): ScoringGroup[] Returns ScoringGroup[]
-
+
- The value as an array of scoring groups. +
Method
asScoringGroupArray - Gets the value as an array of scoring groups.
+Throws
-
+
- If the value is not an array of scoring groups. +
as
as
as
- as
Time Span Data(): TimeSpanData Returns TimeSpanData
-
+
- The value as a TimeSpanData object. +
Method
asTimeSpanData - Gets the value as a TimeSpanData object.
+Throws
-
+
- If the value is not a TimeSpanData object. +
Generated using TypeDoc
Class FormulaField
FormulaField - Represents a formula field.
+Hierarchy (view full)
- Field
- FormulaField
Index
Constructors
Properties
Constructors
constructor
- new
Formula Field(id, appId, name, type, status, isRequired, isUnique, outputType, values): FormulaField Parameters
- id: number
The id of the formula field.
+ - appId: number
The id of the app the formula field belongs to.
+ - name: string
The name of the formula field.
+ - type: FieldType
The type of the formula field.
+ - status: FieldStatus
The status of the formula field.
+ - isRequired: boolean
Whether the formula field is required.
+ - isUnique: boolean
Whether the formula field is unique.
+ - outputType: FormulaOutputType
The output type of the formula field.
+ - values: ListValue[]
The list values of the formula field.
+
Returns FormulaField
-
+
- A new FormulaField. +
- id: number
Properties
app
app
id
id: number
is
is
is
is
name
name: string
output
status
type
values
Generated using TypeDoc
Class GetPagedAppsResponse
GetPagedAppsResponse - A paged response model for the GetApps method.
+Hierarchy (view full)
- PagedResponse<App>
- GetPagedAppsResponse
Index
Constructors
Properties
Constructors
constructor
- new
Get Paged Apps Response(items, pageNumber, pageSize, totalPages, totalRecords): GetPagedAppsResponse Parameters
- items: App[]
The items in the collection.
+ - pageNumber: number
The page number of the response.
+ - pageSize: number
The page size of the response.
+ - totalPages: number
The total number of pages in the response.
+ - totalRecords: number
The total number of records in the response.
+
Returns GetPagedAppsResponse
-
+
- A new instance of the GetPagedAppsResponse class. +
- items: App[]
Properties
items
page
page
page
page
total
total
total
total
Generated using TypeDoc
Class GetPagedFieldsResponse
GetPagedFieldsResponse - A response containing a paged collection of fields.
+Hierarchy (view full)
- PagedResponse<Field>
- GetPagedFieldsResponse
Index
Constructors
Properties
Constructors
constructor
- new
Get Paged Fields Response(items, pageNumber, pageSize, totalPages, totalRecords): GetPagedFieldsResponse Parameters
- items: Field[]
The items in the collection.
+ - pageNumber: number
The page number of the response.
+ - pageSize: number
The page size of the response.
+ - totalPages: number
The total number of pages in the response.
+ - totalRecords: number
The total number of records in the response.
+
Returns GetPagedFieldsResponse
-
+
- A new instance of the GetPagedAppsResponse class. +
- items: Field[]
Properties
items
page
page
page
page
total
total
total
total
Generated using TypeDoc
Class GetPagedRecordsResponse
GetPagedRecordsResponse - A response containing a paged collection of records.
+Hierarchy (view full)
- PagedResponse<Record>
- GetPagedRecordsResponse
Index
Constructors
Properties
Constructors
constructor
- new
Get Paged Records Response(items, pageNumber, pageSize, totalPages, totalRecords): GetPagedRecordsResponse Parameters
- items: Record[]
The items in the collection.
+ - pageNumber: number
The page number of the response.
+ - pageSize: number
The page size of the response.
+ - totalPages: number
The total number of pages in the response.
+ - totalRecords: number
The total number of records in the response.
+
Returns GetPagedRecordsResponse
-
+
- A new instance of the GetPagedRecordsResponse class. +
- items: Record[]
Properties
items
page
page
page
page
total
total
total
total
Generated using TypeDoc
Class GetPagedReportsResponse
GetPagedReportsResponse - Represents a response containing a paged list of reports.
+Hierarchy (view full)
- PagedResponse<Report>
- GetPagedReportsResponse
Index
Constructors
Properties
Constructors
constructor
- new
Get Paged Reports Response(items, pageNumber, pageSize, totalPages, totalRecords): GetPagedReportsResponse Parameters
- items: Report[]
The list of reports.
+ - pageNumber: number
The page number.
+ - pageSize: number
The page size.
+ - totalPages: number
The total number of pages.
+ - totalRecords: number
The total number of records.
+
Returns GetPagedReportsResponse
-
+
- A new instance of the GetPagedReportsResponse class. +
- items: Report[]
Properties
items
page
page
page
page
total
total
total
total
Generated using TypeDoc
Class GetRecordRequest
GetRecordRequest - A request to get a record.
+ Index
Constructors
Properties
Constructors
constructor
- new
Get Record Request(appId, recordId, fieldIds?, dataFormat?): GetRecordRequest Parameters
- appId: number
The id of the app that the record belongs to.
+ - recordId: number
The id of the record.
+ - fieldIds: number[] = []
The ids of the fields to include in the response.
+ - dataFormat: DataFormat = DataFormat.Raw
The format of the data in the response.
+
Returns GetRecordRequest
-
+
- A new instance of GetRecordRequest. +
- appId: number
Properties
app
app
data
field
field
record
record
Generated using TypeDoc
Class GetRecordsByAppIdRequest
GetRecordsByAppIdRequest - Represents a request to get records by app id.
+ Index
Constructors
Properties
Constructors
constructor
- new
Get Records By App Id Request(appId, fieldIds?, dataFormat?, pagingRequest?): GetRecordsByAppIdRequest Parameters
- appId: number
The id of the app that the records belong to.
+ - fieldIds: number[] = []
The ids of the fields to include in the response.
+ - dataFormat: DataFormat = DataFormat.Raw
The format of the data in the response.
+ - pagingRequest: PagingRequest = ...
The paging request.
+
Returns GetRecordsByAppIdRequest
-
+
- A new instance of GetRecordsByAppIdRequest. +
- appId: number
Properties
app
app
data
field
field
paging
Generated using TypeDoc
Class GetRecordsRequest
GetRecordsRequest - Request to get records by their ids
+ Index
Constructors
Properties
Constructors
constructor
- new
Get Records Request(appId, recordIds, fieldIds?, dataFormat?): GetRecordsRequest Parameters
- appId: number
The id of the app the records belong to.
+ - recordIds: number[]
The ids of the records to get.
+ - fieldIds: number[] = []
The ids of the fields to include in the response.
+ - dataFormat: DataFormat = DataFormat.Raw
The format of the data in the response.
+
Returns GetRecordsRequest
- appId: number
Properties
app
app
data
field
field
record
record
Generated using TypeDoc
Class GuidListRecordValue
GuidListRecordValue - Represents a guid list record value.
+Hierarchy (view full)
- RecordValue<string[]>
- GuidListRecordValue
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Guid List Record Value(fieldId, value): GuidListRecordValue Parameters
- fieldId: number
The id of the field.
+ - value: string[]
The value of the field.
+
Returns GuidListRecordValue
-
+
- A new instance of GuidListRecordValue. +
- fieldId: number
Properties
field
field
type
value
value: string[]
Methods
as
- as
Attachment Array(): Attachment[] Returns Attachment[]
-
+
- The value as an array of attachments. +
Method
asAttachmentArray - Gets the value as an array of attachments.
+Throws
-
+
- If the value is not an array of attachments. +
Throws
-
+
- If the storage location is not a valid FileStorageSite. +
as
as
as
as
as
- as
Scoring Group Array(): ScoringGroup[] Returns ScoringGroup[]
-
+
- The value as an array of scoring groups. +
Method
asScoringGroupArray - Gets the value as an array of scoring groups.
+Throws
-
+
- If the value is not an array of scoring groups. +
as
as
as
- as
Time Span Data(): TimeSpanData Returns TimeSpanData
-
+
- The value as a TimeSpanData object. +
Method
asTimeSpanData - Gets the value as a TimeSpanData object.
+Throws
-
+
- If the value is not a TimeSpanData object. +
Generated using TypeDoc
Class GuidRecordValue
GuidRecordValue - Represents a guid record value.
+Hierarchy (view full)
- RecordValue<string>
- GuidRecordValue
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Guid Record Value(fieldId, value): GuidRecordValue Parameters
- fieldId: number
The id of the field.
+ - value: string
The value of the field.
+
Returns GuidRecordValue
-
+
- A new instance of GuidRecordValue. +
- fieldId: number
Properties
field
field
type
value
value: string
Methods
as
- as
Attachment Array(): Attachment[] Returns Attachment[]
-
+
- The value as an array of attachments. +
Method
asAttachmentArray - Gets the value as an array of attachments.
+Throws
-
+
- If the value is not an array of attachments. +
Throws
-
+
- If the storage location is not a valid FileStorageSite. +
as
as
as
as
as
- as
Scoring Group Array(): ScoringGroup[] Returns ScoringGroup[]
-
+
- The value as an array of scoring groups. +
Method
asScoringGroupArray - Gets the value as an array of scoring groups.
+Throws
-
+
- If the value is not an array of scoring groups. +
as
as
as
- as
Time Span Data(): TimeSpanData Returns TimeSpanData
-
+
- The value as a TimeSpanData object. +
Method
asTimeSpanData - Gets the value as a TimeSpanData object.
+Throws
-
+
- If the value is not a TimeSpanData object. +
Generated using TypeDoc
Class IntegerListRecordValue
IntegerListRecordValue - Represents an integer list record value.
+Hierarchy (view full)
- RecordValue<number[]>
- IntegerListRecordValue
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Integer List Record Value(fieldId, value): IntegerListRecordValue Parameters
- fieldId: number
The id of the field.
+ - value: number[]
The value of the field.
+
Returns IntegerListRecordValue
-
+
- A new instance of IntegerListRecordValue. +
- fieldId: number
Properties
field
field
type
value
value: number[]
Methods
as
- as
Attachment Array(): Attachment[] Returns Attachment[]
-
+
- The value as an array of attachments. +
Method
asAttachmentArray - Gets the value as an array of attachments.
+Throws
-
+
- If the value is not an array of attachments. +
Throws
-
+
- If the storage location is not a valid FileStorageSite. +
as
as
as
as
as
- as
Scoring Group Array(): ScoringGroup[] Returns ScoringGroup[]
-
+
- The value as an array of scoring groups. +
Method
asScoringGroupArray - Gets the value as an array of scoring groups.
+Throws
-
+
- If the value is not an array of scoring groups. +
as
as
as
- as
Time Span Data(): TimeSpanData Returns TimeSpanData
-
+
- The value as a TimeSpanData object. +
Method
asTimeSpanData - Gets the value as a TimeSpanData object.
+Throws
-
+
- If the value is not a TimeSpanData object. +
Generated using TypeDoc
Class IntegerRecordValue
IntegerRecordValue - A record value represented by an integer.
+Hierarchy (view full)
- RecordValue<number>
- IntegerRecordValue
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Integer Record Value(fieldId, value): IntegerRecordValue Parameters
- fieldId: number
The id of the field.
+ - value: number
The value of the field.
+
Returns IntegerRecordValue
-
+
- A new instance of IntegerRecordValue. +
- fieldId: number
Properties
field
field
type
value
value: number
Methods
as
- as
Attachment Array(): Attachment[] Returns Attachment[]
-
+
- The value as an array of attachments. +
Method
asAttachmentArray - Gets the value as an array of attachments.
+Throws
-
+
- If the value is not an array of attachments. +
Throws
-
+
- If the storage location is not a valid FileStorageSite. +
as
as
as
as
as
- as
Scoring Group Array(): ScoringGroup[] Returns ScoringGroup[]
-
+
- The value as an array of scoring groups. +
Method
asScoringGroupArray - Gets the value as an array of scoring groups.
+Throws
-
+
- If the value is not an array of scoring groups. +
as
as
as
- as
Time Span Data(): TimeSpanData Returns TimeSpanData
-
+
- The value as a TimeSpanData object. +
Method
asTimeSpanData - Gets the value as a TimeSpanData object.
+Throws
-
+
- If the value is not a TimeSpanData object. +
Generated using TypeDoc
Class ListField
ListField - Represents a list field.
+Hierarchy (view full)
- Field
- ListField
Index
Constructors
Properties
Constructors
constructor
- new
List Field(id, appId, name, type, status, isRequired, isUnique, multiplicity, listId, values): ListField Parameters
- id: number
The id of the list field.
+ - appId: number
The id of the app the list field belongs to.
+ - name: string
The name of the list field.
+ - type: FieldType
The type of the list field.
+ - status: FieldStatus
The status of the list field.
+ - isRequired: boolean
Whether the list field is required.
+ - isUnique: boolean
Whether the list field is unique.
+ - multiplicity: Multiplicity
The multiplicity of the list field.
+ - listId: number
The id of the list the list field belongs to.
+ - values: ListValue[]
The list values of the list field.
+
Returns ListField
-
+
- A new ListField. +
- id: number
Properties
app
app
id
id: number
is
is
is
is
list
list
multiplicity
name
name: string
status
type
values
Generated using TypeDoc
Class ListItemRequest
ListItemRequest - Represents a list item request
+ Index
Constructors
Properties
Constructors
constructor
- new
List Item Request(listId, id, name, numericValue, color): ListItemRequest Parameters
- listId: number
The id for the list that the item belongs to.
+ - id: null | string
The id for the list item.
+ - name: string
The name of the list item.
+ - numericValue: null | number
The numeric value of the list item.
+ - color: null | string
The color of the list item.
+
Returns ListItemRequest
-
+
- A new instance of the ListItemRequest class. +
- listId: number
Properties
color
color: null | string
id
id: null | string
list
list
name
name: string
numeric
numeric
Generated using TypeDoc
Class ListItemResponse
ListItemResponse - Represents a respons when a list item is created or updated.
+Hierarchy (view full)
- CreatedWithIdResponse<string>
- ListItemResponse
Index
Constructors
Properties
id
+
Constructors
constructor
- new
List Item Response(id): ListItemResponse Parameters
- id: string
The id of the list item.
+
Returns ListItemResponse
-
+
- A new instance of ListItemResponse. +
- id: string
Properties
id
id: string
Generated using TypeDoc
Class ListValue
ListValue - Represents a list value.
+ Index
Constructors
Properties
Constructors
constructor
- new
List Value(id, name, sortOrder, numericValue, color): ListValue Parameters
- id: string
The id of the list value.
+ - name: string
The name of the list value.
+ - sortOrder: number
The sort order of the list value.
+ - numericValue: number
The numeric value of the list value.
+ - color: string
The color of the list value.
+
Returns ListValue
-
+
- A new ListValue. +
- id: string
Properties
color
color: string
id
id: string
name
name: string
numeric
numeric
sort
sort
Generated using TypeDoc
Class OnspringClient
OnspringClient - A client that can communicate with the Onspring API.
+ Index
Constructors
Properties
_client
+
Methods
add
Constructors
constructor
- new
Onspring Client(baseUrl, apiKey, config?): OnspringClient Parameters
- baseUrl: undefined | null | string
The base url that will be used to make requests to the Onspring API.
+ - apiKey: undefined | null | string
The api key that will be used to authorize requests made by this client.
+ - config: CreateAxiosDefaults<any> = {}
Returns OnspringClient
-
+
- A new instance of the OnspringClient class. +
Throws
-
+
- Thrown when the baseUrl is not a valid url. +
Throws
-
+
- Thrown when the apiKey is null/undefined/empty/whitespace. +
- baseUrl: undefined | null | string
Properties
Private Readonly _client
_client: AxiosInstance
client - The axios instance that will be used to make requests to the Onspring API.
+Methods
add
- add
Or Update List Item(listItemRequest): Promise<ApiResponse<ListItemResponse>> Parameters
- listItemRequest: ListItemRequest
The request that will be used to add or update the list item.
+
Returns Promise<ApiResponse<ListItemResponse>>
-
+
- A promise that resolves to an ApiResponse of type ListItemResponse. +
Method
addOrUpdateListItem - Adds or updates a list item depending on if an id is provided or not.
+- listItemRequest: ListItemRequest
can
Private delete
- delete<T>(endpoint, config?): Promise<ApiResponse<T>>
Type Parameters
Parameters
- endpoint: string
The endpoint that will be used to make the request.
+ - config: AxiosRequestConfig<any> = {}
The configuration that will be used to make the request.
+
Returns Promise<ApiResponse<T>>
-
+
- A promise that resolves to an ApiResponse of type T. +
Method
delete - Makes a DELETE request to the specified endpoint.
+- endpoint: string
delete
- delete
File By Id(recordId, fieldId, fileId): Promise<ApiResponse<any>> Parameters
- recordId: number
The id of the record that the file is held on.
+ - fieldId: number
The id of the field that the file is held in.
+ - fileId: number
The id of the file to delete.
+
Returns Promise<ApiResponse<any>>
-
+
- A promise that resolves to an ApiResponse of type any. +
Method
deleteFileById - Deletes a file by its id.
+- recordId: number
delete
- delete
List Item By Id(listId, itemId): Promise<ApiResponse<any>> Parameters
- listId: number
The id of the list that the list item belongs to.
+ - itemId: string
The id of the list item to delete.
+
Returns Promise<ApiResponse<any>>
-
+
- A promise that resolves to an ApiResponse of type any. +
Method
deleteListItemById - Deletes a list item by its id.
+- listId: number
delete
- delete
Record By Id(appId, recordId): Promise<ApiResponse<any>> Parameters
- appId: number
The id of the app that the record belongs to.
+ - recordId: number
The id of the record to delete.
+
Returns Promise<ApiResponse<any>>
-
+
- A promise that resolves to an ApiResponse of type any. +
Method
deleteRecordById - Deletes a record by its id.
+- appId: number
delete
- delete
Records By Ids(appId, recordIds): Promise<ApiResponse<any>> Parameters
- appId: number
The id of the app that the records belong to.
+ - recordIds: number[]
The ids of the records to delete.
+
Returns Promise<ApiResponse<any>>
-
+
- A promise that resolves to an ApiResponse of type any. +
Method
deleteRecordsByIds - Deletes records by their ids.
+- appId: number
Private get
- get<T>(endpoint, config?): Promise<ApiResponse<T>>
Type Parameters
Parameters
- endpoint: string
The endpoint that will be used to make the request.
+ - config: AxiosRequestConfig<any> = {}
The configuration that will be used to make the request.
+
Returns Promise<ApiResponse<T>>
-
+
- A promise that resolves to an ApiResponse of type T. +
Method
get - Makes a GET request to the specified endpoint.
+- endpoint: string
get
- get
App By Id(appId): Promise<ApiResponse<App>> Parameters
- appId: number
The id of the app to get.
+
Returns Promise<ApiResponse<App>>
-
+
- A promise that resolves to an ApiResponse of type App. +
Method
getAppById - Gets an app by its id.
+- appId: number
get
- get
Apps(pagingRequest?): Promise<ApiResponse<GetPagedAppsResponse>> Parameters
- pagingRequest: PagingRequest = ...
The paging request that will be used to get the apps.
+
Returns Promise<ApiResponse<GetPagedAppsResponse>>
-
+
- A promise that resolves to an ApiResponse of type GetPagedAppsResponse. +
Method
getApps - Gets a paged list of apps.
+- pagingRequest: PagingRequest = ...
get
- get
Apps By Ids(appIds): Promise<ApiResponse<CollectionResponse<App>>> Parameters
- appIds: number[]
The ids of the apps to get.
+
Returns Promise<ApiResponse<CollectionResponse<App>>>
-
+
- A promise that resolves to an ApiResponse of type CollectionResponse
.
+
Method
getAppsByIds - Gets a list of apps by their ids.
+- appIds: number[]
get
- get
Field By Id(fieldId): Promise<ApiResponse<Field>> Parameters
- fieldId: number
The id of the field to get.
+
Returns Promise<ApiResponse<Field>>
-
+
- A promise that resolves to an ApiResponse of type Field. +
Method
getFieldById - Gets a field by its id.
+- fieldId: number
get
- get
Fields By App Id(appId, pagingRequest?): Promise<ApiResponse<GetPagedFieldsResponse>> Parameters
- appId: number
The id of the app to get the fields for.
+ - pagingRequest: PagingRequest = ...
The paging request that will be used to get the fields.
+
Returns Promise<ApiResponse<GetPagedFieldsResponse>>
-
+
- A promise that resolves to an ApiResponse of type GetPagedFieldsResponse. +
Method
getFieldsByAppId - Gets a paged list of fields by an app id.
+- appId: number
get
- get
Fields By Ids(fieldIds): Promise<ApiResponse<CollectionResponse<Field>>> Parameters
- fieldIds: number[]
The ids of the fields to get.
+
Returns Promise<ApiResponse<CollectionResponse<Field>>>
-
+
- A promise that resolves to an ApiResponse of type CollectionResponse
.
+
Method
getFieldsByIds - Gets a list of fields by their ids.
+- fieldIds: number[]
get
- get
File By Id(recordId, fieldId, fileId): Promise<ApiResponse<File>> Parameters
- recordId: number
The id of the record that the file is attached to.
+ - fieldId: number
The id of the field that the file is attached to.
+ - fileId: number
The id of the file to get.
+
Returns Promise<ApiResponse<File>>
-
+
- A promise that resolves to an ApiResponse of type File. +
Method
getFileById - Gets a file by its id.
+- recordId: number
get
- get
File Info By Id(recordId, fieldId, fileId): Promise<ApiResponse<FileInfo>> Parameters
- recordId: number
The id of the record that the file is attached to.
+ - fieldId: number
The id of the field that the file is attached to.
+ - fileId: number
The id of the file to get the information for.
+
Returns Promise<ApiResponse<FileInfo>>
-
+
- A promise that resolves to an ApiResponse of type FileInfo. +
Method
getFileInfoById - Gets a file's information by its id.
+- recordId: number
get
- get
Record By Id(request): Promise<ApiResponse<Record>> Parameters
- request: GetRecordRequest
The request that will be used to get the record.
+
Returns Promise<ApiResponse<Record>>
-
+
- A promise that resolves to an ApiResponse of type Record. +
Method
getRecordById - Gets a record by its id.
+- request: GetRecordRequest
get
- get
Records By App Id(request): Promise<ApiResponse<GetPagedRecordsResponse>> Parameters
- request: GetRecordsByAppIdRequest
The request that will be used to get the records.
+
Returns Promise<ApiResponse<GetPagedRecordsResponse>>
-
+
- A promise that resolves to an ApiResponse of type GetPagedRecordsResponse. +
Method
getRecordsByAppId - Gets records by an app id.
+- request: GetRecordsByAppIdRequest
get
- get
Records By Ids(request): Promise<ApiResponse<CollectionResponse<Record>>> Parameters
- request: GetRecordsRequest
The request that will be used to get the records.
+
Returns Promise<ApiResponse<CollectionResponse<Record>>>
-
+
- A promise that resolves to an ApiResponse of type CollectionResponse of type Record. +
Method
getRecordsByIds - Gets records by their ids.
+- request: GetRecordsRequest
get
- get
Report By Id(reportId, apiDataFormat?, dataType?): Promise<ApiResponse<ReportData>> Parameters
- reportId: number
The id of the report to get.
+ - apiDataFormat: DataFormat = DataFormat.Raw
The data format that the report data will be returned in.
+ - dataType: ReportDataType = ReportDataType.ReportData
The type of data that will be returned.
+
Returns Promise<ApiResponse<ReportData>>
-
+
- A promise that resolves to an ApiResponse of type ReportData. +
Method
getReportById - Gets a report by its id.
+- reportId: number
get
- get
Reports By App Id(appId, pagingRequest?): Promise<ApiResponse<GetPagedReportsResponse>> Parameters
- appId: number
The id of the app to get the reports for.
+ - pagingRequest: PagingRequest = ...
The paging request that will be used to get the reports.
+
Returns Promise<ApiResponse<GetPagedReportsResponse>>
-
+
- A promise that resolves to an ApiResponse of type GetPagedReportsResponse. +
Method
getReportsByAppId - Gets a paged list of reports by the app id.
+- appId: number
Private post
- post<T>(endpoint, data, config?): Promise<ApiResponse<T>>
Type Parameters
Parameters
- endpoint: string
The endpoint that will be used to make the request.
+ - data: any
The data that will be sent with the request.
+ - config: AxiosRequestConfig<any> = {}
The configuration that will be used to make the request.
+
Returns Promise<ApiResponse<T>>
-
+
- A promise that resolves to an ApiResponse of type T. +
Method
post - Makes a POST request to the specified endpoint.
+- endpoint: string
Private put
- put<T>(endpoint, data, config?): Promise<ApiResponse<T>>
Type Parameters
Parameters
- endpoint: string
The endpoint that will be used to make the request.
+ - data: any
The data that will be sent with the request.
+ - config: AxiosRequestConfig<any> = {}
The configuration that will be used to make the request.
+
Returns Promise<ApiResponse<T>>
-
+
- A promise that resolves to an ApiResponse of type T. +
Method
put - Makes a PUT request to the specified endpoint.
+- endpoint: string
query
- query
Records(request): Promise<ApiResponse<GetPagedRecordsResponse>> Parameters
- request: QueryRecordsRequest
The request that will be used to query for records.
+
Returns Promise<ApiResponse<GetPagedRecordsResponse>>
-
+
- A promise that resolves to an ApiResponse of type GetPagedRecordsResponse. +
Method
getRecordsByQuery - Gets records by a query.
+- request: QueryRecordsRequest
save
- save
File(request): Promise<ApiResponse<CreatedWithIdResponse<number>>> Parameters
- request: SaveFileRequest
The request that will be used to save the file.
+
Returns Promise<ApiResponse<CreatedWithIdResponse<number>>>
-
+
- A promise that resolves to an ApiResponse of type CreatedWithIdResponse. +
Method
saveFile - Saves a file to a record in Onspring.
+- request: SaveFileRequest
save
- save
Record(request): Promise<ApiResponse<SaveRecordResponse>> Parameters
- request: SaveRecordRequest | Record
The record or request that will be used to save the record.
+
Returns Promise<ApiResponse<SaveRecordResponse>>
-
+
- A promise that resolves to an ApiResponse of type SaveRecordResponse. +
Method
saveRecord - Saves a record.
+- request: SaveRecordRequest | Record
Generated using TypeDoc
Class PagedResponse<T>
PagedResponse - A generic paged response model
+Type Parameters
Hierarchy (view full)
Index
Constructors
Properties
Constructors
constructor
- new
Paged Response<T>(items, pageNumber, pageSize, totalPages, totalRecords): PagedResponse<T> Type Parameters
Parameters
- items: T[]
The items in the collection.
+ - pageNumber: number
The page number of the response.
+ - pageSize: number
The page size of the response.
+ - totalPages: number
The total number of pages in the response.
+ - totalRecords: number
The total number of records in the response.
+
Returns PagedResponse<T>
-
+
- A new instance of the PagedResponse class. +
- items: T[]
Properties
items
page
page
page
page
total
total
total
total
Generated using TypeDoc
Class PagingRequest
PagingRequest - Paging request model
+ Index
Constructors
Properties
Constructors
constructor
- new
Paging Request(pageNumber, pageSize): PagingRequest Parameters
- pageNumber: number
The page number of the request. Must be greater than 0.
+ - pageSize: number
The page size of the request. Must be greater than 0 and less than 1001.
+
Returns PagingRequest
-
+
- A new instance of the PagingRequest class. +
Throws
-
+
- Thrown when the pageNumber is less than 1. +
Throws
-
+
- Thrown when the pageSize is less than 1 or greater than 1000. +
- pageNumber: number
Properties
page
page
page
page
Generated using TypeDoc
Class QueryFilter
QueryFilter - Represents a query filter.
+ Index
Constructors
constructor
- new
Query Filter(fieldId, operator, value): QueryFilter Parameters
- fieldId: number
The id of the field to filter on.
+ - operator: FilterOperators
The operator for the filter.
+ - value: null | string | number | Date
The value for the filter.
+
Returns QueryFilter
-
+
- A new instance of the QueryFilter class. +
Throws
-
+
- If the value is null and the operator is not IsNull or NotNull. +
- fieldId: number
Properties
field
field
operator
value
value: null | string | number | Date
Methods
to
Generated using TypeDoc
Class QueryRecordsRequest
QueryRecordsRequest - Request to query for records.
+ Index
Constructors
Properties
Constructors
constructor
- new
Query Records Request(appId, filter, fieldIds?, dataFormat?, pagingRequest?): QueryRecordsRequest Parameters
- appId: number
The id of the app the records belong to.
+ - filter: string | QueryFilter
The filter to use to query for records.
+ - fieldIds: number[] = []
The ids of the fields to include in the response.
+ - dataFormat: DataFormat = DataFormat.Raw
The format of the data in the response.
+ - pagingRequest: PagingRequest = ...
The paging request to use to query for records.
+
Returns QueryRecordsRequest
-
+
- A new instance of QueryRecordsRequest +
- appId: number
Properties
app
app
data
field
field
filter
paging
Generated using TypeDoc
Class Record
Record - A record in an app.
+ Index
Constructors
Properties
Methods
Constructors
constructor
- new
Record(appId, recordId, fieldData?): Record Parameters
- appId: number
The id of the app that the record belongs to.
+ - recordId: null | number
The id of the record.
+ - fieldData: RecordValue<any>[] = []
The data for the fields in the record.
+
Returns Record
-
+
- A new instance of Record. +
- appId: number
Properties
app
app
field
record
record
Methods
add
- add
Value(fieldData): void Parameters
- fieldData: RecordValue<any>
The value to add to the record.
+
Returns void
Method
addValue - Adds a value to the record.
+- fieldData: RecordValue<any>
add
- add
Values(fieldData): void Parameters
- fieldData: RecordValue<any>[]
The values to add to the record.
+
Returns void
Method
addValues - Adds values to the record.
+- fieldData: RecordValue<any>[]
convert
- convert
To Save Record Request(): SaveRecordRequest Returns SaveRecordRequest
-
+
- A SaveRecordRequest. +
Method
convertToSaveRecordRequest - Converts the record to a SaveRecordRequest.
+
Generated using TypeDoc
Class RecordValue<T>
RecordValue - A value for a field in a record.
+Type Parameters
Hierarchy (view full)
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Record Value<T>(type, fieldId, value): RecordValue<T> Type Parameters
Parameters
- type: RecordValueType
The type of the record value.
+ - fieldId: number
The id of the field.
+ - value: T
The value of the field.
+
Returns RecordValue<T>
-
+
- A new instance of RecordValue. +
- type: RecordValueType
Properties
field
field
type
value
Methods
as
- as
Attachment Array(): Attachment[] Returns Attachment[]
-
+
- The value as an array of attachments. +
Method
asAttachmentArray - Gets the value as an array of attachments.
+Throws
-
+
- If the value is not an array of attachments. +
Throws
-
+
- If the storage location is not a valid FileStorageSite. +
as
as
as
as
as
- as
Scoring Group Array(): ScoringGroup[] Returns ScoringGroup[]
-
+
- The value as an array of scoring groups. +
Method
asScoringGroupArray - Gets the value as an array of scoring groups.
+Throws
-
+
- If the value is not an array of scoring groups. +
as
as
as
- as
Time Span Data(): TimeSpanData Returns TimeSpanData
-
+
- The value as a TimeSpanData object. +
Method
asTimeSpanData - Gets the value as a TimeSpanData object.
+Throws
-
+
- If the value is not a TimeSpanData object. +
Private validate
- validate
Type(expectedTypes): void Parameters
- expectedTypes: RecordValueType[]
The expected types.
+
Returns void
Method
validateType - Validates the type of the field value.
+Throws
-
+
- If the type is not valid. +
- expectedTypes: RecordValueType[]
Generated using TypeDoc
Class ReferenceField
ReferenceField - Represents a reference field.
+Hierarchy (view full)
- Field
- ReferenceField
Index
Constructors
Properties
Constructors
constructor
- new
Reference Field(id, appId, name, type, status, isRequired, isUnique, multiplicity, referencedAppId): ReferenceField Parameters
- id: number
The id of the reference field.
+ - appId: number
The id of the app the reference field belongs to.
+ - name: string
The name of the reference field.
+ - type: FieldType
The type of the reference field.
+ - status: FieldStatus
The status of the reference field.
+ - isRequired: boolean
Whether the reference field is required.
+ - isUnique: boolean
Whether the reference field is unique.
+ - multiplicity: Multiplicity
The multiplicity of the reference field.
+ - referencedAppId: number
The id of the app the reference field references.
+
Returns ReferenceField
-
+
- A new ReferenceField. +
- id: number
Properties
app
app
id
id: number
is
is
is
is
multiplicity
name
name: string
referenced
referenced
status
type
Generated using TypeDoc
Generated using TypeDoc
Class ReportData
ReportData - Represents the data for a report.
+ Index
Constructors
Properties
Constructors
constructor
- new
Report Data(columns, rows): ReportData Parameters
- columns: string[]
The columns in the report.
+ - rows: Row[]
The rows in the report.
+
Returns ReportData
-
+
- A new instance of ReportData. +
- columns: string[]
Properties
columns
columns: string[]
rows
Generated using TypeDoc
Generated using TypeDoc
Class SaveFileRequest
SaveFileRequest - Represents a request to save a file.
+ Index
Constructors
Properties
Methods
Constructors
constructor
- new
Save File Request(recordId, fieldId, notes, modifiedDate, fileName, contentType, fileStream): SaveFileRequest Parameters
- recordId: number
The id of the record that the file will be saved to.
+ - fieldId: number
The id of the field that the file will be saved to.
+ - notes: string
The notes for the file.
+ - modifiedDate: Date
The modified date for the file.
+ - fileName: string
The name of the file.
+ - contentType: string
The content type of the file.
+ - fileStream: Readable
The file stream.
+
Returns SaveFileRequest
-
+
- A new SaveFileRequest. +
- recordId: number
Properties
content
content
field
field
file
file
file
file
modified
modified
notes
notes: string
record
record
Methods
as
Generated using TypeDoc
Class SaveRecordRequest
Index
Constructors
constructor
- new
Save Record Request(appId, recordId?, fields?): SaveRecordRequest Parameters
- appId: number
- recordId: null | number = null
- fields: Map<number, any> = ...
Returns SaveRecordRequest
Properties
app
app
fields
fields: Map<number, any>
Remarks
The key is the field id and the value is the value for the field.
+record
record
Remarks
If the record id is not provided a new record will be created. Otherwise, the existing record will be updated.
+Methods
toJSON
Generated using TypeDoc
Class SaveRecordResponse
SaveRecordResponse - Response from saving a record
+Hierarchy (view full)
- CreatedWithIdResponse<number>
- SaveRecordResponse
Index
Constructors
Properties
Constructors
constructor
- new
Save Record Response(id, warnings?): SaveRecordResponse Parameters
- id: number
The id of the record.
+ - warnings: string[] = []
The warnings from saving the record.
+
Returns SaveRecordResponse
-
+
- A new instance of SaveRecordResponse.s +
- id: number
Properties
id
id: number
warnings
warnings: string[]
Generated using TypeDoc
Class ScoringGroup
ScoringGroup - A class that represents a scoring group.
+ Index
Constructors
Properties
Constructors
constructor
- new
Scoring Group(listValueId, name, score, maximumScore): ScoringGroup Parameters
- listValueId: string
The id of the list value.
+ - name: string
The name of the scoring group.
+ - score: number
The score of the scoring group.
+ - maximumScore: number
The maximum score of the scoring group.
+
Returns ScoringGroup
-
+
- A new instance of ScoringGroup. +
- listValueId: string
Properties
list
list
maximum
maximum
name
name: string
score
score: number
Generated using TypeDoc
Class ScoringGroupListRecordValue
ScoringGroupListRecordValue - Represents a scoring group list record value.
+Hierarchy (view full)
- RecordValue<ScoringGroup[]>
- ScoringGroupListRecordValue
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Scoring Group List Record Value(fieldId, value): ScoringGroupListRecordValue Parameters
- fieldId: number
The id of the field.
+ - value: ScoringGroup[]
The value of the field.
+
Returns ScoringGroupListRecordValue
-
+
- A new instance of ScoringGroupListRecordValue. +
- fieldId: number
Properties
field
field
type
value
Methods
as
- as
Attachment Array(): Attachment[] Returns Attachment[]
-
+
- The value as an array of attachments. +
Method
asAttachmentArray - Gets the value as an array of attachments.
+Throws
-
+
- If the value is not an array of attachments. +
Throws
-
+
- If the storage location is not a valid FileStorageSite. +
as
as
as
as
as
- as
Scoring Group Array(): ScoringGroup[] Returns ScoringGroup[]
-
+
- The value as an array of scoring groups. +
Method
asScoringGroupArray - Gets the value as an array of scoring groups.
+Throws
-
+
- If the value is not an array of scoring groups. +
as
as
as
- as
Time Span Data(): TimeSpanData Returns TimeSpanData
-
+
- The value as a TimeSpanData object. +
Method
asTimeSpanData - Gets the value as a TimeSpanData object.
+Throws
-
+
- If the value is not a TimeSpanData object. +
Generated using TypeDoc
Class StringListRecordValue
StringListRecordValue - Represents a string list record value.
+Hierarchy (view full)
- RecordValue<string[]>
- StringListRecordValue
Index
Constructors
Properties
Methods
Constructors
constructor
- new
String List Record Value(fieldId, value): StringListRecordValue Parameters
- fieldId: number
The id of the field.
+ - value: string[]
The value of the field.
+
Returns StringListRecordValue
-
+
- A new instance of StringListRecordValue. +
- fieldId: number
Properties
field
field
type
value
value: string[]
Methods
as
- as
Attachment Array(): Attachment[] Returns Attachment[]
-
+
- The value as an array of attachments. +
Method
asAttachmentArray - Gets the value as an array of attachments.
+Throws
-
+
- If the value is not an array of attachments. +
Throws
-
+
- If the storage location is not a valid FileStorageSite. +
as
as
as
as
as
- as
Scoring Group Array(): ScoringGroup[] Returns ScoringGroup[]
-
+
- The value as an array of scoring groups. +
Method
asScoringGroupArray - Gets the value as an array of scoring groups.
+Throws
-
+
- If the value is not an array of scoring groups. +
as
as
as
- as
Time Span Data(): TimeSpanData Returns TimeSpanData
-
+
- The value as a TimeSpanData object. +
Method
asTimeSpanData - Gets the value as a TimeSpanData object.
+Throws
-
+
- If the value is not a TimeSpanData object. +
Generated using TypeDoc
Class StringRecordValue
StringRecordValue - A record value represented by a string.
+Hierarchy (view full)
- RecordValue<string>
- StringRecordValue
Index
Constructors
Properties
Methods
Constructors
constructor
- new
String Record Value(fieldId, value): StringRecordValue Parameters
- fieldId: number
The id of the field.
+ - value: string
The value of the field.
+
Returns StringRecordValue
-
+
- A new instance of StringRecordValue. +
- fieldId: number
Properties
field
field
type
value
value: string
Methods
as
- as
Attachment Array(): Attachment[] Returns Attachment[]
-
+
- The value as an array of attachments. +
Method
asAttachmentArray - Gets the value as an array of attachments.
+Throws
-
+
- If the value is not an array of attachments. +
Throws
-
+
- If the storage location is not a valid FileStorageSite. +
as
as
as
as
as
- as
Scoring Group Array(): ScoringGroup[] Returns ScoringGroup[]
-
+
- The value as an array of scoring groups. +
Method
asScoringGroupArray - Gets the value as an array of scoring groups.
+Throws
-
+
- If the value is not an array of scoring groups. +
as
as
as
- as
Time Span Data(): TimeSpanData Returns TimeSpanData
-
+
- The value as a TimeSpanData object. +
Method
asTimeSpanData - Gets the value as a TimeSpanData object.
+Throws
-
+
- If the value is not a TimeSpanData object. +
Generated using TypeDoc
Class TimeSpanData
Index
Constructors
Properties
Constructors
constructor
- new
Time Span Data(quantity, increment, recurrence, endAfterOccurrences, endByDate): TimeSpanData Parameters
- quantity: number
The quantity of the time span.
+ - increment: TimeSpanIncrement
The increment of the time span.
+ - recurrence: null | TimeSpanRecurrenceType
The recurrence of the time span.
+ - endAfterOccurrences: null | number
The number of occurrences of the time span.
+ - endByDate: null | Date
The end date of the time span.
+
Returns TimeSpanData
-
+
- A new instance of TimeSpanData. +
- quantity: number
Properties
end
end
end
end
increment
quantity
quantity: number
recurrence
Generated using TypeDoc
Class TimeSpanRecordValue
TimeSpanRecordValue - Represents a time span record value.
+Hierarchy (view full)
- RecordValue<TimeSpanData>
- TimeSpanRecordValue
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Time Span Record Value(fieldId, value): TimeSpanRecordValue Parameters
- fieldId: number
The id of the field.
+ - value: TimeSpanData
The value of the field.
+
Returns TimeSpanRecordValue
-
+
- A new instance of TimeSpanRecordValue. +
- fieldId: number
Properties
field
field
type
value
Methods
as
- as
Attachment Array(): Attachment[] Returns Attachment[]
-
+
- The value as an array of attachments. +
Method
asAttachmentArray - Gets the value as an array of attachments.
+Throws
-
+
- If the value is not an array of attachments. +
Throws
-
+
- If the storage location is not a valid FileStorageSite. +
as
as
as
as
as
- as
Scoring Group Array(): ScoringGroup[] Returns ScoringGroup[]
-
+
- The value as an array of scoring groups. +
Method
asScoringGroupArray - Gets the value as an array of scoring groups.
+Throws
-
+
- If the value is not an array of scoring groups. +
as
as
as
- as
Time Span Data(): TimeSpanData Returns TimeSpanData
-
+
- The value as a TimeSpanData object. +
Method
asTimeSpanData - Gets the value as a TimeSpanData object.
+Throws
-
+
- If the value is not a TimeSpanData object. +
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Enumeration FieldType
FieldType - The type of field.
+ Index
Enumeration Members
Enumeration Members
Attachment
Attachment: "Attachment"
Constant
Attachment - The field is a attachment field.
+Auto
Auto
Constant
AutoNumber - The field is a autonumber field.
+Date
Date: "Date"
Constant
Date - The field is a date field.
+Formula
Formula: "Formula"
Constant
Formula - The field is a formula field.
+Image
Image: "Image"
Constant
Image - The field is a image field.
+List
List: "List"
Constant
List - The field is a list field.
+Number
Number: "Number"
Constant
Number - The field is a number field.
+Reference
Reference: "Reference"
Constant
Reference - The field is a reference field.
+Survey
Survey
Constant
SurveyCampaign - The field is a survey campaign field.
+Survey
Survey
Constant
SurveyDelegation - The field is a survey delegation field.
+Survey
Survey
Constant
SurveyGroupScoring - The field is a survey group scoring field.
+Survey
Survey
Constant
SurveyReference - The field is a survey reference field.
+Survey
Survey
Constant
SurveyUnifiedAnswer - The field is a survey unified answer field.
+Text
Text: "Text"
Constant
Text - The field is a text field.
+Time
Time
Constant
TimeSpan - The field is a timespan field.
+Generated using TypeDoc
Enumeration FileStorageSite
FileStorageSite - The site where the file is stored.
+ Index
Enumeration Members
Enumeration Members
Google
Google
Constant
GoogleDrive - The file is stored in Google Drive.
+Internal
Internal: "Internal"
Constant
Internal - The file is stored in the internal file storage.
+One
One
Constant
OneDrive - The file is stored in OneDrive.
+Generated using TypeDoc
Enumeration FilterOperators
FilterOperators - The operators that can be used in a query filter
+Enumeration Members
And
And: "and"
Constant
And - The and operator
+Remarks
Can be used to create compound filters.
+Contains
Contains: "contains"
Constant
Contains - The contains operator
+Remarks
Can be used with list fields as well as their formula equivalents.
+Equal
Equal: "eq"
Constant
Equal - The equal operator
+Remarks
Can be used with text, auto-number, date, and number fields as well as their formula equivalents.
+Greater
Greater
Constant
GreaterThan - The greater than operator
+Remarks
Can be used with auto-number, date, and number fields as well as their formula equivalents.
+Is
Is
Constant
IsNull - The is null operator
+Remarks
Can be used with text, date, and number fields as well as their formula equivalents.
+Less
Less
Constant
LessThan - The less than operator
+Remarks
Can be used with auto-number, date, and number fields as well as their formula equivalents.
+Not
Not: "not"
Constant
Not - The not operator
+Remarks
Can be used to negate a filter and create compound filters.
+Not
Not
Constant
NotEqual - The not equal operator
+Remarks
Can be used with text, auto-number, date, and number fields as well as their formula equivalents.
+Not
Not
Constant
NotNull - The not null operator
+Remarks
Can be used with text, date, and number fields as well as their formula equivalents.
+Or
Or: "or"
Constant
Or - The or operator
+Remarks
Can be used to create compound filters.
+Generated using TypeDoc
Enumeration FormulaOutputType
FormulaOutputType - The type of the formula output.
+ Index
Enumeration Members
Enumeration Members
Date
Date
Constant
DateAndTime - The formula output is a date and time value.
+List
List
Constant
ListValue - The formula output is a list value.
+Numeric
Numeric: "Numeric"
Constant
Numeric - The formula output is a numeric value.
+Text
Text: "Text"
Constant
Text - The formula output is a text value.
+Generated using TypeDoc
Enumeration HttpStatusCode
HttpStatusCode - Enum for HTTP status codes
+ Index
Enumeration Members
Enumeration Members
Accepted
Accepted: 202
Constant
Accepted - The request was accepted for processing.
+Bad
Bad
Constant
BadGateway - The server received an invalid response from an upstream server.
+Bad
Bad
Constant
BadRequest - The request was invalid.
+Conflict
Conflict: 409
Constant
Conflict - The request could not be completed due to a conflict with the current state of the resource.
+Created
Created: 201
Constant
Created - The request was successful and a new resource was created.
+Forbidden
Forbidden: 403
Constant
Forbidden - The request included an authentication token but the token was not valid.
+Gateway
Gateway
Constant
GatewayTimeout - The server did not receive a response from an upstream server in a timely manner.
+Internal
Internal
Constant
InternalServerError - An unexpected error occurred on the server.
+Method
Method
Constant
MethodNotAllowed - The requested method is not supported for the resource.
+No
No
Constant
NoContent - The request was successful but there is no content to return.
+Not
Not
Constant
NotFound - The requested resource does not exist.
+Not
Not
Constant
NotImplemented - The requested method is not implemented.
+OK
OK: 200
Constant
OK - The request was successful.
+Service
Service
Constant
ServiceUnavailable - The server is currently unavailable.
+Unauthorized
Unauthorized: 401
Constant
Unauthorized - The request did not include an authentication token.
+Generated using TypeDoc
Enumeration Multiplicity
Multiplicity - The multiplicity type of the object.
+ Index
Enumeration Members
Enumeration Members
Multi
Multi
Constant
MultiSelect - Multi select multiplicity.
+Single
Single
Constant
SingleSelect - Single select multiplicity.
+Generated using TypeDoc
Enumeration RecordValueType
RecordValueType - The type of the record value.
+ Index
Enumeration Members
Enumeration Members
Attachment
Attachment
Constant
AttachmentList - The record value is a list of attachments.
+Date
Date: "Date"
Constant
Date - The record value is a Date.
+Decimal
Decimal: "Decimal"
Constant
Decimal - The record value is a decimal.
+Delegate
Delegate
Constant
DelegateList - The record value is a list of delegates.
+File
File
Constant
FileList - The record value is a list of files.
+Guid
Guid: "Guid"
Constant
Guid - The record value is a Guid.
+Guid
Guid
Constant
GuidList - The record value is a list of Guids.
+Integer
Integer: "Integer"
Constant
Integer - The record value is an integer.
+Integer
Integer
Constant
IntegerList - The record value is a list of integers.
+Scoring
Scoring
Constant
ScoringGroupList - The record value is a list of scoring groups.
+String
String: "String"
Constant
String - The record value is a string.
+String
String
Constant
StringList - The record value is a list of strings.
+Time
Time
Constant
TimeSpan - The record value is a TimeSpan.
+Generated using TypeDoc
Generated using TypeDoc
Enumeration TimeSpanIncrement
TimeSpanIncrement - The increment values for a time span field.
+Enumeration Members
Days
Days: "Days"
Constant
Days - The time span increment is days.
+Hours
Hours: "Hours"
Constant
Hours - The time span increment is hours.
+Minutes
Minutes: "Minutes"
Constant
Minutes - The time span increment is minutes.
+Months
Months: "Months"
Constant
Months - The time span increment is months.
+Seconds
Seconds: "Seconds"
Constant
Seconds - The time span increment is seconds.
+Weeks
Weeks: "Weeks"
Constant
Weeks - The time span increment is weeks.
+Years
Years: "Years"
Constant
Years - The time span increment is years.
+Generated using TypeDoc
Enumeration TimeSpanRecurrenceType
TimeSpanRecurrenceType - The type of recurrence for a time span.
+ Index
Enumeration Members
Enumeration Members
End
End
Constant
EndAfterOccurrences - The time span recurs for a specific number of occurrences.
+End
End
Constant
EndByDate - The time span recurs until a specific date.
+None
None: "None"
Constant
None - The time span does not recur.
+Generated using TypeDoc
Generated using TypeDoc
onspring-api-sdk
Onspring API Javascript SDK
+
+
+
The Javascript SDK for the Onspring API is meant to simplify development in Javascript for Onspring customers who want to build integrations with their Onspring instance.
+Note: This is an unofficial SDK for the Onspring API. It was not built in consultation with Onspring Technologies LLC or a member of their development team.
+This SDK was developed independently using Onspring's existing C# SDK, the Onspring API's swagger page, and api documentation as the starting point with the intention of making development of integrations done in Javascript with an Onspring instance quicker and more convenient.
+🛠️ Dependencies
Node.js
Requires use of Node.js 14.x or later.
+Axios
All methods for the OnspringClient make use of the Axios http client to interact with the Onspring API.
Form-Data
When it is necessary to send requests to the Onspring API using multi-part/form-data the Form-Data package is used.
💾 Installation
Install the SDK using npm:
+npm install onspring-api-sdk
🔑 API Key
In order to successfully interact with the Onspring Api you will need an API key. API keys are obtained by an Onspring user with permissions to at least Read API Keys for your instance via the following steps:
+-
+
- Login to the Onspring instance. +
- Navigate to Administration > Security > API Keys +
- On the list page, add a new API Key - this will require Create permissions - or click an existing API key to view its details. +
- Click on the Developer Information tab. +
- Copy the X-ApiKey Header value from this tab. +
Important:
+-
+
- An API Key must have a status of
Enabledin order to make authorized requests.
+ - Each API Key must have an assigned Role. This role controls the permissions for requests made. If the API Key used does not have sufficient permissions the requests made won't be successful. +
🔒 Permission Considerations
You can think of any API Key as another user in your Onspring instance and therefore it is subject to all the same permission considerations as any other user when it comes to its ability to access data in your instance. The API Key you use needs to have all the correct permissions within your instance to access the data requested. Things to think about in this context are role security, content security, and field security.
🧑🏻💻 Start Coding
OnspringClient
The most common way to use the SDK is to create an OnspringClient instance and call its methods. Its constructor requires two parameters:
-
+
baseUrl- currently this should always be:https://api.onspring.com
+apiKey- the value obtained by following the steps in the API Key section
+
It is best practice to read these values in from a configuration file for both flexibility and security purposes.
+Example .env file:
API_KEY=000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000
+BASE_URL=https://api.onspring.com
+Example constructing OnspringClient:
CommonJS
const { OnspringClient } = require('onspring-api-sdk');
const dotenv = require('dotenv');
dotenv.config();
const client = new OnspringClient(process.env.BASE_URL, process.env.API_KEY);
+ES Module
import dotenv from 'dotenv';
import { OnspringClient } from 'onspring-api-sdk';
dotenv.config();
const client = new OnspringClient(process.env.BASE_URL, process.env.API_KEY);
+Axios Instance Configuration
By default when you construct an instance of the OnspringClient a new Axios instance will also be created. Its baseURL property will always be set to the baseUrl parameter based to the OnspringClient's constructor and its headers will always contain the proper x-api-key header.
You can though pass a third optional argument to the OnspringClient constructor that specifies additional configuration options for the Axios instance used to make requests.
import dotenv from 'dotenv';
import { OnspringClient } from 'onspring-api-sdk';
dotenv.config();
const configs = {
timeout: 5000,
};
const client = new OnspringClient(
process.env.BASE_URL,
process.env.API_KEY,
configs
);
+ApiResponse
Each OnspringClient method - aside from canConnect - returns an ApiResponse object which will have the following properties:
-
+
statusCode- The http status code of the response.
+isSuccessful- Indicates whether the request succeeded.
+data- If the request was successful will contain the response data deserialized to custom classes.
+message- A message that may provide more detail about the request when no successful
+
CommonJS or ES Modules
There is support for using either CommonJS or ES Modules depending upon your preference. This documentation will use the later in the usage examples.
+Types
The package is written in typescript and all types are exported and available for you to use.
+Full API Documentation
You may wish to refer to the full Onspring API documentation when determining which values to pass as parameters to some of the OnspringClient methods. There is also a swagger page that you can use for making exploratory requests.
📋 Examples
Note the following code snippets assume you've already instantiated an OnspringClient as shown in the OnspringClient section.
Connectivity
Verify connectivity
const res = await client.canConnect();
console.log(res); // true or false
+Apps
Get Apps
Returns a paged collection of apps and/or surveys that can be paged through. By default the page size is 50 and page number is 1.
+const res = await client.getApps();
const apps = res.data.items;
for (const app of apps) {
console.log(app);
}
+You can set your own page size and page number (max is 1,000) as well.
+import { PagingRequest } from 'onspring-api-sdk';
const res = await client.getApps(new PagingRequest(1, 1));
const apps = res.data.items;
for (const app of apps) {
console.log(app);
}
+Get App By Id
Returns an Onspring app or survey according to provided id.
+const res = await client.getAppById(130);
const app = res.data;
console.log(app);
+Get Apps By Ids
Returns a collection of Onspring apps and/or surveys according to provided ids.
+const res = await client.getAppsByIds([130, 131]);
const apps = res.data.items;
for (const app of apps) {
console.log(app);
}
+Fields
Get Field By Id
Returns an Onspring field according to provided id.
+const res = await client.getFieldById(4793);
const field = res.data;
console.log(field);
+Get Fields By Ids
Returns a collection of Onspring fields according to provided ids.
+const res = await client.getFieldsByIds([4793, 4801]);
const fields = res.data.items;
for (const field of fields) {
console.log(field);
}
+Get Fields By App Id
Returns a paged collection of fields that can be paged through. By default the page size is 50 and page number is 1.
+const res = await client.getFieldsByAppId(132);
const fields = res.data.items;
for (const field of fields) {
console.log(field);
}
+You can set your own page size and page number (max is 1,000) as well.
+import { PagingRequest } from 'onspring-api-sdk';
const res = await client.getFieldsByAppId(132, new PagingRequest(1, 1));
const fields = res.data.items;
for (const field of fields) {
console.log(field);
}
+Files
Get File Info By Id
Returns the Onspring file's metadata.
+const res = await client.getFileInfoById(1, 4806, 909);
const fileInfo = res.data;
console.log(fileInfo);
+Get File By Id
Returns the file itself.
+import fs from 'fs';
const res = await client.getFileById(1, 4806, 909);
const file = res.data;
console.log(file.contentLength);
console.log(file.contentType);
console.log(file.fileName);
file.stream.pipe(fs.createWriteStream(file.fileName));
+Save File
import fs from 'fs';
import { SaveFileRequest } from 'onspring-api-sdk';
const request = new SaveFileRequest(
1,
4806,
'notes',
new Date(),
'test-attachment.txt',
'text/plain',
fs.createReadStream('test-attachment.txt')
);
const res = await client.saveFile(request);
const fileId = res.data.id;
console.log(fileId);
+Delete File By Id
const res = await client.deleteFileById(1, 4806, 1505);
res.statusCode === 204
? console.log('File deleted')
: console.log('Error deleting file');
+Lists
Add Or Update List Value
To add a list value don't provide an id value.
+import { ListItemRequest } from 'onspring-api-sdk';
const request = new ListItemRequest(638, null, 'New Value', 1, '#000000');
const res = await client.addOrUpdateListItem(request);
const itemId = res.data.id;
console.log(itemId);
+To update a list value provide an id value.
+import { ListItemRequest } from 'onspring-api-sdk';
const request = new ListItemRequest(
638,
'35c79a46-04b8-4069-bbc1-161a175f962c',
'Updated Value',
1,
'#000000'
);
const res = await client.addOrUpdateListItem(request);
const itemId = res.data.id;
console.log(itemId);
+Delete List Value
const res = await client.deleteListItemById(
638,
'35c79a46-04b8-4069-bbc1-161a175f962c'
);
res.statusCode === 204
? console.log('List item deleted')
: console.log('Error deleting list item');
+Records
Get Records By App Id
Returns a paged collection of records that can be paged through. By default the page size is 50 and page number is 1.
+import { GetRecordsByAppIdRequest } from 'onspring-api-sdk';
const request = new GetRecordsByAppIdRequest(130);
const res = await client.getRecordsByAppId(request);
const records = res.data.items;
for (const record of records) {
console.log(record);
}
+You can set your own page size and page number (max is 1,000) as well. In addition to specifying what field values to return and in what format (Raw vs. Formatted) to return them.
+import {
DataFormat,
GetRecordsByAppIdRequest,
PagingRequest,
} from 'onspring-api-sdk';
const request = new GetRecordsByAppIdRequest(
130,
[4804],
DataFormat.Raw,
new PagingRequest(1, 1)
);
const res = await client.getRecordsByAppId(request);
const records = res.data.items;
for (const record of records) {
console.log(record);
}
+Get Record By Id
Returns an onspring record based on the provided app and record ids.
+import { GetRecordRequest } from 'onspring-api-sdk';
const request = new GetRecordRequest(130, 1);
const res = await client.getRecordById(request);
const record = res.data;
console.log(record);
+You can also specify what field values to return and in what format (Raw vs. Formatted) to return them.
+import { DataFormat, GetRecordRequest } from 'onspring-api-sdk';
const request = new GetRecordRequest(130, 1, [4804], DataFormat.Raw);
const res = await client.getRecordById(request);
const record = res.data;
console.log(record);
+Get Records By Ids
Returns a collection of Onspring records based on the provided appId and recordIds.
+import { GetRecordsRequest } from 'onspring-api-sdk';
const request = new GetRecordsRequest(130, [1]);
const res = await client.getRecordsByIds(request);
const records = res.data.items;
for (const record of records) {
console.log(record);
}
+You can also specify what field values to return and in what format (Raw vs. Formatted) to return them.
+import { DataFormat, GetRecordsRequest } from 'onspring-api-sdk';
const request = new GetRecordsRequest(130, [1], [4804], DataFormat.Formatted);
const res = await client.getRecordsByIds(request);
const records = res.data.items;
for (const record of records) {
console.log(record);
}
+Query Records
Returns a paged collection of records based on a criteria that can be paged through. By default the page size is 50 and page number is 1.
+import {
FilterOperators,
QueryFilter,
QueryRecordsRequest,
} from 'onspring-api-sdk';
const filter = new QueryFilter(4745, FilterOperators.GreaterThan, 0);
const request = new QueryRecordsRequest(130, filter);
const res = await client.queryRecords(request);
const records = res.data.items;
for (const record of records) {
console.log(record);
}
+You can set your own page size and page number (max is 1,000) as well. In addition to specifying what field values to return and in what format (Raw vs. Formatted) to return them.
+import {
DataFormat,
FilterOperators,
PagingRequest,
QueryFilter,
QueryRecordsRequest,
} from 'onspring-api-sdk';
const filter = new QueryFilter(4745, FilterOperators.GreaterThan, 0);
const request = new QueryRecordsRequest(
130,
filter,
[4804],
DataFormat.Formatted,
new PagingRequest(1, 1)
);
const res = await client.queryRecords(request);
const records = res.data.items;
for (const record of records) {
console.log(record);
}
+For further details on constructing the filter parameter please refer to the documentation for the Onspring API.
Add or Update A Record
You can add a record by not providing a record id value. If successful will return the id of the added record.
+import { Record, StringRecordValue } from 'onspring-api-sdk';
const record = new Record(130, null);
const fieldValue = new StringRecordValue(4804, 'Test');
record.addValue(fieldValue);
const res = await client.saveRecord(record);
const newRecordId = res.data.id;
console.log(newRecordId);
+You can update a record by providing its id. If successful will return the id of record updated.
+import { Record, StringRecordValue } from 'onspring-api-sdk';
const record = new Record(130, 607);
const fieldValue = new StringRecordValue(4804, 'Updated');
record.addValue(fieldValue);
const res = await client.saveRecord(record);
const updatedRecordId = res.data.id;
console.log(updatedRecordId);
+Delete Record By Id
Delete an individual record based upon its id.
+const res = await client.deleteRecordById(130, 607);
res.statusCode === 204
? console.log('Record deleted')
: console.log('Error deleting record');
+Delete Records By Ids
Delete a batch of records based upon their ids.
+const res = await client.deleteRecordsByIds(130, [608, 609]);
res.statusCode === 204
? console.log('Records deleted')
: console.log('Error deleting records');
+Reports
Get Report By Id
Returns the report for the provided id.
+const res = await client.getReportById(408);
const report = res.data;
console.log(report);
+You can also specify the format of the data in the report as well as whether you are requesting the report's data or its chart data.
+import { DataFormat, ReportDataType } from 'onspring-api-sdk';
const res = await client.getReportById(
409,
DataFormat.Formatted,
ReportDataType.ChartData
);
const report = res.data;
console.log(report);
+Get Reports By App Id
Returns a paged collection of reports that can be paged through. By default the page size is 50 and page number is 1.
+const res = await client.getReportsByAppId(130);
const reports = res.data.items;
for (const report of reports) {
console.log(report);
}
+You can set your own page size and page number (max is 1,000) as well.
+import { PagingRequest } from 'onspring-api-sdk';
const res = await client.getReportsByAppId(130, new PagingRequest(1, 1));
const reports = res.data.items;
for (const report of reports) {
console.log(report);
}
+Generated using TypeDoc
onspring-api-sdk
Index
Enumerations
Classes
Api
Generated using TypeDoc
ApiResponse - A generic response object for API requests.
+