Version: iGovPortal v9.0

Activities API (v9.1)

Download OpenAPI specification:Download

Artionet: support@artionet.com URL: https://www.artionet.ch/

Welcome to the Activities API documentation.

You can test the API using Swagger.

You can find a detailed documentation by following this link.

Activities

Get a single activity

Allows to retrieve a specific activity identified by its Id.

path Parameters

activityId

required

integer <int32>

Activity Id

Responses

Response samples

Content type

application/json

{"id": 0,
"ownerId": "string",
"title": "string",
"body": "string",
"type": "string",
"target": "string",
"event": "string",
"module": "string",
"objectId": "string",
"businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
"serviceId": 0,
"relatedProfileId": 0,
"displayStamp": "2019-08-24T14:15:22Z",
"createdBy": "string",
"creationStamp": "2019-08-24T14:15:22Z"
}

Delete an activity

Allows to delete an existing activity.

path Parameters

activityId

required

integer <int32>

Activity Id

Responses

Response samples

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
"property1": null,
"property2": null
}

Get a list of activities

Allows to retrieve a list of activities (GET only) according to certain criteria.

query Parameters

OwnerId required	string Filters activities by `OwnerId` property (Profile ID from ePortal)
ServiceIds	Array of integers <int32> [ items <int32 > ] Filters activities by `ServiceId` property. Using the value `-1` includes the activities without `ServiceId`.
BusinessCaseId	string <uuid> Filters activities by `BusinessCaseId` property
Title	string Activities with `Title` containing this value
Targets	Array of strings Filters activities by `Target` property. Using the value `NONE` includes the activities without `Target`.
Types	Array of strings Filters activities by `Type` property. Using the value `NONE` includes the activities without `Type`.
Events	Array of strings Filters activities by `Event` property. Using the value `NONE` includes the activities without `Event`.
Modules	Array of strings Filters activities by `Module` property. Using the value `NONE` includes the activities without `Module`.
ObjectId	string Activities with `ObjectId` containing this exact value.
MinDisplayStamp	string <date-time> Activities with an earlier or equal `DisplayStamp`
MaxDisplayStamp	string <date-time> Activities with a later or equal `DisplayStamp`
MinCreationStamp	string <date-time> Activities with an earlier or equal `CreationStamp`
MaxCreationStamp	string <date-time> Activities with a later or equal `CreationStamp`
PageNumber	integer <int32> [ 1 .. 2147483647 ] Page number
PageSize	integer <int32> [ -1 .. 2147483647 ] Number of items per page. Using value `-1` disable pagination and gives all results at once.
OrderBy	string Sorting option. Usage (no square brackets !) : `orderBy=[property] [asc,desc],[property] [asc,desc],...`

Responses

Response samples

Content type

application/json

[{"id": 0,
"ownerId": "string",
"title": "string",
"body": "string",
"type": "string",
"target": "string",
"event": "string",
"module": "string",
"objectId": "string",
"businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
"serviceId": 0,
"relatedProfileId": 0,
"displayStamp": "2019-08-24T14:15:22Z",
"createdBy": "string",
"creationStamp": "2019-08-24T14:15:22Z"
}
]

Get a list of activities

Allows to retrieve a list of activities (GET only) according to certain criteria.

query Parameters

OwnerId required	string Filters activities by `OwnerId` property (Profile ID from ePortal)
ServiceIds	Array of integers <int32> [ items <int32 > ] Filters activities by `ServiceId` property. Using the value `-1` includes the activities without `ServiceId`.
BusinessCaseId	string <uuid> Filters activities by `BusinessCaseId` property
Title	string Activities with `Title` containing this value
Targets	Array of strings Filters activities by `Target` property. Using the value `NONE` includes the activities without `Target`.
Types	Array of strings Filters activities by `Type` property. Using the value `NONE` includes the activities without `Type`.
Events	Array of strings Filters activities by `Event` property. Using the value `NONE` includes the activities without `Event`.
Modules	Array of strings Filters activities by `Module` property. Using the value `NONE` includes the activities without `Module`.
ObjectId	string Activities with `ObjectId` containing this exact value.
MinDisplayStamp	string <date-time> Activities with an earlier or equal `DisplayStamp`
MaxDisplayStamp	string <date-time> Activities with a later or equal `DisplayStamp`
MinCreationStamp	string <date-time> Activities with an earlier or equal `CreationStamp`
MaxCreationStamp	string <date-time> Activities with a later or equal `CreationStamp`
PageNumber	integer <int32> [ 1 .. 2147483647 ] Page number
PageSize	integer <int32> [ -1 .. 2147483647 ] Number of items per page. Using value `-1` disable pagination and gives all results at once.
OrderBy	string Sorting option. Usage (no square brackets !) : `orderBy=[property] [asc,desc],[property] [asc,desc],...`

Responses

Response samples

Content type

application/json

[{"id": 0,
"ownerId": "string",
"title": "string",
"body": "string",
"type": "string",
"target": "string",
"event": "string",
"module": "string",
"objectId": "string",
"businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
"serviceId": 0,
"relatedProfileId": 0,
"displayStamp": "2019-08-24T14:15:22Z",
"createdBy": "string",
"creationStamp": "2019-08-24T14:15:22Z"
}
]

Create a new activity

Allows to create a new activity.

Request Body schema: application/json

Activity to create

ownerId required	string non-empty Owner's Profile ID (from ePortal)
title required	string non-empty Title of the activity
body	string or null Body message of this activity
type	string or null <= 60 characters Tag indicating the domain of the activity
target	string or null <= 60 characters Tag indicating who is targeted by this activity
event	string or null <= 255 characters Event that triggered this activity
module	string or null <= 255 characters Module emitting this activity
objectId	string or null <= 36 characters Identifier of an object related to this activity
businessCaseId	string or null <uuid> ID of the business case linked to this activity
serviceId	integer or null <int32> [ 1 .. 2147483647 ] ID of the prestation linked to this activity
relatedProfileId	integer or null <int32> Identifier of another profile related to this activity
displayStamp	string or null <date-time> Date displayed in the ePortal
createdBy	string or null <= 100 characters Default: "iGovPortalDefault" Author of this activity

Responses

Request samples

Payload

Content type

application/json

{"ownerId": "string",
"title": "string",
"body": "string",
"type": "string",
"target": "string",
"event": "string",
"module": "string",
"objectId": "string",
"businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
"serviceId": 1,
"relatedProfileId": 0,
"displayStamp": "2019-08-24T14:15:22Z",
"createdBy": "iGovPortalDefault"
}

Response samples

Content type

application/json

{"id": 0,
"ownerId": "string",
"title": "string",
"body": "string",
"type": "string",
"target": "string",
"event": "string",
"module": "string",
"objectId": "string",
"businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
"serviceId": 0,
"relatedProfileId": 0,
"displayStamp": "2019-08-24T14:15:22Z",
"createdBy": "string",
"creationStamp": "2019-08-24T14:15:22Z"
}

Delete activities by criteria

Allows to delete existing activities by criteria.

query Parameters

OwnerId required	string Profile Id from ePortal
Types	Array of strings Filters activities by `Type` property. Using the value `NONE` includes the activities without `Type`.

Responses

Response samples

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
"property1": null,
"property2": null
}

Activity Model

id	integer <int32> Unique ID of the activity
ownerId	string Owner's Profile ID (from ePortal)
title	string Title of the activity
body	string or null Body message of this activity
type	string or null Tag indicating the domain of the activity
target	string or null Tag indicating who is targeted by this activity
event	string or null Event that triggered this activity
module	string or null Module emitting this activity
objectId	string or null Identifier of an object related to this activity
businessCaseId	string or null <uuid> ID of the business case linked to this activity
serviceId	integer or null <int32> ID of the prestation linked to this activity
relatedProfileId	integer or null <int32> Identifier of another profile related to this activity
displayStamp	string <date-time> Date displayed in the ePortal
createdBy	string Author of this activity
creationStamp	string <date-time> Date of creation (API-sided) of this activity

{"id": 0,
"ownerId": "string",
"title": "string",
"body": "string",
"type": "string",
"target": "string",
"event": "string",
"module": "string",
"objectId": "string",
"businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
"serviceId": 0,
"relatedProfileId": 0,
"displayStamp": "2019-08-24T14:15:22Z",
"createdBy": "string",
"creationStamp": "2019-08-24T14:15:22Z"
}

Activity Creation Model

ownerId required	string non-empty Owner's Profile ID (from ePortal)
title required	string non-empty Title of the activity
body	string or null Body message of this activity
type	string or null <= 60 characters Tag indicating the domain of the activity
target	string or null <= 60 characters Tag indicating who is targeted by this activity
event	string or null <= 255 characters Event that triggered this activity
module	string or null <= 255 characters Module emitting this activity
objectId	string or null <= 36 characters Identifier of an object related to this activity
businessCaseId	string or null <uuid> ID of the business case linked to this activity
serviceId	integer or null <int32> [ 1 .. 2147483647 ] ID of the prestation linked to this activity
relatedProfileId	integer or null <int32> Identifier of another profile related to this activity
displayStamp	string or null <date-time> Date displayed in the ePortal
createdBy	string or null <= 100 characters Default: "iGovPortalDefault" Author of this activity

{"ownerId": "string",
"title": "string",
"body": "string",
"type": "string",
"target": "string",
"event": "string",
"module": "string",
"objectId": "string",
"businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
"serviceId": 1,
"relatedProfileId": 0,
"displayStamp": "2019-08-24T14:15:22Z",
"createdBy": "iGovPortalDefault"
}

Error Model

type	string or null URI that identifies the problem detail type
title	string or null A short human-readable summary about the problem
status	integer or null <int32> HTTP Status Code
detail	string or null A human-readable explanation about the problem
traceId	string <uuid> Guid to trace the error in the log files
property name* additional property	any

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
"property1": null,
"property2": null
}