arcgis.apps.workforce module

Defines public exports for the workforce module.

The Project is the main entry point into the Workforce module. It can be used as shown in the following code example.

# Get a Project and search the assignments and workers.

import arcgis
gis = arcgis.gis.GIS("https://arcgis.com", "<username>", "<password>")
item = gis.content.get("<item-id>")
project = arcgis.apps.workforce.Project(item)
assignments = project.assignments.search()
workers = project.workers.search()

Assignment

class arcgis.apps.workforce.Assignment(project, feature=None, geometry=None, assignment_type=None, assigned_date=None, assignment_read=None, completed_date=None, declined_comment=None, declined_date=None, description=None, dispatcher=None, due_date=None, in_progress_date=None, location=None, notes=None, paused_date=None, priority='none', status=None, work_order_id=None, worker=None)

Represents an assignment

Argument Description
project Required Project. The project that this assignment belongs to.
feature Optional Feature. A feature containing the assignments attributes. Mostly intended for internal usage. If supplied, other parameters are ignored.
geometry Optional Dict. A dictionary containing the assignment geometry
assignment_type Optional AssignmentType. The assignment type that represents this assignment.
assigned_date Optional Date The date and time the assignment was assigned
assignment_read Optional Bool. A flag indicating that the mobile worker has seen the assignment
completed_date Optional Date. The date the assignment was completed
declined_comment Optional String. The comment submitted by the mobile worker.
declined_date Optional Date. The date the assignment was declined.
description Optional Description. The description associated with the assignment.
dispatcher Optional Dispatcher. The dispatcher that assigned/created the assignment.
due_date Optional Date. The date the assignment is due.
in_progress_date Optional Date. The date the assignment was started.
location Optional String. The location or address of the assignment.
notes Optional String. The notes associated with the assignment.
paused_date Optional Date. The date and time the assignment was paused.
priority

Optional String. The priority of the assignment

none, low, medium, high, critical

status

Optional String. The status of the assignment.

unassigned, assigned, in_progress, completed, declined, paused, canceled

work_order_id Optional String. The work order id associated with the assignment.
worker Optional Worker. The worker assigned to the assignment
assigned_date

Gets/Sets the assigned datetime of the assignment

assignment_read

Gets/Sets the assignment read field

assignment_type

Gets/Sets the AssignmentType

assignment_type_code

Gets the assignment type code

attachments

Gets the AssignmentAttachmentManager of the assignment

completed_date

Gets/Sets the completed datetime of the assignment

creation_date

The datetime at which the Feature was created.

creator

The named user that created the Feature.

declined_comment

Gets/Sets the declined comment of the assignment

declined_date

Gets/Sets the declined datetime of the assignment

delete()

Deletes the assignment from the server

description

Gets/Sets the description for the assignment

dispatcher

Gets/Sets the Dispatcher of the assignment

dispatcher_id

Gets the dispatcher id of the assignment

due_date

Gets/Sets the due datetime of the assignment

edit_date

The datetime at which the Feature was last edited.

editor

The named user that last edited the Feature.

feature

The Feature

geometry

Gets/Sets the geometry for the Feature.

global_id

The global id of the feature

id

The object id of the feature

in_progress_date

Gets/Sets the in progress datetime for the assignment

location

Gets/Sets the location of the assignment

notes

Gets/Sets the notes of the assignment

object_id

The object id of the feature

paused_date

Gets/Sets the paused datetime for the assignment

priority

Gets/Sets the String priority of the assignment

none, low, medium, high, critical

status
Gets/Sets the String status of the assignment

unassigned, assigned, in_progress, completed, declined, paused, canceled

update(geometry=None, assignment_type=None, assigned_date=None, assignment_read=None, completed_date=None, declined_comment=None, declined_date=None, description=None, dispatcher=None, due_date=None, in_progress_date=None, location=None, notes=None, paused_date=None, priority=None, status=None, work_order_id=None, worker=None)

Updates the assignment on the server

Argument Description
geometry Optional Dict. A dictionary containing the assignment geometry
assignment_type Optional AssignmentType. The assignment type that represents this assignment.
assigned_date Optional Date The date and time the assignment was assigned
assignment_read Optional Bool. A flag indicating that the mobile worker has seen the assignment
completed_date Optional Date. The date the assignment was completed
declined_comment Optional String. The comment submitted by the mobile worker.
declined_date Optional Date. The date the assignment was declined.
description Optional Description. The description associated with the assignment.
dispatcher Optional Dispatcher. The dispatcher that assigned/created the assignment.
due_date Optional Date. The date the assignment is due.
in_progress_date Optional Date. The date the assignment was started.
location Optional String. The location or address of the assignment.
notes Optional String. The notes associated with the assignment.
paused_date Optional Date. The date and time the assignment was paused.
priority

Optional String. The priority of the assignment

none, low, medium, high, critical

status

Optional String. The status of the assignment.

unassigned, assigned, in_progress, completed, declined, paused, canceled

work_order_id Optional String. The work order id associated with the assignment.
worker Optional Worker. The worker assigned to the assignment
work_order_id

Gets/Sets the work order id of the assignment

worker

Gets the Worker of the assignment

worker_id

Gets the worker id of the assignment

AssignmentType

class arcgis.apps.workforce.AssignmentType(project, coded_value=None, name=None)

Defines the acceptable values for Assignment types.

Argument Description
project Required Project. The project that this assignment belongs to.
coded_value Optional dict. The dictionary storing the code and name of the type.
name Optional String. The name of the assignment type.
code

Gets the internal code that uniquely identifies the assignment type

coded_value

Gets the coded value

delete()

Deletes the assignment type from the server

id

Gets the id of the assignment type

name

Gets/Sets The name of the assignment type

update(name=None)

Updates the assignment type on the server

Argument Description
name Optional String. The name of the assignment type

Attachment

class arcgis.apps.workforce.Attachment(assignment, attachment_info)

Represents a file attachment for an Assignment

Argument Description
assignment Required Assignment. The assignment object that this attachment belongs to
attachment_info Required dict. The attachment info dictionary representing the attachment.
attachment_info

Gets the attachment info of the attachment

content_type

Gets the attachment content type

download(out_folder=None)

Downloads the attachment to the specified path. If the path is omitted, the Attachment will be saved to the current working directory, using the name property as the filename. :param out_folder: The folder in which the attachment should be saved. Defaults to the current working directory.

Returns:The absolute path to the downloaded file.
global_id

Gets the attachment global id

id

Gets the attachment id

name

Gets the attachment name

project

Gets the project that the attachment belongs to

size

Gets the attachment size

Dispatcher

class arcgis.apps.workforce.Dispatcher(project, feature=None, contact_number=None, name=None, user_id=None)

Represents a dispatcher in a project.

Argument Description
project Required Project. The project that the dispatcher belongs to.
feature Optional Feature. The feature representing the dispatcher. Mostly intended for internal usage. If supplied, other parameters are ignored.
contact_number Optional String. The contact number of the dispatcher
name Optional String. The name of the dispatcher
user_id Optional String. The user id of the dispatcher
contact_number

Gets/Sets the contact number of the dispatcher

creation_date

The datetime at which the Feature was created.

creator

The named user that created the Feature.

delete()

Deletes the dispatcher from the server

edit_date

The datetime at which the Feature was last edited.

editor

The named user that last edited the Feature.

feature

The Feature

geometry

Gets/Sets the geometry for the Feature.

global_id

The global id of the feature

id

The object id of the feature

name

Gets/Sets the name of the dispatcher

object_id

The object id of the feature

update(contact_number=None, name=None, user_id=None)

Updates the dispatcher on the server

Argument Description
contact_number Optional String. The contact number of the dispatcher
name Optional String. The name of the dispatcher
user_id Optional String. The user id of the dispatcher
user_id

Gets/Sets the user id of the dispatcher

Project

class arcgis.apps.workforce.Project(item)

A Workforce Project

Argument Description
item Required Item. The item that the contains the project.
# Get a Project and search the assignments and workers.

import arcgis
gis = arcgis.gis.GIS("https://arcgis.com", "<username>", "<password>")
item = gis.content.get("<item-id>")
project = arcgis.apps.workforce.Project(item)
assignments = project.assignments.search()
workers = project.workers.search()
assignment_types

The AssignmentTypeManager for the project

assignments

The AssignmentManager for the project

assignments_item

The assignments Item

assignments_layer

The assignments FeatureLayer

assignments_layer_url

The assignments feature layer url

delete()

Deletes the project, group, folder, layers, and webmaps. Assumes the currently signed in user owns the project or is an admin.

dispatcher_web_map_id

The dispatcher webmap item id

dispatcher_webmap

The dispatcher WebMap for the project

dispatchers

The DispatcherManager for the project

dispatchers_item

The dispatchers Item

dispatchers_layer

The dispatchers FeatureLayer

dispatchers_layer_url

The dispatchers feature layer url

group

The Group that the project resources are part of

group_id

The group id that all project items are part of

id

The item id of the project

integrations

The AssignmentIntegrationManager for the project

owner

The owner User of the project

owner_user_id

The user id of the project owner.

summary

The title of the project

title

Gets the title of the project

tracks

The TrackManager for the project

tracks_item

The tracks Item

tracks_layer

The tracks FeatureLayer

tracks_layer_url

The tracks feature layer url

update(summary=None)

Updates the project on the server

Argument Description
summary Optional String. The summary of the project.
version

The version of the project

worker_web_map_id

The worker webmap item id

worker_webmap

The worker WebMap for the project

workers

The WorkerManager for the project

workers_item

The workers Item

workers_layer

The workers FeatureLayer

workers_layer_url

The workers feature layer url

Track

class arcgis.apps.workforce.Track(project, feature=None, geometry=None, accuracy=None)

Represents a track feature, which describes the historical location of a worker.

Argument Description
feature Optional Feature. A feature containing the assignments attributes. Mostly intended for internal usage. If supplied, other parameters are ignored.
geometry Optional Dict. A dictionary containing the assignment geometry
accuracy Optional Float. The accuracy of the point
accuracy

The horizontal accuracy of the location measurement, in meters.

creation_date

The datetime at which the Feature was created.

creator

The named user that created the Feature.

delete()

Deletes the track point on the server

edit_date

The datetime at which the Feature was last edited.

editor

The named user that last edited the Feature.

feature

The Feature

geometry

Gets/Sets the geometry for the Feature.

global_id

The global id of the feature

id

The object id of the feature

object_id

The object id of the feature

update(geometry=None, accuracy=None)

Updates the track point on the server

Argument Description
geometry Optional Dict. A dictionary containing the assignment geometry
accuracy Optional Float. The accuracy of the point

Worker

class arcgis.apps.workforce.Worker(project, feature=None, geometry=None, contact_number=None, name=None, notes=None, status='not_working', title=None, user_id=None)

Represents a worker in a Workforce Project

Argument Description
project Required Project. The project that the worker belongs to.
feature Optional Feature. The feature representing the worker. Mostly intended for internal usage. If supplied, other parameters are ignored.
geometry Optional Dict. The geometry of the worker.
contact_number Optional String. The contact number of the worker.
name Optional String. The name of the worker.
notes Optional String. The notes about the worker.
status

Optional String. The status of the worker.

not_working, working, on_break

title Optional String. The title of the worker.
user_id Optional String. The user id of the worker
contact_number

Gets/Sets the contact number of the worker

creation_date

The datetime at which the Feature was created.

creator

The named user that created the Feature.

delete()

Deletes the worker from the server

edit_date

The datetime at which the Feature was last edited.

editor

The named user that last edited the Feature.

feature

The Feature

geometry

Gets/Sets the geometry for the Feature.

global_id

The global id of the feature

id

The object id of the feature

name

Gets/Sets the name of the worker

notes

Gets/Sets the notes of the worker

object_id

The object id of the feature

status

Gets/Sets the String status of the worker

not_working, working, on_break

title

Gets/Sets the title of the worker

update(geometry=None, contact_number=None, name=None, notes=None, status=None, title=None, user_id=None)

Updates the worker on the server

Argument Description
geometry Optional Dict. The geometry of the worker.
contact_number Optional String. The contact number of the worker.
name Optional String. The name of the worker.
notes Optional String. The notes about the worker.
status

Optional String. The status of the worker.

not_working, working, on_break

title Optional String. The title of the worker.
user_id Optional String. The user id of the worker
user_id

Gets/Sets the user id of the worker