Reference list

 

 

Activity 1

Get a single activity.

api/activity/{client}/{id}

Description: The result of this method contains the information that you also see at the actions tab in the ticket detail dialog if you have any action to confirm.

Return type: activity

Return description: Returns status code 200 and the activity if existing

Parameters:

Name Type Description Optional
client Guid The client ID. The current client of the current user will be used if the provided guid is empty. No
id number The dataId of the activity. No

Example url: http://.../webapi/api/Activity/5EEE5D36-4B5B-466B-8745-F650BA9C84B3/123

 

Activity 2

Execute an activity

api/activity

Description: Send an activity item with required options to continue a workflow item in the workflow.

Return type: StatusCode

Return description: Returns status code 200 if the execution was successful

Parameters:

Name Type Description Optional
selectActivity selectActivity   No

Example url: http://.../webapi/api/Activity

Activities

Get a list of activity list items.

api/activities

Description: Get a list of activity list items. A activity list item is exactly what is displayed in the grid of the activity stage. It is NOT the activity itself. Changing the DataView of the activity grid in the 446 Plattform® will also affect the result of this method because each grid column is represented in the resulting json object.

Return type: activityListItem []

Return description: A list of activity list items.

Parameters:

Name Type Description Optional
$filter string odata - $filter Yes
$top string odata - $top Yes
$count string odata - $count Yes
$expand string odata - $expand Yes
$skip string odata - $skip Yes
$orderby string odata - $orderby Yes
$select string odata - $select Yes
groupBy string   Yes
entityType string   Yes

Example url: http://.../webapi/api/activities

BaseEntity 1

Gets a base entity by data id.

api/baseentities/:dataid}

Description: Gets a base entity by data id.

Return type: BaseEntityDto

Parameters:

Name Type Description Optional
baseEntityId Int64 The base entity data id. No

Example url: http://.../webapi/api/baseentities/1

 

BaseEntity 2

Gets all activities of this base entityd.

api/baseentities/{baseEntityDataId}/activities}

Description: Gets all activities of this base entit.

Return type: activity []

Parameters:

Name Type Description Optional
baseEntityId Int64 Gets all activities of this base entit. No

Example url: http://.../webapi/api/baseentities/2/activities

CiAttributes 1

Get the CI attribute by it's data ID.

api/ciattributes/{dataId}

Description: Get the CI attribute by it's data ID.

Return type: CiAttributeDto

Parameters:

Name Type Description Optional
dataId number   No

Example url: http://.../webapi/api/ciattributes/4

 

CiAttributes 2

Creates attributes for the given CI.

api/cis/{ciDataId}/attributes

Description: Creates attributes for the given CI.

Return type: StatusCode

Return description: Returns only status code 200 but no content

Parameters:

Name Type Description Optional
ciDataId number   No
attributes CreateCiAttributeModel []   No

Example url: http://.../webapi/api/cis/4/attributes

 

CiAttributes 3

Get all attributes of the given CI.

api/cis/{ciDataId}/Attributes

Description: Get all attributes of the given CI.

Return type: CiAttributeDto []

Parameters:

Name Type Description Optional
ciDataId number   No

Example url: http://.../webapi/api/cis/3/Attributes

CiImport 1

Gets a CI import by it's unique id (object guid).

api/ciimports/{ciImportId:guid}

Description: Gets a CI import by it's unique id (object guid). The current user need the view permission for this import.

Return type: CiImportDto

Parameters:

Name Type Description Optional
ciImportId Guid The ID of the CI-Import. No

Example url: http://.../webapi/api/ciimports/6ea36f9e-6fd8-4e3d-ac96-1842691962e3

 

CiImport 2

Gets all CI imports.

api/ciimports

Description: Gets all CI imports that the current user is allowed to see.

Return type: CiImportDto []

Parameters:

Name Type Description Optional
ciImportId Guid The ID of the CI-Import. No

Example url: http://.../webapi/api/ciimports

 

CiImport 3

Adds CI import to the import queue.

api/ciimports/{ciImportId:guid}/start

Description: Gets all CI imports that the current user is allowed to see.

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
ciImportId Guid The ID of the CI-Import. No

Example url: http://.../webapi/api/ciimports/6ea36f9e-6fd8-4e3d-ac96-1842691962e3/start

 

CiRelationTypes 1

Get CI relation type by given data ID

api/cirelationtypes/{relationTypeDataId}

Description: Get CI relation type by given data ID.

Return type: CiRelationTypeDto

Parameters:

Name Type Description Optional
relationTypeDataId number   No

Example url: http://.../webapi/api/cirelationtypes/255

 

CiRelationTypes 2

Get all CI relation types.

api/cirelationtypes

Description: Get all CI relation types.

Return type: CiRelationTypeDto

Example url: http://.../webapi/api/cirelationtypes

CiRelations 1

Get CI relation by given data ID.

api/cirelations/{relationDataId}

Description: Get CI relation by given data ID.

Return type: CiRelationDto

Parameters:

Name Type Description Optional
relationDataId number   No

Example url: http://.../webapi/api/cirelations/255

 

CiRelations 2

Get all relations from and to this CIs.

api/cis/{ciDataId}/relations

Description: Get all relations from and to this CIs.

Return type: CiRelationDto []

Parameters:

Name Type Description Optional
ciDataId number   No

Example url: http://.../webapi/api/cis/4/relations

 

CiRelations 3

Creates a new CI relation.

api/cirelations

Description: Creates a new CI relation

Return type: CiRelationDto

Parameters:

Name Type Description Optional
relationModel CreateCiRelationModel   No

Example url: http://.../webapi/api/cirelations

 

CiRelations 4

Remove related cis from and to this ci.

api/cis/{ciDataId}/relations

Description: Removes ci relations where the ci is connected to or where the ci is parent ci. A valid configured ci action is required. It is possible to specify a relation type and it is possible to name the related cis that should be deleted. When both 'relationTypes' and 'relatedCis' are not given all relations will be removed.

Return type: IHttpActionResult

Parameters:

Name Type Description Optional
ciDataId number   No
relationTypes String[] An optional comma separated list of relation type data ids. If no relation types are specified then all kind of relation types will be removed. Use dataIds, object guids or friendly names of relation types. Yes
relatedCis String[] An optional comma separated list of related cis. When no related cis are given then all relations of type relations will be removed otherwise only the relation of this type to this CI. Use dataIds, object guids, visibe ids or ci title. Prefer dataIds for fastest result. Yes
skipIfNotAllowed boolean If the optional parameter 'skipIfNotAllowed' is set to 'false' then the request will result in a Bad Request message if there is at least one ci that is not allowed to be removed because the required action is missing. The default value is of this parameter 'true', not allowed cis will be skipped without error. A logfile message will be created that a ci was skipped. Yes

Example url: http://.../webapi/api/cis/2393/relations?relatedCis=2394,2391&relationTypes=123,234

 

CiRelations 5

Removes the given CI relation.

api/cirelations/{ciReleationDataId}

Description: Removes the given CI relation.

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
ciReleationDataId number   No

Example url: http://.../webapi/api/cirelations/{ciReleationDataId}

CiScheme 1

Get CI schema by data ID.

api/cischemes/{schemeDataId}

Description: Get CI schema by data ID.

Return type: CiSchemeDto

Parameters:

Name Type Description Optional
schemeDataId number   No

Example url: http://.../webapi/api/cischemes/3

 

CiScheme 2

Get all CI schemas.

api/cischemes

Description: Get all CI schemas.

Return type: CiSchemeDto []

Example url: http://.../webapi/api/cischemes

 

CiScheme 3

Get CI schema attributes by CI schema.

api/cischemes/{schemeDataId}/attributes

Description: Get CI schema attributes by CI schema.

Return type: CiSchemeAttributeDto []

Parameters:

Name Type Description Optional
schemeDataId number The data ID of the CI schema. No

Example url: http://.../webapi/api/cischemes/3/attributes

 

CiScheme 4

Get CI schema attributes by CI schema.

api/cischemes/{schemeObjectGuid:Guid}/attributes

Description: Get CI schema attributes by CI schema.

Return type: CiSchemeAttributeDto []

Parameters:

Name Type Description Optional
schemeObjectGuid Guid The object guid of the CI schema. No

Example url: http://.../webapi/api/cischemes/b10eb0ff-92b7-4c61-b109-3e744fc2bf3f/attributes

 

CiSchemeAttributeGroup 1

Get dynamic fields groups.

api/cischemes/{schemeDataId:int}/attributeGroups

Description: Returns the ci schema attribute groups.

Return type: CiSchemeAttributeGroupDto []

Parameters:

Name Type Description Optional
schemeDataId number The dataId of the ci schema. No

Example url: http://.../webapi/api/cischemes/446/attributeGroups

 

CiSchemeAttributeGroup 2

Set dynamic field groups.

api/cischemes/{schemeDataId:int}/attributeGroups

Description: Saves the order and column index of dynamic fields within their field groups.

Return type: CiSchemeAttributeGroupDto []

Parameters:

Name Type Description Optional
schemeDataId number The dataId of the ci schema. No
attributeGroups CiSchemeAttributeGroupDto[]   No

Example url: http://.../webapi/api/cischemes/446/attributeGroups

 

Ci 1

Get all CIs by attribute text.

api/cis?ciAttributeName={friendlyName}&text={searchText}

Description: Get all CIs by attribute text.

Return type: CiDto []

Parameters:

Name Type Description Optional
ciAttributeName string   No
text string   No

Example url: http://.../webapi/api/cis?ciAttributeName=Feld1&text=abc

 

Ci 2

Get CI by objectGUID.

api/cirelations/{relationDataId}

Description: Get CI by objectGUID.

Return type: CiDto

Parameters:

Name Type Description Optional
ciObjectGuid Guid   No

Example url: http://.../webapi/api/cis/6ea36f9e-6fd8-4e3d-ac96-1842691962e0

 

Ci 3

Get CI by data ID.

api/cis/{ciDataId}

Description: Get CI by data ID.

Return type: CiDto

Parameters:

Name Type Description Optional
ciDataId number   No

Example url: http://.../webapi/api/cis/3

 

Ci 4

Get CI by visible ID.

api/cis?visibleId={visibleId}

Description: Get CI relation by given data ID.

Return type: CiDto []

Parameters:

Name Type Description Optional
visibleId string   No

Example url: http://.../webapi/api/cis?visibleId=myCi123

 

Ci 5

Get all parent CIs.

api/cis/{ciDataId}/parents

Description: Get all parent CIs.

Return type: CiDto []

Parameters:

Name Type Description Optional
ciDataId number   No

Example url: http://.../webapi/api/cis/4/parents

 

Ci 6

Gets the affetced users of the given CI.

api/cis/{ciDataId}/affectedusers

Description: Gets the affetced users of the given CI.

Return type: UserDto []

Parameters:

Name Type Description Optional
ciDataId number   No

Example url: http://.../webapi/api/cis/4/affectedusers

 

Ci 7

Gets the reachable states of the given CI.

api/cis/{ciDataId}/reachablestates

Description: Gets the reachable states of the given CI.

Return type: CiLifeCycleStateDto []

Parameters:

Name Type Description Optional
ciDataId number   No

Example url: http://.../webapi/api/cis/4/reachablestates

 

Ci 8

Gets the curent state of the given CI.

api/cis/{ciDataId}/state

Description: Gets the curent state of the given CI.

Return type: CiLifeCycleStateDto []

Parameters:

Name Type Description Optional
ciDataId number   No

Example url: http://.../webapi/api/cis/4/state

 

Ci 9

Gets all comments of the given CI.

api/cis/{ciDataId}/comments

Description: Gets all comments of the given CI.

Return type: CiCommentDto []

Parameters:

Name Type Description Optional
ciDataId number   No

Example url: http://.../webapi/api/cis/4/comments

 

Ci 10

Creates a new CI.

api/cis

Description: Creates a new CI.

Return type: CiDto

Parameters:

Name Type Description Optional
newCi CreateCiModel   No

Example url: http://.../webapi/api/cis

 

Ci 11

Add an affetced user to the given CI.

api/cis/{ciDataId}/affectedusers/{userGuid}

Description: Add an affetced user to the given CI.

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
ciDataId number   No
affectedUserObjectGuid Guid   No

Example url: http://.../webapi/api/cis/4/affectedusers/EBC5AC00-5F93-46FA-AC7D-517BF3C70CEA

 

Ci 12

Sets the state of the given CI.

api/cis/{ciDataId}/state/{ciStateDataId:int}

Description: Sets the state of the given CI.

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
ciDataId number   No
ciStateDataId number   No

Example url: http://.../webapi/api/cis/4/state/13

 

Ci 13

Creates a new comment for the given CI.

api/cis/{ciDataId}/comments

Description: Creates a new comment for the given CI.

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
ciDataId number   No
comment CreateCiCommentModel   No

Example url: http://.../webapi/api/cis/4/comments

 

Ci 14

Remove ci from zone.

api/cis/{ciDataId:int}/zones/{zoneDataId}

Description: Removes the ci from a zone. This requires the manage zone action and remove item permissions on the zone. If the visible zone will be removed then one of the remaining zones becomes the new visible zone. This method does nothing if there is only one zone left.

Return type: IHttpActionResult

Parameters:

Name Type Description Optional
ciDataId number   No
zoneDataID number   No

Example url: http://.../webapi/api/cis/446/zones/{zoneDataId}

 

Ci 15

Removes the affetced user from the given CI.

api/cis/{ciDataId}/affectedusers/{userGuid}

Description: Removes the affetced user from the given CI.

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
ciDataId number   No
affectedUserObjectGuid Guid   No

Example url: http://.../webapi/api/cis/4/affectedusers/EBC5AC00-5F93-46FA-AC7D-517BF3C70CEA

 

Ci 16

Update ci properties.

api/cis/{ciDataId:int}

Description: Currently only the change of the visible zone is supported.

Return type: IHttpActionResult

Parameters:

Name Type Description Optional
ciDataId number   No
model UpdateCiModel   No

Example url: http://.../webapi/api/cis/446

 

CiZoneAttributes 1

Get attributes by zone.

/api/ciZones/{zoneId:int}/attributes

Description: <>.

Return type: CiAttributeDto []

Parameters:

Name Type Description Optional
zoneId number   No

Example url: http://.../webapi/api/ciZones/446/attributes

 

CiZoneAttributes 2

Creates attributes for the given CI zone.

/api/ciZones/{zoneId:int}/attributes

Description: <>.

Return type: IHttpActionResult

Return description: <>.

Parameters:

Name Type Description Optional
zoneId number   No
attributes CreateCiAttributeModel[]   No

Example url: http://.../webapi/api/ciZones/446/attributes

 

CiZones 1

Delete a zone.

api/ciZones/{zoneDataId:int}

Description: <>.

Return type: IHttpActionResult

Return description: <>.

Parameters:

Name Type Description Optional
zoneDataId number   No

Example url: http://.../webapi/api/ciZones/446

 

CiZones 2

Get child zones of a zone.

api/ciZones/{zoneDataId:int}/zones

Description: <>.

Return type: CiZoneDto []

Parameters:

Name Type Description Optional
zoneDataId number   No

Example url: http://.../webapi/api/ciZones/446/zones

 

CiZones 3

Get top level CI zones.

api/ciRootZones

Description: <>.

Return type: CiZoneDto []

 

Example url: http://.../webapi/api/ciRootZones

 

ClearingTypes 1

Get a clearing type by ID.

api/clearingtypes/{clearingTypeObjectGuid}

Description: Get a clearing type by its objectGuid.

Return type: ClearingTypeDto

Parameters:

Name Type Description Optional
clearingTypeObjectGuid Guid   No

Example url: http://.../webapi/api/clearingtypes/ddc8a0a2-04ab-4a96-8af1-50ca3c838c2e

 

Configuration 1

Get the timeout in ms, that is used while determining the current geo location.

api/configuration/system/GeoLocationQueryTimeout

Description: Get the timeout in ms, that is used while determining the current geo location.

Return type: number

Example url: http://.../webapi/api/configuration/system/GeoLocationQueryTimeout

 

Configuration 2

Gets the maximum number of results that are shown in the user browser.

api/configuration/system/UserBrowserMaxResultCount

Description: Gets the maximum number of results that are shown in the user browser.

Return type: number

Example url: http://.../webapi/api/configuration/system/UserBrowserMaxResultCount

 

Configuration 3

Gets the minimum length of the search expression from which a search is started in the UserBrowser via Search-As-You-Type.

api/configuration/system/UserBrowserMinQueryLength

Return type: number

Example url: http://.../webapi/api/configuration/system/UserBrowserMinQueryLength

 

Configuration 4

Gets the session timeout for 446 Plattform Mobil in minutes. [Isonet.446Plattform.SessionTimeoutInMinutes]

api/configuration/system/SessionTimeoutInMinutes

Return type: number

Example url: http://.../webapi/api/configuration/system/SessionTimeoutInMinutes

 

Configuration 5

Returns the accepted file types and mime types for file uploads. [Isonet.446Plattform.FileUploadFilter]

api/configuration/client/FileUploadFilter

Return type: string

Example url: http://.../webapi/api/configuration/client/FileUploadFilter

 

Configuration 6

Returns the content of the linked ticket control. (Linked,Successor,Parent)

api/configuration/client/LinkedTicketsControl

Return type: string

Example url: http://.../webapi/api/configuration/client/LinkedTicketsControl

 

Configuration 7

Returns true or false whether the clipboard feature in file upload control is enabled or not. [Isonet.446Plattform.FileUpload.DisableClipboardUpload]

api/configuration/system/DisableClipboardUpload

Return type: boolean

Example url: http://.../webapi/api/configuration/system/DisableClipboardUpload

 

Configuration 8

Returns true or false whether the menu item for switching platforms is enabled or not. [Isonet.446Plattform.PlatformSwitchingLink]

api/configuration/system/PlatformSwitchingLinkEnabled

Return type: boolean

Example url: http://.../webapi/api/configuration/system/PlatformSwitchingLinkEnabled

 

Expenses 1

Attach an expense to a ticket.

api/expenses/{expenseObjectGuid}/attachToTicket?ticketObjectGuid={ticketObjectGuid}

Description: Attach an expense to a exisiting ticket.

Return type: LinkExpenseErrorDto

Return description: Returns no content but status code 200 in case of success. Returns an error object with detailed error reasons in case of error.

Parameters:

Name Type Description Optional
expenseObjectGuid Guid   No
ticketObjectGuid Guid   No

Example url: http://.../webapi/api/expenses/f12b638c-abec-4835-a779-cf28efc27ee4/attachToTicket?ticketObjectGuid=63748c4a-7d37-4704-ba2e-8ac53f60519f

 

Expenses 2

Attach an expense to a task.

api/expenses/{expenseObjectGuid}/attachToTask?taskFullId={taskFullId}

Description: Attach an expense to an existing task.

Return type: LinkExpenseErrorDto

Return description: Returns no content but status code 200 in case of success. Returns an error object with detailed error reasons in case of error.

Parameters:

Name Type Description Optional
expenseObjectGuid Guid   No
taskFullId string   No

Example url: http://.../webapi/api/expenses/f12b638c-abec-4835-a779-cf28efc27ee4/attachToTask?taskFullId=TSK_1

 

Expenses 3

Search expenses.

api/expenses/search

Description: Searches for expenses.

Return type: SearchResultDto

Return description: Returns a list of found expenses and the number of total expenses, matching the search request but not reduced by 'top' and 'skip'.

Parameters:

Name Type Description Optional
searchRequestDto SearchRequestDto   No

Example url: http://.../webapi/api/expenses/search

 

ExpenseTypeFields

Get all fields of an expense type.

api/expensetypes/{expenseTypeObjectGuid}/fields

Description: Get all fields of an expense type.

Return type: ExpenseTypeFieldDto []

Parameters:

Name Type Description Optional
expenseTypeObjectGuid Guid   No

Example url: http://.../webapi/api/expensetypes/8ff9f222-ae01-4d80-b155-3b1eae867d04/fields

ExpenseTypes 1

Get a expense type by ID.

api/expensetypes/{expenseTypeObjectGuid}

Description: Get a expense type by its dataId.

Return type: ExpenseTypeDto

Parameters:

Name Type Description Optional
expenseTypeObjectGuid Guid   No

Example url: http://.../webapi/api/expensetypes/8ff9f222-ae01-4d80-b155-3b1eae867d04

 

ExpenseTypes 2

Get all clearing types by expense type.

api/expensetypes/{expenseTypeObjectGuid}/clearingtypes

Description: Get all clearing types by expense type.

Return type: ClearingTypeDto

Parameters:

Name Type Description Optional
expenseTypeObjectGuid Guid   No

Example url: http://.../webapi/api/expensetypes/8ff9f222-ae01-4d80-b155-3b1eae867d04/clearingTypes

 

ExpenseTypes 3

Get all expense types.

api/expensetypes

Description: Get all expense types.

Return type: ExpenseTypeDto []

Example url: http://.../webapi/api/expensetypes

Group 1

Gets a group by its identifier (name, objectGUID or data ID).

api/groups/:groupIdentifier

Description: Gets a group by its identifier (name, objectGUID or data ID).

Return type:GroupDto

Parameters:

Name Type Description Optional
groupIdentifier string The identifier of the group (name, objectGUID or data ID). No

Example url: http://.../webapi/api/groups/1

 

Group 2

Gets all users of a group.

api/groups/:groupIdentifier/users?recursive=true

Description: Gets all users of a group. Set the parameter recursive=true to get the users of all sub groups as well.

Return type: UserDto []

Parameters:

Name Type Description Optional
groupIdentifier string The identifier of the group (name, objectGUID or data ID). No
recursive boolean Set to true to get also all users of all containing groups. Yes

Example url: http://.../webapi/api/groups/1/Users?recursive=true

 

Group 3

Gets all sub groups of a group.

api/groups/:groupIdentifier/groups?recursive=true

Description: Gets all sub groups of a group. Set the parameter recursive=true to get groups of all sub groups as well.

Return type:GroupDto []

Parameters:

Name Type Description Optional
groupIdentifier string The identifier of the group (name, objectGUID or data ID). No
recursive boolean Set to true to get also all users of all containing groups. Yes

Example url: http://.../webapi/api/groups/1/groups?recursive=true

 

Group 4

Gets all groups where the given group is member of.

api/groups/:identifier/parentgroups

Description: Gest all groups where the given group is member of.

Return type:GroupDto []

Parameters:

Name Type Description Optional
groupIdentifier string The identifier of the group (name, objectGUID or data ID). No

Example url: http://.../webapi/api/groups/1/parentgroups

 

Group 5

Determines if a group has the given permission or not.

api/groups/:identifier/isallowed?objectTypeGuid={Guid}&controlledObjectGuid={Guid}&permissionName={string} Public

Description: Determines if a group has the given permission or not.

Return type: boolean

Parameters:

Name Type Description Optional
groupIdentifier string The identifier of the group (name, objectGUID or data ID) for which the right should be checked. No
objectTypeGuid Guid The GUID of the object type. No
controlledObjectGuid Guid The GUID of the controlled object. No
permissionName string The name of the permission that should be checked. No

Example url: http://.../webapi/api/groups/{groupIdentifier}/isallowed?objectTypeGuid=4D088E7E-3BB0-4DBA-B329-B1AF622AA83C&controlledObjectGuid=2F50627E-D522-4137-A474-E71CED371E57&permissionName=owning

 

Group 6

Creates a new group.

api/groups

Description: Creates a new group.

Return type:GroupDto

Parameters:

Name Type Description Optional
model CreateGroupModel The group data transfer object No

Example url: http://.../webapi/api/groups

 

Group 7

Adds a user as member to the given group.

api/groups/:groupIdentifier/Groups/:userIdentifier

Description: Adds a user as member to the given group.

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
groupIdentifier string The identifier of the group (name, objectGUID or data ID) No
userIdentifier string The user identifier of the new member (name, objectGUID or data ID) No

Example url: http://.../webapi/api/groups/1/users/265

 

Group 8

Adds a group as member to the given group.

api/groups/:groupIdentifier/Groups/:memberGroupIdentifier

Description: Adds a group as member to the given group.

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
groupIdentifier string The identifier of the group (name, objectGUID or data ID). No
memberGroupIdentifier string The group identifier of the new member (name, objectGUID or data ID). No

Example url: http://.../webapi/api/groups/1/Groups/2

 

Group 9

Sets a permission for the given group..

api/groups/{groupIdentifier}/permissions Public

Description: Sets a permission for the given group.

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
groupIdentifier string The identifier of the group (name, objectGUID or data ID), where the permission should be set. No
objectTypeRightDto ObjectTypeRightDto The object type right data transfer object. No

Example url: http://.../webapi/api/groups/{groupIdentifier}/permissions

 

Group 10

Post a search request to retrieve a list of groups.

api/groups Public

Description:Post a search request to retrieve a list of groups.

Return type: GroupDto []

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
searchRequest GroupSearchRequestDto The search request object. Add conditions to search for custom attributes within the groups. Multiple conditions are possible. No

Example url: http://.../webapi/api/groups/search

 

Group 11

Removes the given group.

api/groups/:groupIdentifier

Description: Removes the given group.

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
groupIdentifier string The identifier of the group (name, objectGUID or data ID). No

Example url: http://.../webapi/api/groups/1

 

Group 12

Removes a member user from given group.

api/groups/:groupIdentifier/users/:userIdentifier

Description: Removes a member user from given group.

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
groupIdentifier string The identifier of the group (name, objectGUID or data ID). No
userIdentifier string The user identifier (name, objectGUID or data ID) to be removed from group. No

Example url: http://.../webapi/api/groups/1/users/265

 

Group 13

Removes a group from membership of the given group.

api/groups/:groupIdentifier/Groups/:memberGroupIdentifier

Description: Removes a group from membership of the given group.

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
groupIdentifier string The identifier of the group (name, objectGUID or data ID). No
memberGroupIdentifier string The group identifier (name, objectGUID or data ID) to be removed from group. No

Example url: http://.../webapi/api/groups/1/Groups/2

 

Group 14

Updates an existing group.

api/groups/{groupIdentifier} Public

Description: Updates an existing group. At least the properties Name and ParentGroupObjectGuid must be set in the CreateGroupModel object.

Return type: GroupDto

Parameters:

Name Type Description Optional
groupIdentifier string The identifier of the group (name, objectGUID or data ID). No
model CreateGroupModel The group data transfer object. At least the properties Name and MainGroupObjectGuid must be set. No

Example url: http://.../webapi/api/groups/1

GroupCustomAttribute 1

Gets all custom attributes of the given group.

api/groups/:groupIdentifier/CustomAttributes

Description: Gets all custom attributes of the given group.

Return type: CustomAttributeDto []

Parameters:

Name Type Description Optional
groupIdentifier string The identifier of the group (name, objectGUID or data ID). No

Example url: http://.../webapi/api/groups/1/CustomAttributes

 

GroupCustomAttribute 2

Gets the value of certain custom attributes of the given group.

api/groups/:groupIdentifier/CustomAttributes/:attributeName

Description: Gets the value of certain custom attributes of the given group.

Return type: string

Parameters:

Name Type Description Optional
groupIdentifier string The identifier of the group (name, objectGUID or data ID) No
attributeName string The name of the attribute. No

Example url: http://.../webapi/api/groups/1/CustomAttributes/email

 

GroupCustomAttribute 3

Sets the custom attributes for a given group.

api/groups/{groupIdentifier}/CustomAttributes

Description: Sets the custom attributes for a given group.

Return type: KeyValuePair []

Parameters:

Name Type Description Optional
groupIdentifier string The identifier of the group (name, objectGUID or data ID). No
attributes KeyValuePair [] The list with attributes. No

Example url: http://.../webapi/api/groups/1/CustomAttributes

 

GroupCustomAttribute 4

Removes the custom attributes of the given group.

api/groups/:groupIdentifier/CustomAttributes/:attributeName

Description: Removes the custom attributes of the given group.

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
groupIdentifier string The identifier of the group (name, objectGUID or data ID). No
attributeName string The name of the attribute. No

Example url: http://.../webapi/api/groups/1/CustomAttributes/email

Knowledgebase.ItemTemplate

Get all item templates.

api/kbschemes

Description: Get all item templates.

Return type: ItemTemplateDto []

Example url: http://.../webapi/api/kbschemes

M2T

Get a ticket from m2t input string.

api/tickets/m2t/findTicketFromInputString

Description: This method receives a text and scans it for the message token. Based on this message token, the ticket ID is subsequently detected.

Return type: TicketDto

Return description: The found ticket. Returns NULL if no ticket was found.

Parameters:

Name Type Description Optional
model GetTicketIdFromInputStringModel A text, containing a message token. The message token has the following form: TXP:{bf39b4da-a9b3-44f7-955e-8c4dcb825a04}:PXT . No

Example url: http://.../webapi/api/m2t/findTicketFromInputString

Me 1

Gets the ui language of the current user.

api/me/uiLanguage

Description: Gets the ui language of the current user.

Return type: string

Return description: Returns status code 200 and the ui language of the current user.

Example url: http://.../webapi/api/me/uiLanguage

 

Me 2

Gets the date time format of the current user.

api/me/uiLanguage

Description: Gets the date time format of the current user.

Return type: string

Return description: Returns status code 200 and the date time format of the current user.

Example url: http://.../webapi/api/me/dateTimeFormat

 

Me 3

Gets the timezone utc offset of the current user.

api/me/timezoneUtcOffset/{time}

Description: Gets the timezone utc offset of the current user.

Return type: string

Return description: Returns status code 200 and the timezone utc offset of the current user.

Parameters:

Name Type Description Optional
time string   No

Example url: http://.../webapi/api/me/timezoneUtcOffset/{time}

 

Me 4

Gets the given user setting of the current user.

api/me/usersettings/{key:string}

Description: Gets the given user setting of the current user.

Return type: string

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
key string   No

Example url: http://.../webapi/api/me/usersettings/Tools.TicketDetailDialog.Todos.idgEntries.SortOrder/Ascending

 

Me 5

Gets the active tenant(s) for the current user.

api/me/activetenants

Description: Gets the active tenant(s) for the current user.

Return type: TenantDto []

Example url: http://.../webapi/api/me/activetenants

 

Me 6

Gets the date format of the current user.

api/me/dateFormat

Description: Gets the date format of the current user.

Return type: IHttpActionResult

Example url: http://.../webapi/api/me/dateFormat

 

Me 7

Gets the date time format of the current user.

api/me/dateTimeFormat

Description: Gets the date time format of the current user.

Return type: IHttpActionResult

Return description: Returns status code 200 and the date time format of the current user.

Example url: http://.../webapi/api/me/dateTimeFormat

 

Me 8

Sets the ui language of the current user.

api/me/uiLanguage/{languageCode:string}

Description: Sets the ui language of the current user. Use iso language code to define the language e.g. de, en, ...

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
languageCode string The language code e.g. 'de', 'en', ... No

Example url: ttp://.../webapi/api/me/uiLanguage/de

 

Me 9

Sets the given user setting of the current user.

api/me/usersettings

Description: Sets the given user setting of the current user.

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
settings Dictionary []   No

Example url: http://.../webapi/api/me/usersettings

 

Me 10

Activates the given tenant for the current user.

api/me/activetenant/{tenantObjectGid:guid}

Description: Activates the given tenant for the current user.

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
tenantObjectGuid Guid   No

Example url: http://.../webapi/api/me/activetenant/B114F6CB-3D83-49C9-9B6F-DF4D366ABA91

 

Navigation Extension 1

Get all navigation extensions for mobile UI that the current user is allowed to see.

api/navigationExtensions

Description: Get all navigation extensions for mobile UI that the current user is allowed to see.

Return type: NavigationExtensionDto []

Example url: http://.../webapi/api/navigationExtensions

 

Projects 1

Get a project by ID.

api/projects/{projectObjectGuid}

Description: Get a LVER project by its objectGUID.

Return type: ProjectDto

Parameters:

Name Type Description Optional
projectObjectGuid Guid   No

Example url: http://.../webapi/api/projects/ddc8a0a2-04ab-4a96-8af1-50ca3c838c2e

 

Projects 2

Get all projects.

api/projects

Description: Returns all projects that are active at the specified date.

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
date DateTime Specifies the filter criteria where the project is active (usable by the user). A project will not be loaded if the start date of the project is after the specified value or the end date of the project is before the specified value. The current date will be used if no date parameter value is set. (e.g. 2019-01-03T15:00:00) No

Example url: http://.../webapi/api/projects

CostCenters 1

Get cost centers.

api/projects/:id/costcenters

Description: Get all cost center of a particular project, including the not active ones. Specify a date parameter to get only active cost centers at the specified date.

Return type: CostCenterDto []

Parameters:

Name Type Description Optional
projectObjectGuid Guid   No
date DateTime   Yes

Example url: http://.../webapi/api/projects/ddc8a0a2-04ab-4a96-8af1-50ca3c838c2e/costcenters?date=2016-08-06T00:00:00

 

CostCenters 2

Get cost center by ID.

api/project/{projectObjectGuid}/costcenters/{costCenterObjectGuid}

Description: Get a particular cost center of a project by ID.

Return type: CostCenterDto

Parameters:

Name Type Description Optional
projectObjectGuid Guid   No
costCenterObjectGuid Guid   No

Example url: http://.../webapi/api/project/ddc8a0a2-04ab-4a96-8af1-50ca3c838c2e/c

ServicePortfolio 1

Get the process role by data ID.

api/serviceportfolio/ProcessRoles/:dataId

Description: Get the process role by data ID.

Return type: ProcessRoleDto

Parameters:

Name Type Description Optional
dataId number   No

Example url: http://.../webapi/api/serviceportfolio/ProcessRoles/10

 

ServicePortfolio 2

Gets all process roles.

api/serviceportfolio/ProcessRoles

Description: Gets all process roles.

Return type: ProcessRoleDto []

Example url: http://.../webapi/api/serviceportfolio/ProcessRoles

SystemInfo 1

Get the system information.

api/systemInfo/all

Description: Get the information of all applications.

Return type: SystemStatusInfoDto []

Example url: http://.../webapi/api/systemInfo/all

 

SystemInfo 2

Get the log level of the given application.

api/system/LogLevel/WorkflowManager

Description: Get the log level of the given application. Possible applications are: WebApi, WorkflowManager, SecurityManager, MessagingManager, Agent, SlmService and Mail2Ticket.

Return type: number

Parameters:

Name Type Description Optional
application string   No

Example url: http://.../webapi/api/systemInfo/LogLevel/WorkflowManager

 

SystemInfo 3

Get the statistic for sql executions of the WebAPI.

api/systemInfo/SqlExecutionStatistics

Description: Get the statistic for sql executions of the WebAPI.

Return type: Dictionary []

Example url: http://.../webapi/api/systemInfo/SqlExecutionStatistics

 

SystemInfo 4

Get the statistic of the WebAPI.

api/systemInfo/Statistics

Description: Get the statistic of the WebAPI.

Return type: StatisticDto

Example url: http://.../webapi/api/systemInfo/Statistics

 

SystemInfo 5

Sets the log level of the given application.

api/systemInfo/LogLevel/{application}/{logLevel:int}

Description: Sets the log level of the given application. Possible applications are: WebApi, WorkflowManager, SecurityManager, MessagingManager, Agent, SlmService and Mail2Ticket..

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
application string   No
logLevel number   No

Example url: http://.../webapi/api/systemInfo/LogLevel/WorkflowManager/6

TaskManagement.TaskScheme

Get all task schemes.

api/taskschemes

Description: Get all task schemes.

Return type: TaskSchemeDto []

Example url: http://.../webapi/api/taskschemes

Tenant 1

Get the root group of the given tenant.

api/tenants/:tenantId/RootGroup

Description: Get the root group of the given tenant.

Return type: GroupDto

Parameters:

Name Type Description Optional
tenantId Guid The object GUID of the tenant. No

Example url: http://.../webapi/api/tenants/C7017741-E11D-469F-A1AB-1B046E8FBC99/RootGroup

 

Tenant 2

Gets all languages of the given tenant.

pi/tenants/:tenantId/Languages

Description: Gets all languages of the given tenant.

Return type: LanguageDto []

Parameters:

Name Type Description Optional
tenantId Guid The object GUID of the tenant. No

Example url: http://.../webapi/api/tenants/C7017741-E11D-469F-A1AB-1B046E8FBC99/Languages

 

Tenant 3

Get the objectGUID of the current tenant.

api/tenants/TenantByHostHeader

Description: Get the objectGUID of the current tenant.

Return type: Guid

Example url: http://.../webapi/api/tenants/TenantByHostHeader

 

Tenant 4

Get the object GUID of the default tenant.

api/tenants/DefaultTenant

Description: Get the object GUID of the default tenant.

Return type: Guid

Example url: http://.../webapi/api/tenants/DefaultTenant

 

Tenant 5

Gets a list of all tenants with name and objectGUID.

api/tenants

Description: Gets a list of all tenants with name and objectGUID.

Return type: Dictionary []

Example url: http://.../webapi/api/tenants

TicketFiles 1

Update a ticket file.

api/tickets/{ticketDataId}/file/{fileId}

Description: Updates a ticket file model. What is updated is depending on the properties set in the model.

Return type: StatusCode

Parameters:

Name Type Description Optional
ticketDataId number The ticket containing the file. No
fileId number The file which should be updated in the ticket. No
updateTicketFileModel UpdateTicketFileModel Contains what should be updated in the file. No

Example url: http://.../webapi/api/tickets/1/file/1

 

TicketFiles 2

Upload a file to a ticket.

api/tickets/{ticketDataId}/files?actionObjectGuid={actionId}

Description: Upload a byte array to attach it as a file to a ticket.

Return type: IHttpActionResult

Parameters:

Name Type Description Optional
ticketDataId number   No
actionObjectGuid Guid   No
model AddFileToTicketModel   No

Example url: http://.../webapi/api/tickets/1/files?actionObjectGuid=B10EB0FF-92B7-4C61-B109-3E744FC2BF3F

TicketExpenses

Get default expense settings.

api/tickets/:id/defaultExpenseSettings

Description: Returns the objectGUID of the default project, costcenter, expense type and clearing type. The ID is an empty guid if no default value is set.

Return type: DefaultExpenseSettingsDto

Parameters:

Name Type Description Optional
ticketDataId number   No

Example url: http://.../webapi/api/tickets/1/defaultExpenseSettings

TicketActions

Gets all configured ticket actions for the current user of the given ticket.

api/tickets/{ticketId}/actions

Description: Gets all configured ticket actions for the current user of the given ticket.

Return type: ActionDto []

Parameters:

Name Type Description Optional
ticketId number   No

Example url: http://.../webapi/api/tickets/1234/actions

TicketAffectedPrincipals 1

Get additional affected principals.

api/tickets/{ticketDataId}/additionalAffectedPrincipals

Description: Get a list of additional affected principals.

Return type: Guid []

Parameters:

Name Type Description Optional
ticketDataId number   No

Example url: http://.../webapi/api/tickets/1/additionalAffectedPrincipals

TicketAffectedPrincipals 2

Add additional affected principals.

api/tickets/{ticketDataId:int}/additionalAffectedPrincipals

Description: Adds additional affected principal(s).

Return type: IHttpActionResult

Parameters:

Name Type Description Optional
ticketDataId number   No
principals Guid[] A list of principal IDs. The type of the principals must match with the scope of the specified action. The execution will fail if any principal is not of the required type. No
actionObjectGuid Guid A ticket action of type change affected users is required to be allowed. Provide the action object guid as a query parameter. The parameter actionObjectGuid may only be omitted for exactly one action. Yes

Example url: http://.../webapi/api/tickets/446/additionalAffectedPrincipals

 

TicketAffectedPrincipals 3

Remove additional affected principals.

api/tickets/{ticketDataId:int}/additionalAffectedPrincipals

Description: Removes additional affected principal(s).

Return type: IHttpActionResult

Parameters:

Name Type Description Optional
ticketDataId number   No
principals Guid[] A list of principal IDs to remove. No
actionObjectGuid Guid A ticket action of type change affected users is required to be allowed. Provide the action object guid as a query parameter. The parameter actionObjectGuid may only be omitted for exactly one action. Yes

Example url: http://.../webapi/api/tickets/446/additionalAffectedPrincipals

Ticket 1

Get a ticket by fullId.

api/tickets?fullId={fullId}

Description: Search for a ticket by fullId.

Return type: TicketDto []

Parameters:

Name Type Description Optional
fullId string   No

Example url: http://.../webapi/api/tickets?fullId=T_123

 

Ticket 2

Get a ticket by dataId.

api/tickets/{ticketDataId}

Description: Get a ticket by its dataId.

Return type: TicketDto

Parameters:

Name Type Description Optional
ticketDataId number The ticket dataId. No

Example url: http://.../webapi/api/tickets/1

 

Ticket 3

Get a ticket by objectGuid.

api/tickets/{ticketObjectGuid}

Description: Get a ticket by objectGuid.

Return type: TicketDto

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
objectGuid Guid The ticket objectGUID. No

Example url: http://.../webapi/api/tickets/f12b638c-abec-4835-a779-cf28efc27ee4

 

Ticket 4

Gets all activities of this ticket.

api/tickets/{ticketDataId}/activities

Description: Gets all activities of this ticket.

Return type: activity []

Parameters:

Name Type Description Optional
ticketDataId number   No

Example url: http://.../webapi/api/tickets/1/activities

 

Ticket 5

Gets all pending escalations of this ticket.

api/tickets/{ticketDataId}/escalations

Description: Gets all pending escalations of this ticket.

Return type: TicketEscalationDto []

Parameters:

Name Type Description Optional
ticketDataId number The ticket data ID. No
searchInArchive Boolean True, if the ticket should be searched in the archive db. Yes

Example url: http://.../webapi/api/tickets/1/escalations

 

Ticket 6

Gets the text that is generated when clicking on FullId of the ticket.

api/tickets/{ticketDataId}/ClipboardText

Description: Gets the text that is generated when clicking on FullId of the ticket.

Return type: IHttpActionResult

Parameters:

Name Type Description Optional
ticketDataId number The ticket data ID. No

Example url: http://.../webapi/api/tickets/1/ClipboardText

 

Ticket 7

Searches for all tickets attached to a calendar item.

api/tickets/searchCalendar

Description: Returns all tickets of a specific search filter that are also attached to at least one calendar item. If defined then only for items within the specified timeframe.

Return type: SearchResultDto

Parameters:

Name Type Description Optional
ticketFilterDataId number   No
from string   No
to string   No
skip number   No
top number   No
orderBy string   No

Example url: http://.../webapi/api/tickets/searchCalendar?ticketFilterDataId=10&from=2022-17-07T-00:00:00:000&to=2022-17-07T-23:59:59:999&skip=0&top=0&orderBy=

 

Ticket 8

Search tickets.

api/tickets/search

Description: Find tickets by search conditions.

Return type: SearchResultDto

Return description: Returns a list of found tickets and the number of total tickets, matching the search request but not reduced by top and skip.

Parameters:

Name Type Description Optional
searchRequestDto searchRequestDto   No

Example url: http://.../webapi/api/tickets/search

Property Description Default Optional

top

Number of max n items to be loaded. (n>1).

100

True
skip Number of items to be skipped. 0  

OrderBy

The name of the property followed by a space and the sort direction asc|desc.

"FullId asc"

True

Select

A list of property names to be included in the result set. Get the available names from the DataView configuration dialog.

["FullId"]

True

SelectAttributes

A key value pair mapping. The key is the name of the property in the result set. The value is a list of ticket schema field IDs. If the result set contains tickets of different schemas, the field values are mapped to this property.

[]

True

Conditions

A condition group object. A condition group can contain a list of single conditions or a list of sub condition groups or both. All groups and single conditions are concatenated with Or/And, specified by the LogicalOperator. A single condition contains the name of the filter property, the operator name and the operator value.

null

True

Example:

Copy 
{
    "OrderBy":"OwnerPrincipal desc",
    "Top":100,
    "Skip":0,
    "Select":["OwnerGroup", "Schema"],
    "SelectAttributes":
        {"feld1": ["4fd14a94-7134-48d4-a10a-f9c4776d9673",
         "4fd14a94-7134-48d4-a10a-f9c4776d9673"]},
    "Conditions":
    {
        "LogicalOperator":"And",
        "Conditions":[{
            "Name": "LinkedTicket",
            "Operator":"Equals",
            "Value":"112870"}],
        "Groups":[]
    }
}

The mimimal allowed search request is {}. It returns the first 100 tickets, ordered by fullId.

Remarks: The properties clientId, dataId, objectGUID are always present. To get additional properties, add them with the select or selectAttributes parameter. The return object can contain more properties than specified. E.g. if "OwnerUser" is specified, the columns "OwnerUser" + "OwnerUserObjectGuid" will be returned. They are needed for internal purposes.

Operators:

Common search options are:

GeneralPrincipal

CreatorPrincipal

CreatorGroup

OwnerPrincipal

OwnerGroup

AffectedPrincipal

AffectedGroup

ResponsiblePrincipal

ResponsibleGroup

FollowerPrincipal

EditorPrincipal

CreationDate

Solution

SlmPriority

IdRange

TicketSchema

TicketField

TicketFieldAlias

AllFields

Status

StatusGroup

LastChange

LastUserChange

Comment

Ci

Message

Attachment

AllTicketData

TicketDataId

ServiceCatalog

Service

ServiceTransaction

ServicePortfolioObject

TicketFullId

Classification

TicketTitle

KbArticle

KbArticleInVersion

OriginTicket

ContainerTicket

LinkedTicket

ReachedStatus

KBArticleAssignment

CreationMethod

ConvertedFromTicketSchema

CreatedByM2TAccount

ConvertedTickets

CommentCount

IsDirectSolve

ExpensesCount

HasParent

MailsCount

SuccessorCount

AttachmentsCount

Times

Statuses

Fields

Counters

Creations

ServicePortfolio

SlmService

SlmContract

Slm

IsMyTicket

IsMarkedForRanking

 

Ticket 9

Create a new ticket.

api/tickets

Description: Creates a new tickets with ticket field values and starts the workflow. Take care that the ticket will be created asynchronous. Depending on your system, it can happen that the ticket is not yet completely initialized after loading it by the returned ID. E.g. the ticket will not have set a fullId. Try to load it again in that case.

Return type: TicketDto

Parameters:

Name Type Description Optional
createTicketModel CreateTicketModel Set the optional parameter OriginTicketObjectGuid to create a successor ticket. If the specified ticket schema is a process schema, you have to set the parameter ServiceTransactionDataId. No

Example:

Copy 
{
    "SchemeObjectGuid":"aba98218-810e-445e-8da4-d884ad9f2c5b",
     "AffectedUserObjectGuid":"0dad41ef-6ed3-40f1-8637-15c3c4695f64",
     "Fields": [
     {
        "ObjectGuid":"29684BDE-87A4-47BA-8DF8-494616878AAB",
         "Text":"any reason",
         "Value":"any value"
    } ],
     "Cis": ["14596c57-233a-4942-b8a4-dfb869eaa7a0"],
    "Files": [
    {
        "OriginalFileName": "myNewFile.xlsx",
        "MimeType": "application/octet-stream",
        "Content": [80,75,3,4,20,...]
    } ],
     "ServiceTransactionDataId": "1",
     "OriginTicketObjectGuid":"e198eeb0-a139-4d27-b5a2-e88a5c55609b"
}

Example url: http://.../webapi/api/tickets

 

Ticket 10

Get multiple tickets by data ID.

api/tickets/many

Description: Get multiple tickets by data ID.

Return type: TicketDto []

Parameters:

Name Type Description Optional
ticketDataIds number[] The ticket data IDs. No

Example url: http://...webapi/api/tickets/many

 

Ticket 11

Deletes the given ticket.

api/tickets/{ticketDataId}

Description: Deletes the given ticket.

Return type: IHttpActionResult

Parameters:

Name Type Description Optional
ticketDataId number   No

Example url: http://.../webapi/api/tickets/1

TicketSolution 1

Get external summary and solution.

api/tickets/{ticketDataId}/summaryAndSolution

Description: Gets the external summary and solution of the ticket.

Return type: SummaryAndSolutionDto

Parameters:

Name Type Description Optional
ticketDataId number   No

Example url: http://.../webapi/api/tickets/1/summaryAndSolution

 

TicketSolution 2

Get internal summary and solution.

api/tickets/{ticketDataId}/internalSummaryAndSolution

Description: Gets the internal summary and solution of the ticket.

Return type: SummaryAndSolutionDto

Parameters:

Name Type Description Optional
ticketDataId number   No

Example url: http://.../webapi/api/tickets/1/internalSummaryAndSolution

TicketSolution 3

Save ticket solution.

api/tickets/{ticketDataId:int}/summaryAndSolution

Description: Updates the external ticket summary and solution.

Return type: IHttpActionResult

Parameters:

Name Type Description Optional
ticketDataId number   No
summaryAndSolution SummaryAndSolutionDto   No
actionObjectGuid Guid   Yes

Example url: http://.../webapi/api/tickets/446/summaryAndSolution

TicketSolution 4

Save internal ticket solution.

api/tickets/{ticketDataId:int}/internalSummaryAndSolution

Description: Updates the internal ticket summary and solution.

Return type: IHttpActionResult

Parameters:

Name Type Description Optional
ticketDataId number   No
summaryAndSolution SummaryAndSolutionDto   No
actionObjectGuid Guid   Yes

Example url: http://.../webapi/api/tickets/446/internalSummaryAndSolution

TicketCis

Add CI to ticket.

api/tickets/{ticketDataId}/cis

Description: Adds a CI to a ticket.

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
ticketDataId number   No
ci AddCiToTicketModel A json object that contains the objectGUID of the CI that should be linked to the ticket. No

Example url: http://.../webapi/api/tickets/1/cis

TicketField 1

Get field values of a ticket.

api/tickets/{ticketDataId}/fields

Description: Get a list of ticket field values.

Return type: TicketFieldValueDto []

Parameters:

Name Type Description Optional
ticketDataId number   No

Example url: http://.../webapi/api/tickets/1/fields

 

TicketField 2

Set field values of a ticket.

api/tickets/{ticketDataId}/fields

Description: Set field values of a ticket. A ticket action of type edit ticket fields is required to be allowed to change fields. Provide the action object guid as a query parameter. The parameter actionObjectGuid may only be omitted for exactly one action. Additionally, edit permission is required for each ticket field. Fields without edit permission will be skipped without any warning. The result value contains a collection of field ids where the edit permission was granted.

Return type: Guid []

Return description: Returns the changed fields. Fields that were skipped because the user did not have permission are not part of the collection.

Parameters:

Name Type Description Optional
ticketDataId number   No
fields TicketFieldModel []   No
actionObjectGuid Guid   Yes

Example url: http://.../webapi/api/tickets/446/fields

TicketHistory 1

Get history items of a ticket.

api/tickets/{ticketDataId}/history

Description: Get a list of ticket history overview items of a particular ticket. History types that are excluded in the ticket schema configuration will not appear!

Return type: TicketHistoryItemDto []

Parameters:

Name Type Description Optional
ticketDataId number   No

Example url: http://.../webapi/api/tickets/1/history

 

TicketHistory 2

Get overview history items of a ticket.

api/tickets/{ticketDataId}/overviewhistory?elementTypes={elementTypes}

Description: Get a list of ticket history overview items of a particular ticket. History types that are excluded in the ticket schema configuration will not appear!

Return type: TicketHistoryOverviewItemDto []

Parameters:

Name Type Description Optional
ticketDataId number   No
elementTypes string   Yes

Example url: http://.../webapi/api/tickets/1/overviewhistory?elementTypes=attachment,comment

 

TicketHistory 3

Create static history entry.

api/tickets/{ticketDataId}/history

Description: With this method, a static text can be written into the history of the ticket. This text will not be localized. It appears only in the ticket history but not in the ticket history overview.

Return type: StatusCode

Return description: Returns status code 200 but no content.

Parameters:

Name Type Description Optional
ticketDataId number   No
content string Just a plain text string, enclosed by quotation marks. No

Example url: http://.../webapi/api/tickets/1/history

TicketSchema 1

Get all ticket schemas.

api/ticketschemes

Description: Get all ticket schemas.

Return type: TicketSchemaDto []

Example url: http://.../webapi/api/ticketschemes

 

TicketSchema 2

Gets a ticket schema by object guid.

api/ticketschemes/{schemeObjectGuid:guid}

Description: Get a visible ticket scheme by it's object guid. A schema is visible if the user has the view permission for at least one tab in the ticket dialog.

Return type: TicketSchemaDto

Parameters:

Name Type Description Optional
schemeObjectGuid Guid   No

Example url: http://.../webapi/api/ticketschemes/3c06a500-330f-44d6-bc3d-eda4a25ad774

 

TicketRelations

Get successor tickets.

api/tickets/{ticketDataId}/successorTickets

Description: Get successor tickets.

Return type: TicketDto []

Parameters:

Name Type Description Optional
ticketDataId number The ticket data ID No

Example url: http://.../webapi/api/tickets/1/successorTickets

TicketHyperlinks 1

Get edit link.

api/tickets/{ticketDataId}/editLink?username={username}

Description: The method provides the address for the browser to open a ticket in the editing mode.

Return type: string

Parameters:

Name Type Description Optional
ticketDataId number   No
username string   No

Example url: http://.../webapi/api/tickets/1/editLink?username=login_name_admin

 

TicketHyperlinks 2

Get workflow activities link.

api/tickets/{ticketDataId}/worfklowActivitiesLink?username={username}

Description: Provides the address for the browser to open a ticket's workfow activities page.

Return type: string

Parameters:

Name Type Description Optional
ticketDataId number   No
username string   No

Example url: http://.../webapi/api/tickets/1/worfklowActivitiesLink?username=login_name_admin

TicketSchemaFields 1

Get all ticket schema fields.

api/ticketschemes/{ticketSchemaDataId:int}/fields

Description: Get all visible fields of a ticket schema.

Return type: TicketSchemaFieldDto []

Parameters:

Name Type Description Optional
ticketSchemaDataId number   No

Example url: http://.../webapi/api/ticketschemes/446/fields

 

TicketSchemaFields 2

Get all ticket schema fields.

api/ticketschemes/{ticketSchemeGuid:Guid}/fields

Description: Get all visible fields of a ticket schema.

Return type: TicketSchemaFieldDto []

Parameters:

Name Type Description Optional
ticketSchemeGuid Guid   No

Example url: http://.../webapi/api/ticketschemes/b10eb0ff-92b7-4c61-b109-3e744fc2bf3f/fields

TicketComments

Create a ticket comment.

api/tickets/{ticketDataId}/comments?actionObjectGuid={actionId}

Description: Create a ticket comment.

Return type: IHttpActionResult

Parameters:

Name Type Description Optional
ticketDataId number   No
actionObjectGuid Guid   No
model CreateTicketCommentModel   No

Example url: http://.../webapi/api/tickets/1/comments?actionObjectGuid=B10EB0FF-92B7-4C61-B109-3E744FC2BF3F

Deputy 1

Gets all assigned deputies.

api/deputy

Description: Gets all user that are assigned as a deputy for the active user.

Return type: DeputyAssignmentDto []

Example url: http://.../webapi/api/deputy

 

Deputy 2

Gets the currently active assignment.

api/deputy/active

Description: Gets the user deputy assignment of the current user.

Return type: DeputyAssignmentDto

Example url: http://.../webapi/api/deputy/active

 

Deputy 3

Updates the currently logged in user with the selected deputy.

api/deputies/{dataId:int}/activate

Description: Activates a deputy assignment and returns the user Guid of the selected assignment.

Return type: Guid

Parameters:

Name Type Description Optional
dataId number   No

Example url: http://.../webapi/api/deputies/446/activate

 

User 1

Get a user by identifier (login name, objectGUID or data ID).

api/users/:identifier

Description: Get a user by identifier (login name, objectGUID or data ID).

Return type: UserDto

Parameters:

Name Type Description Optional
userIdentifier string The user identifier (login name, objectGUID or data ID). No

Example url: http://.../webapi/api/users/1

 

User 2

Get all groups where the given user is member of.

api/users/:identifier/ParentGroups

Description: Get all groups where the given user is member of.

Return type: GroupDto []

Parameters:

Name Type Description Optional
userIdentifier string The user identifier (login name, objectGUID or data ID). No

Example url: http://.../webapi/api/users/1/ParentGroups

 

User 3

Determines if a user has the given permission or not.

api/users/:identifier/IsAllowed?objectTypeGuid={Guid}&controlledObjectGuid={Guid}&permissionName={string}

Description: Determines if a user has the given permission or not.

Return type: boolean

Parameters:

Name Type Description Optional
userIdentifier string The identifier of the user (name, objectGUID or data ID) for which the right should be checked. No
objectTypeGuid Guid The GUID of the object type. No
controlledObjectGuid Guid The GUID of the controlled object. No
permissionName string The name of the permission that should be checked. No

Example url: http://.../webapi/api/users/{userIdentifier}/IsAllowed?objectTypeGuid=4D088E7E-3BB0-4DBA-B329-B1AF622AA83C&controlledObjectGuid=2F50627E-D522-4137-A474-E71CED371E57&permissionName=owning

 

User 4

Creates a new user.

api/users

Description: Creates a new user.

Return type: UserDto

Parameters:

Name Type Description Optional
model CreateUserModel The user object to create. No

Example url: http://.../webapi/api/users

 

User 5

Post a search request to retrieve a list of users.

api/users

Description: Post a search request to retrieve a list of users.

Return type: UserDto []

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
searchRequest UserSearchRequestDto The search request object. Add conditions to search for custom attributes within the users. Multiple conditions are possible. No

Example url: http://.../webapi/api/users/search

 

User 6

Deletes the given user.

api/users/:userIdentifier

Description: Deletes the given user.

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
userIdentifier string The identifier of the user (name, objectGUID or data ID). No

Example url: http://.../webapi/api/users/1

 

User 7

Updates an existing user.

api/users

Description: Updates an existing user. At least the properties Name and MainGroupObjectGuid must be set in the user data transfer object.

Return type: UserDto

Parameters:

Name Type Description Optional
userIdentifier string The identifier of the user (name, objectGUID or data ID) No
model UpdateUserModel The user data transfer object. At least the properties Name and MainGroupObjectGuid must be set. No

Example url: http://.../webapi/api/users

UserCustomAttribute 1

Gets all custom attributes of the given user.

api/users/:userIdentifier/CustomAttributes

Description: Gets all custom attributes of the given user.

Return type: CustomAttributeDto []

Parameters:

Name Type Description Optional
userIdentifier string The user identifier (name, objectGUID or data ID). No

Example url: http://.../webapi/api/users/1/CustomAttributes

 

UserCustomAttribute 2

Gets the value of certain custom attributes of the given user.

api/users/:userIdentifier/CustomAttributes/:attributeName

Description: Gets the value of certain custom attributes of the given user.

Return type: string

Parameters:

Name Type Description Optional
userIdentifier string The user identifier (name, objectGUID or data ID). No
attributeName string The name of the attribute. No

Example url: http://.../webapi/api/users/1/CustomAttributes/email

 

UserCustomAttribute 3

Sets the custom attributes for a given user.

api/users/{userIdentifier}/CustomAttributes

Description: Sets the custom attributes for a given user.

Return type: KeyValuePair []

Parameters:

Name Type Description Optional
userIdentifier string The user identifier (name, objectGUID or data ID). No
attributes KeyValuePair [] The list with attributes. No

Example url: http://.../webapi/api/users/1/CustomAttributes

 

UserCustomAttribute 4

Removes the custom attributes of the given user.

api/users/:userIdentifier/CustomAttributes/:attributeName

Description: Removes the custom attributes of the given user.

Return type: StatusCode

Return description: Returns only status code 200 but no content.

Parameters:

Name Type Description Optional
userIdentifier string The user identifier (name, objectGUID or data ID). No
attributeName string The name of the attribute. No

Example url: http://.../webapi/api/users/1/CustomAttributes/email

Workflow 1

Get a list of workflows.

api/workflows

Description: Get a list of workflows.

Return type: Workflow []

Example url: http://.../webapi/api/workflows

 

Workflow 2

Get a particular workflow.

api/workflows/{guid}

Description: Get a workflow by its objectGUID.

Return type: Workflow

Parameters:

Name Type Description Optional
objectGuid Guid   No

Example url: http://.../webapi/api/workflows/C7017741-E11D-469F-A1AB-1B046E8FBC99