GET v1/BackgroundActivities/{activityId}
User roles allowed to make this request:
DomainAdministrator
PowerUser
RegularUser
Supervisor
Scripter
LimitedUser
QuotaManager
LocalDomainManager
GlobalDomainManager
OperationsUser
SampleManager
RepositoryManager
DemoUser
All
Permissions required to make this request:
Activity.Read
This method retrieve details of a specific background activity.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
activityId |
The id of the background activity |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
The background activity with the specified ID.
Response Message
BackgroundActivityName | Description | Type | Additional information |
---|---|---|---|
ActivityId |
The id of the activity |
string |
None. |
Name |
The type of the activity |
string |
None. |
UserId |
The user ID of the user who started the activity |
string |
None. |
Status |
The status of the activity |
ActivityStatus |
None. |
CreationTime |
The time at which the activity was created |
date |
None. |
StartTime |
The time at which the activity was started |
date |
None. |
FinishTime |
The time at which the activity was finished |
date |
None. |
Response Formats
application/json, text/json
{ "ActivityId": "sample string 1", "Name": "sample string 2", "UserId": "sample string 3", "Status": 0, "CreationTime": "2024-09-05T20:16:51.0270047+00:00", "StartTime": "2024-09-05T20:16:51.0270047+00:00", "FinishTime": "2024-09-05T20:16:51.0270047+00:00" }
application/xml, text/xml
<BackgroundActivity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models"> <ActivityId>sample string 1</ActivityId> <CreationTime>2024-09-05T20:16:51.0270047+00:00</CreationTime> <FinishTime>2024-09-05T20:16:51.0270047+00:00</FinishTime> <Name>sample string 2</Name> <StartTime>2024-09-05T20:16:51.0270047+00:00</StartTime> <Status>Pending</Status> <UserId>sample string 3</UserId> </BackgroundActivity>