Properties

Type/Properties:

Type Properties {..}
ActionDto

"ObjectGuid": "Guid" ,
"Name": "string" ,
"Configuration": [ IDictionary ],
"Type": "string" ,
"Description": "string" ,
"Rank": "number"

activity

"caption": "string" ,
"clientObjectGuid": "Guid" ,
"entityId": "string" ,
"entityName": "string" ,
"entityType": "string" ,
"activityDataId": number ,
"languageCode": "string" ,
"options": [ activityOption ],
"selectedOption": "string" ,
"shortText": "string" ,
"text": "string" ,
"itemDataId": number ,
"formObjectGuid": "Guid"

ActivityInputType

None=0
TextBox=1
TextArea=2
TextBoxPassword=3
Date=4
DateTime=5
DropDownList=6
DynamicDropDownList=7

activityListItem

"activityDataId": number ,
"itemDataId": number ,
"entityId": number ,
"entityType": "string" ,
"clientId": "Guid" ,
"entityFrontendId": "string" ,
"objectGuid": "Guid" ,
"properties": [ IDictionary ]

activityOption

"argument": "string" ,
"caption": "string" ,
"inputType": ActivityInputType ,
"requiresInput": "boolean" ,
"isDefault": "boolean" ,
"items": [ KeyValuePair ],
"defaultItem": "string" ,
"inputLabel": "string"

AddCiToTicketModel "ObjectGuid": "Guid"

AddFileToTicketModel

"OriginalFileName": "string" ,
"MimeType": "string" ,
"ContentBase64": "string" ,
"Comment": "string" ,
"TicketFileType": TicketFileType

BaseEntityDto

"DataId": Int64,
"CreatedDateTime": "yyyy-MM-ddTHH:mm:ss.fff",
"CreatorGroupObjectGuid": "Guid",
"CreatorUserObjectGuid": "Guid",
"TimeZone": "string",
"IsDeleted": boolean,
"Longitude": Double,
"Latitude": Double,
"ObjectTypeObjectGuid": "Guid",
"ObjectDataId": number

CiAttributeDto

"SchemeDataId": number ,
"ObjectGuid": "Guid" ,
"IsDeleted": "boolean" ,
"SchemeAttributeDataId": number ,
"Name": "string" ,
"FriendlyName": "string" ,
"CiDataId": number ,
"DataId": number ,
"Value": "string" ,
"Text": "string"

CiCommentDto

"DataId": number ,
"CiObjectGuid": "Guid" ,
"UserObjectGuid": "Guid" ,
"Comment": "string" ,
"TimeStamp": "IsoDateTime"

CiDto

"ObjectGuid": "Guid" ,
"DataId": number ,
"VisibleId": "string" ,
"CiTitle": "string" ,
"UniqueId": "string" ,
"SchemaObjectGuid": "Guid" ,
"SchemeTypeObjectGuid": "Guid" ,
"CreatedDateTime": "DateTime" ,
"CreatorUserObjectGuid": "Guid" ,
"OwnerGroupObjectGuid": "Guid" ,
"StateObjectGuid": "Guid"

CiImportDto

"DataId": number,
"ObjectGuid": "Guid",
"Name": "string",
"Type": "string",
"Description": "string",
"IsActive": boolean,
"State": "string",
"NextRun": "yyyy-MM-ddTHH:mm:ss.fff",
"LastRun": "yyyy-MM-ddTHH:mm:ss.fff",
"LastCompleted": "yyyy-MM-ddTHH:mm:ss.fff",
"LastFailed": "yyyy-MM-ddTHH:mm:ss.fff",
"LastExecution": LastExecuted

CiLifeCycleStateDto

"DataId": number ,
"Name": "string" ,
"LifeCycleObjectGuid": "Guid" ,
"IsDeleted": "boolean" ,
"FriendlyName": "string" ,
"ObjectGuid": "Guid"

CiRelationDto

"DataId": number ,
"RelationTypeDataId": number ,
"CiDataId": number ,
"ConnectedCiDataId": number

CiRelationTypeDto

"DataId": number ,
"ObjectGuid": "Guid" ,
"FriendlyName": "string" ,
"Description": "string" ,
"Name": "string" ,
"ChildName": "string" ,
"IsDeleted": "boolean" ,
"HasDirection": "boolean" ,
"LinkCiBehavior": "string" ,
"MoveCiBehavior": "string"

CiSchemeAttributeDto

"DataId": number ,
"IsDeleted": "boolean" ,
"ObjectGuid": "Guid" ,
"SchemeDataId": number ,
"DefaultValue": "string" ,
"FormatString": "string" ,
"FriendlyName": "string" ,
"Name": "string"

CiSchemeAttributeGroupDto

"DataId": number,
"ObjectGuid": "Guid",
"FriendlyName": "string",
"SchemeDataId": number,
"IsDefault": boolean,
"SortIndex": number,
"Deleted": "yyyy-MM-ddTHH:mm:ss.fff" nullable,
"Attributes": [ CiSchemeAttributeAttributeGroupDto ]

CiSchemeAttributeAttributeGroupDto

"DataId": number,
"ObjectGuid": "Guid",
"SchemeAttributeGroupDataId": number,
"SchemeAttributeDataId": number,
"SortIndex": number,
"ColumnIndex": number,
"Deleted": "yyyy-MM-ddTHH:mm:ss.fff" nullable,
"Name": "string"

CiSchemeDto

"DataId": number ,
"Description": "string" ,
"FriendlyName": "string" ,
"IsDeleted": "boolean" ,
"IdPattern": "string" ,
"DefaultAffectedUserDataId": number ,
"DefaultSupplierUserDataId": number ,
"Name": "string"

CiZoneDto

"ObjectGuid": "Guid",
"SchemeObjectGuid": "Guid",
"FriendlyName": "string",
"Name": "string",
"Description": "string",
"ParentZoneDataId": number,
"ParentZoneObjectGuid": "Guid",
"DefaultAffectedPrincipalDataId": number,
"DefaultAffectedPrincipalObjectGuid": "Guid",
"DefaultSupplierUserDataId": number,
"DefaultSupplierUserObjectGuid": "Guid",
"ZoneType": ZoneType,
"ImportObjectGuid": "Guid",
"ImportDataId": number,
"ZoneSchemeOrderId": number,
"CiCount": number,
"Changed": "yyyy-MM-ddTHH:mm:ss.fff",
"Created": "yyyy-MM-ddTHH:mm:ss.fff",
"MinCiCount": number,
"MaxCiCount": number,
"WorkflowObjectGuidMin": "Guid",
"WorkflowObjectGuidMax": "Guid",
"IsDeleted": boolean,
"DataId": number,
"SchemeDataId": number

ClearingTypeDto

"Description": "string" ,
"Factor": Double ,
"IsClearable": "boolean" ,
"IsDeleted": "boolean" ,
"Name": "string" ,
"ObjectGuid": "Guid"

CostCenterDto

"Description": "string" ,
"EnableTimeAccounts": "boolean" ,
"EndDate": "DateTime" ,
"IsAllInclusive": "boolean" ,
"IsDeleted": "boolean" ,
"Name": "string" ,
"Number": Int64 ,
"ObjectGuid": "Guid" ,
"PeriodDuration": number ,
"PeriodLength": number ,
"StartDate": "DateTime" ,
"TicketLimit": number ,
"CanBookDirectly": "boolean"

CreateCiAttributeModel

"SchemeAttributeDataId": number ,
"Text": "string" ,
"Value": "string"

CreateCiCommentModel

"Comment": "string"

CreateCiModel

"SchemeDataId": number ,
"ZoneDataId": number ,
"VisibleId": "string" ,
"ParentDataId": number

CreateCiRelationModel

"CiParentDataId": number ,
"CiChildDataId": number ,
"RelationTypeDataId": number

CreateGroupModel

"Name": "string" ,
"ParentGroupObjectGuid": "Guid" ,
"IsLoginAllowed": InheritableBooleanDto ,
"CustomAttributes": [ IDictionary ]

CreateTicketCommentModel

"Comment": "string" ,
"Distribute": "boolean"

CreateTicketModel

"SchemeObjectGuid": "Guid" ,
"AffectedUserObjectGuid": "Guid" ,
"AffectedGroupObjectGuid": "Guid" ,
"ServiceTransactionDataId": number ,
"Fields": [ TicketFieldModel ],
"Cis": [ "Guid" ],
"OriginTicketObjectGuid": "Guid" ,
"Files": [ AddFileToTicketModel ]

CreateUserModel

"LoginName": "string" ,
"GroupObjectGuid": "Guid" ,
"IsLoginAllowed": InheritableBooleanDto ,
"Password": "string" ,
"CustomAttributes": [ IDictionary ]

CustomAttributeDto

"PropertyName": "string" ,
"PropertValue": "string" ,
"Caption": "string" ,
"Enabled": "boolean" ,
"Required": "boolean" ,
"SortKey": number ,
"Type": "string" ,
"Visible": "boolean"

DateTime

"Date": "DateTime" ,
"Day": number ,
"DayOfWeek": DayOfWeek ,
"DayOfYear": number ,
"Hour": number ,
"Kind": "DateTimeKind" ,
"Millisecond": number ,
"Minute": number ,
"Month": number ,
"Now": "DateTime" ,
"UtcNow": "DateTime" ,
"Second": number ,
"Ticks": Int64 ,
"TimeOfDay": "TimeSpan" ,
"Today": "DateTime" ,
"Year": number

DateTimeKind

Unspecified=0
Utc=1
Local=2

DateTimeStringDto "DateTime": "DateTime"

DayOfWeek

Sunday=0
Monday=1
Tuesday=2
Wednesday=3
Thursday=4
Friday=5
Saturday=6

DefaultExpenseSettingsDto

"Project": "Guid" ,
"CostCenter": "Guid" ,
"ClearingType": "Guid" ,
"ExpenseType": "Guid"

DeputyAssignmentDto

"DataId": number,
"DeputyUserId": number,
"Start": "yyyy-MM-ddTHH:mm:ss.fff",
"End": "yyyy-MM-ddTHH:mm:ss.fff",
"Deleted": "yyyy-MM-ddTHH:mm:ss.fff" nullable,
"DeputizedUserId": number,
"DeputyProxyUserId": number,
"DeputyProxyUserObjectGuid": "Guid",
"AssignedDeputyName": "string",
"Initialized": boolean,
"IsNew": boolean,
"DeputyName": "string"

Dictionary

"Key0": "string" : "value0" : "string",
"Key1": "string" : "value1" : "string",
"KeyN": "string" : "valueN" : "string"

ExpenseTypeDto

"ObjectGuid": "Guid" ,
"FriendlyName": "string" ,
"Name": "string" ,
"DefaultClearingTypeObjectGuid": "Guid" ,
"Formula": "string" ,
"IsActive": "boolean" ,
"IsDefault": "boolean" ,
"ResultType": number ,
"ResultUnitString": "string" ,
"ValidationErrorMessage": "string" ,
"ValidationRules": "string" ,
"ExpensesInFutureAllowed": "boolean" ,
"IsDeleted": "boolean"

ExpenseTypeFieldDto

"ObjectGuid": "Guid" ,
"FriendlyName": "string" ,
"Name": "string" ,
"DefaultValue": "string" ,
"Type": number ,
"Unit": "string" ,
"ValidationRule": "string"

GetTicketIdFromInputStringModel

"Text": "string"

GroupDto

"Name": "string" ,
"DataId": number ,
"ObjectGuid": "Guid" ,
"ParentGroupObjectGuid": "Guid" ,
"IsLoginAllowed": InheritableBooleanDto ,
"CustomAttributes": [ IDictionary ],
"IsDeleted": "boolean"

GroupSearchRequestDto

"PrincipalName": "string" ,
"Conditions": [ PrincipalSearchConditionDto ],
"Limit": number

IDictionary

"Key0": "string" : "value0" : "string",
"Key1": "string" : "value1" : "string",
"KeyN": "string" : "valueN" : "string"

InheritableBooleanDto

False=0
Inherited=1
Interface=2

Local=3

Saml=4

LocalMobil=5

SamlMobil=6

Tip:

You can use a numerical or a textual representation of the enumeration 'InheritableBooleanDto' for the property 'IsLoginAllowed'.

 

Additional login types can be added as a combination of multiple strings in the form of a comma-separated list. When using numerical declarations you use a sum of the corresponding values instead (see the following example).

 

Example:

On the basis of a single value:

Either 'IsLoginAllowed':'Inherited' or analogue 'IsLoginAllowed':'1'.

 

As a combination of several strings or as the sum of the associated values:.

Either 'IsLoginAllowed':'Interface,Local,LocalMobil' or analogue 'IsLoginAllowed':'22'.

 

IsoDateTime

"UtcDateTime": "DateTime" ,
"ZonedDateTime": "DateTime" ,
"TimeZone": "ITimeZoneInformation" ,
"Day": number ,
"DayOfWeek": "DayOfWeek" ,
"DayOfYear": number ,
"Hour": number ,
"Millisecond": number ,
"Minute": number ,
"Month": number ,
"Second": number ,
"Year": number ,
"Ticks": Int64 ,
"TimeOfDay": "TimeSpan"

ItemTemplateDto

"ObjectGuid": "Guid" ,
"FriendlyName": "string" ,

ITimeZoneInformation

"TimeZoneInfo": "TimeZoneInfo" ,
"Id": "string" , "Name": "string" ,
"DisplayName": "string" ,
"StandardName": "string" ,
"DaylightName": "string" ,
"BiasInMinutesNow": number ,
"StandardBiasInMinutes": number ,
"DaylightBiasInMinutes": number

KeyValuePair

"Key": "string" ,
"Value": "string"

LanguageDto

"DataId": number ,
"ObjectGuid": "Guid" ,
"FriendlyName": "string" ,
"LocalizedName": "string" ,
"CultureInfo": "string"

LinkExpenseErrorDto

"HasNoAction": "boolean" ,
"HasWrongBillingInfo": [ "string" ],
"IsReadOnly": "boolean" ,
"IsAlreadyLinkedToTicket": "boolean" ,
"IsAlreadyLinkedToTask": "boolean" ,
"ExpenseNotFound": "boolean"

LogLevels

Fatal=1
Error=2
Warning=3
Info=4
Verbose=5
Debug=6

NavigationExtensionDto

"ObjectGuid": "Guid",
"ClientObjectGuid": "Guid" nullable,
"FriendlyName": "string",
"Caption": "string",
"IconUrl": "string",
"BigIconUrl": "string",
"Content": "string",
"NavigationTypeGuid": "Guid",
"Description": "string",
"ContentType": "string"

ObjectTypeRightDto

"ObjectTypeGuid": "Guid" ,
"ControlledObjectGuid": "Guid" ,
"PermissionName": "string" ,
"AllowedRight": Right

PrincipalSearchConditionDto

"Name": "string" ,
"ComparisonOperator": "string" ,
"LogicalOperator": "string" ,
"Value": "string"

ProcessRoleDto

"CreatedDateTime": "DateTime" ,
"CreatorObjectGuid": "Guid" ,
"DataId": number ,
"IsDeleted": "boolean" ,
"Description": "string" ,
"FriendlyName": "string" ,
"LastModifier": "Guid" ,
"Name": "string" ,
"ObjectGuid": "Guid" ,
"LastModifiedDateTime": "DateTime"

ProjectDto

"ObjectGuid": "Guid" ,
"Name": "string" ,
"EndDateTime": "DateTime" ,
"StartDateTime": "DateTime" ,
"IsDeleted": "boolean"

Right

DirectlyAllowed=0
DirectlyDenied=1
InheritedAllowed=2
InheritedDenied=3

SearchConditionDto

"Name": "string" ,
"Operator": "string" ,
"Value": "string" ,
"Type": "string" ,
"FieldId": "string"

SearchConditionGroupDto

"LogicalOperator": "string" ,
"Conditions": [ SearchConditionDto ],
"Groups": [ SearchConditionGroupDto ]

searchRequestDto

"Select": [ "String" ],
"SelectAttributes": [ Dictionary ],
"Skip": "number" ,
"Top": "number" ,
"OrderBy": "string" ,
"Conditions": SearchConditionGroupDto

Tip:

With Select you can search for all columns that are configured in the DataView Tickets (Default view).

SearchResultDto

"Count": number ,
"Data": [ IDictionary ]

selectActivity

"activityDataId": number,
"client": "Guid",
"optionargument": "string",
"input": "string"

StatisticDto

"IsOnline": "boolean" ,
"LogLevel": "LogLevels" ,
"PrivateMemoryBytes": Int64 ,
"WorkingSetBytes": Int64 ,
"ProcessStarted": "DateTime" ,
"HandledExceptionsDuringLastHourInAppDomain": number ,
"TotalHandledExceptionsInAppDomain": Int64 ,
"TotalExceptionsInProcess": Int64 ,
"TotalRequestCount": Int64 ,
"RequestsLast24Hours": number ,
"RequestsLastHour": number

SummaryAndSolutionDto

"Summary": "string",

"Solution": "string"

SystemStatusInfoDto

"Module": "string" ,
"Name": "string" ,
"Value": "string"

TaskSchemeDto

"ObjectGuid": "Guid" ,
"Name": "string"

TenantDto

"ObjectGuid": "Guid" ,
"Name": "string"

TicketDto

"Id": number ,
"ObjectGuid": "Guid" ,
"CreatedDateTime": "DateTime" ,
"StateObjectGuid": "Guid" ,
"PriorityObjectGuid": "Guid" ,
"CreatorUserObjectGuid": "Guid" ,
"AffectedUserObjectGuid": "Guid" ,
"OwnerUserObjectGuid": "Guid" ,
"OwnerGroupObjectGuid": "Guid" ,
"InternalSolution": "string" ,
"ExternalSolution": "string" ,
"EstimatedTimeExpense": number ,
"CreationMethodName": "string" ,
"TicketType": "string" ,
"ContainerTicketDataId": number ,
"CompletionDateTime": "DateTime" ,
"ContainerTransferTicketDataId": number ,
"Deleted": "boolean" ,
"InternalSummary": "string" ,
"ExternalSummary": "string" ,
"FullId": "string" ,
"ClassificationLocalizedName": "string" ,
"CreatorGroupObjectGuid": "Guid" ,
"AffectedGroupObjectGuid": "Guid" ,
"TimeZone": "string" ,
"ServiceTransactionDataId": number ,
"ResponsibleUserObjectGuid": "Guid" ,
"ResponsibleGroupObjectGuid": "Guid" ,
"OwnerGroupProcessRoleDataId": number ,
"ResponsibleGroupProcessRoleDataId": number ,
"StartDateTime": "DateTime" ,
"StatusDataId": number ,
"Title": "string" ,
"StatusLocalizedName": "string" ,
"SchemaLocalizedName": "string" ,
"StatusIcon": "string" ,
"SchemeObjectGuid": "Guid"

TicketEscalationDto

"ObjectGuid": "Guid",
"TicketDataId": number,
"TicketObjectGuid": "Guid",
"TicketAffectedPrincipalOnEscalation": "Guid" nullable,
"TicketOwnerPrincipalOnEscalation": "Guid" nullable,
"TicketStatusOnEscalation": "Guid" nullable,
"TicketStatusDataIdOnEscalation": number nullable,
"TicketStatusDataId": number,
"FriendlyName": "string",
"EscalationTimeName": "string",
"Deadline": "yyyy-MM-ddTHH:mm:ss.fff" nullable,
"Escalated": "yyyy-MM-ddTHH:mm:ss.fff" nullable,
"StateReached": "yyyy-MM-ddTHH:mm:ss.fff" nullable,
"PausedSince": "yyyy-MM-ddTHH:mm:ss.fff" nullable,
"IsPaused": boolean,
"IsStateReached": boolean,
"IsEscalated": boolean,
"IsDeadLineSet": boolean,
"Created": "yyyy-MM-ddTHH:mm:ss.fff"

TicketFieldModel

"ObjectGuid": "Guid" ,
"Text": "string" ,
"Value": "string"

TicketFieldValueDto

"ObjectGuid": "Guid" ,
"TicketObjectGuid": "Guid" ,
"TicketSchemeFieldObjectGuid": "Guid" ,
"Value": "string" ,
"Text": "string" ,
"TicketFieldObjectGuid": "Guid" ,
"TextCropped": "string" ,
"TicketId": number ,
"ValueCropped": "string"

TicketFileType

General=1
Solution=2
Creation=3

TicketHistoryItemDto

"Text": "string" ,
"UserObjectGuid": "Guid" ,
"UserFullName": "string" ,
"TimeStamp": "DateTime" ,
"TimeStampAsFormattedString": "DateTimeStringDto" ,
"Deleted": "boolean" ,
"Visiblity": "string" ,
"ElementType": "string"

TicketHistoryOverviewItemDto

"Title": "string",
"Text": "string",
"UserObjectGuid": "Guid",
"UserFullName": "string",
"TimeStamp": "yyyy-MM-ddTHH:mm:ss.fff",
"TimeStampAsFormattedString": "yyyy-MM-ddTHH:mm:ss.fff",
"Deleted": boolean,
"Visibility": "string",
"ElementType": "string",
"ElementId": "string",
"ActionType": "string",
"Attributes": { "Key1":Value1, "Key2":Value2, ... }

TicketSchemaDto

"DataId": number,
"ObjectGuid": "Guid",
"FriendlyName": "string",
"Name": "string",
"Description": "string",
"ClassificationDataId": number,
"SortKey": number,
"TicketIdRangeObjectGuid": "Guid",
"TitleLabel": "string",
"TitleTicketSchemeFieldObjectGuid": "Guid",
"WorkflowObjectGuid": "Guid",
"DefaultTicketEntityVisibility": "string",
"FileStorageLimitMb": number

TicketSchemaFieldDto

"ObjectGuid": "Guid",
"FriendlyName": "string",
"Name": "string",
"DataId": number

TimeSpan

"Ticks": Int64 ,
"Days": number ,
"Hours": number ,
"Milliseconds": number ,
"Minutes": number ,
"Seconds": number ,
"TotalDays": "Double" ,
"TotalHours": "Double" ,
"TotalMilliseconds": "Double" ,
"TotalMinutes": "Double" ,
"TotalSeconds": "Double"

TimeZoneInfo

"Id": "string" ,
"DisplayName": "string" ,
"StandardName": "string" ,
"DaylightName": "string" ,
"BaseUtcOffset": "TimeSpan" ,
"SupportsDaylightSavingTime": "boolean" ,
"Local": "TimeZoneInfo" ,
"Utc": "TimeZoneInfo"

UpdateCiModel "ZoneDataId": number nullable
UpdateTicketFileModel "DeactivateFile": "boolean"
UpdateUserModel

"LoginName": "string" ,
"GroupObjectGuid": "Guid" ,
"IsLoginAllowed": InheritableBooleanDto ,
"CustomAttributes": [ IDictionary ]

UserDto

"FullName": "string" ,
"LoginName": "string" ,
"DataId": number ,
"ObjectGuid": "Guid" ,
"GroupObjectGuid": "Guid" ,
"IsLoginAllowed": InheritableBooleanDto ,
"CustomAttributes": [ IDictionary ],
"IsDeleted": "boolean"

UserSearchRequestDto

"PrincipalName": "string" ,
"Conditions": [ PrincipalSearchConditionDto ],
"Limit": number

Workflow

"client": "Guid" ,
"dataId": number ,
"description": "string" ,
"isGlobal": "boolean" ,
"name": "string" ,
"guid": "Guid" ,
"processSchemaId": number ,
"readonly": "boolean" ,
"category": "string" ,
"type": "string"