Description:
Attempts to authenticate with the mobile API using BIM 360 Field credentials. On success, returns a 36 byte GUID "ticket" which needs to be passed in on subsequent calls.
Note: This API is deprecated. Please use /api/login_by_auth_token.
Status Codes:
200 User has authenticated and is successfully logged in.
401 The user's credentials have been rejected.
426 The user is a subcontractor on their active project, and login has been denied.
Description:
Attempts to authenticate with the mobile API using BIM 360 Field credentials. On success, returns a 36 byte GUID "ticket" which needs to be passed in on subsequent calls.
Status Codes:
200 User has authenticated and is successfully logged in.
401 The user's credentials have been rejected.
Description: Closes the current active session by expiring the ticket.
Access: FREEDescription: Returns a list of projects available to the currently authenticated user. If the authenticated user is a subcontractor on a project, that project will be excluded from this list.
Access: FREE
Description:
Returns a list of the currently authenticated user's preferences.
Description:
Retrieves information about the specified project.
Description:
Retrieves a list of checklist templates in the specified project.
Note: application_version should be more than 1.10 in order
to include rich content checklists (checklists with single-select and/or multi-select items)
Description:
Returns a list of areas in the specified project.
Note: application_version should be more than 4.7 in order to request the most recent version of the call.
Description:
Returns a list of companies in the specified project.
DEPRECATED .. backwards compatible support only! See GET /fieldapi/companies/v1
Description:
Returns a list of contacts in the specified project.
Description:
Returns a list of spec refs.
Description:
Returns a list of priorities.
Description:
Returns a list of checklist statuses.
DEPRECATED .. backwards compatible support only!
Description:
Returns a list of issue types.
DEPRECATED .. backwards compatible support only!
Description:
Returns a list of issue filters for the authenticated user.
Description:
Returns a list of custom field definitions defined for the entire project.
Each definition is comprised of:
custom_field_id : The primary key for the definition.
container_id : Used to identify the associated checklist in cases where container_type is 'Checklist'
container_type : Identifies the model object associated with the custom field definition. Can be one of Area, Checklist, ChecklistItemResponse, EquipmentType, Issue, Task
display_type : The object type stored for this definition. Can be one of drop-down, group_start, text, numeric, date, signature, single-select, multi-select, checkbox
default_value : The value substituted when no value is given.
required: True if this is a required custom field.
position : The ordinal position of this custom field relative to others.
updated_at : The date/time this record was last updated.
name : The name of the custom field definition
possible_values : YML serialized list of string values
Description:
Returns a list of all vela fields for a project.
Note: application_version should be more than 1.10 in order to include root causes
Description:
Returns a list of IDs for all voided issues in the project.
Description:
Returns a list of issues for the conditions specified, or the count if count_only is specified. All returned issues will contain
lists of any attachments, document_references, uri_references and comments.
Status Codes:
200 : The request was processed successfully.
401 : The authenticated user does not have permission to the specified issue filter.
404 : The specified issue filter ID does not exist.
Description:
Returns a list of issues that are attached to one or more objects (eg. Equipment, Tasks, Completed Checklist Items, etc). All returned issues will contain
lists of any attachments, document_references, uri_references, comments and signatures. The authenticated user must have read permission on Issues.
Status Codes:
200 : The request was processed successfully.
400 : The list of object IDs is empty, or an invalid object_type was passed in.
401 : The authenticated user does not have read permission on issues.
404 : The project ID is incorrect or the user is not on it.
Description:
Uploads a single signature.
The signature record must consist of the following fields:
id : The unique 36 byte string GUID of the signature
deleted : True if the signature should be deleted from the server.
custom_field_definition_id : The 36 byte GUID of the associated custom field definition for this signature
container_id : The 36 byte GUID of the associated parent object.
container_type : The type of parent object that the signature is associated with (Issue, CompletedChecklist, Task, Equipment).
filename : The name of the signature binary.
Status Codes:
200 : The request was processed successfully.
400 : The list of object IDs is empty, or an invalid object_type was passed in.
401 : The authenticated user does not have read permission on issues.
404 : The project ID is incorrect or the user is not on it.
Description:
Uploads an attachment, or asks the server to delete an existing attachment.
Input: "attachment"
The following shows a hash of attachment's details.{"filename":"cassie1.jpg","content_type":"image/jpeg","size":3723756,"created_at":"2014-11-05 11:01:23 -0500","updated_at":"2014-11-05 11:01:23 -0500","fcreate_date":"2014-11-05 11:01:23 -0500","fmod_date":"2014-11-05 11:01:23 -0500","container_id":"00000aac-0001-0000-0000-000000000001","container_type":"Issue"}
Description:
Uploads a document reference, or asks the server to delete an existing document reference.
Document Reference record Hash Keys:
id : The document reference's unique ID.
document_id : The 36 byte GUID of the parent document in the document library.
deleted : If set to true, will remove the document reference from the server.
num_pages : The number of pages that this document reference contains.
container_type : What type of object this document reference is connected to (Issue, Task, Equipment, CompletedChecklistItem, CompletedChecklist)
container_id : The id of the object this document refence is connected to.
content_type : The MIME content type of the document reference
markup : Any associated Vela Viewer markup. This must be sent as an array of SVG strings.
caption : A text caption for the document reference
tags : A comma-separated list of tags
Description: url: GET /api/download_markups
Return: [JSON] - [{id:'xxx-xxx', pages:[{id:'xxx-xxx', page_number:0, markups:[{id:'xxx-xxx',element_type:line, element_data:'xxxx', created-at:'2014-05-01'}]}]}]
Description:
Streams binary data for associated objects.
Status Codes:
200 : The request was processed successfully.
400 : The list of object IDs is empty, or an invalid object_type was passed in.
404 : The requested file does not exist, or cannot be streamed.
500 : The server encountered an error while streaming the file.
Description:
Returns one or more completed checklists.
Note: application_version should be more than 1.10 in order
to include rich content checklists (checklists with single-select and/or multi-select items)DEPRECATED .. backwards compatible support only! See GET /fieldapi/checklists/v1
Description:
Uploads one or more checklists.
Description:
Return completed checklist header data.
The data includes a deleted entry. If the deleted_at is not empty, the checklist was deleted and should be removedfrom the remote database.The data is an array containing JSON records including:
completed_checklist_id : The unique id for the checklist
checklist_template_id :
checklist_type :
identifier : The identifier of this executed checklist
name :
description :
created_by : Email address of the user creating the checklist
phase :
priority :
status :
tags : Any tags added
created_at : Date this was created
updated_at : Date this was updated
deleted : True if this has been deleted
Note: application_version should be more than 1.10 in order
to include rich content checklists (checklists with single-select and/or multi-select items)
Status Codes:
200 : The request was processed successfully.
Description:
Return the server time. This is used to track synchronization activities from Mobile.
The data is an array containing JSON records including:
current_date : The current date and time with timezone
Status Codes:
200 : The request was processed successfully.
Description:
Return categories and associated customizable categories for the project. This will include information about equipment types, equipment statuses, root causes, issue types and task types.
Returned JSON will consist of an array of categories and an array of customizable_categories
Description:
Retrieves equipment records from the server. Can retrieve just header information, or header and detail depending on the setting of the details parameter.
The step parameter can be used to retrieve equipment records matching certain criteria:headers : Return everything changed since max_date.
softdeletes : Use the list of passed in equipment_ids, but ignores max_date. Used to do a complete client refresh of existing equipment records.
updatedownloaded : Use the list of passed in equipment_ids to download equipment.
filter : Retrieve all pieces of equipment matching the filter specified by the filter_id parameter.
Note: application_version should be more than 1.9.2 in order to request the most recent version of the call.
Description: Upload new customizable categories.Actual use case is to send up new Root Causes created on mobile devices.
Input: "customizable_categories"
The following shows an array with two root causes. The first one is to be added and the second one to be modified.[{"id":"ABBAABBA-ABBA-ABBA-ABBA-100042000001","new_record":true,"name":"Earthquake","position":2,"category_id":"c9038767-f4cd-4aa8-8343-65d80482d97e","created_at":"2011-02-07 12:37:21 EST","uploaded_at":"","updated_at":"2011-02-07 12:37:21 EST"},{"id":"7a12868e-ebdc-4a89-acd3-cb33cb0369d5","new_record":false,"name":"Flood","position":"1","category_id":"c9038767-f4cd-4aa8-8343-65d80482d97e"}]
Description:
Upload one or more Equipment records. This call can ONLY update existing pieces of equipment. Equipment MUST be created on Vela Web before it canbe manipulated through the API.
The equipment parameter is a complete JSON representation of a record.
Each item in the equipment array is comprised of the following fields:
id : The 36 byte GUID of the equipment record.
name : The human readable name of the piece of equipment.
description : The description of the equipment.
serial_number : The equipment's serial number.
created_by : The email address of the user that created the piece of equipment. Cannot be changed.
tag_number : A tag number for the piece of equipment.
barcode : A barcode number for the piece of equipment.
asset_identifier : An asset identifier for the piece of equipment.
purchase_order : A P.O. associated with the piece of equipment.
submittal : A submittal for the piece of equipment.
purchase_date : The date the piece of equipment was puchased (YYYY-MM-DD).
install_date : The date the piece of equipment was installed (YYYY-MM-DD).
warranty_start_date : The date the warranty for the piece of equipment started (YYYY-MM-DD).
warranty_end_date : The date the warranty for the piece of equipment ends (YYYY-MM-DD).
expected_life : The expected lifetime of the equipment in years.
area_id : The 36 byte GUID of the area that the piece of equipment is located in.
bim_file_id : The 36 byte GUID of the associated BIM model file.
bim_object_identifier : The identifier of the associated BIM model object.
source : Set to 'vfm'.
updated_at : The date/time that the record was updated (YYYY-MM-DD HH:MM:SS).
equipment_type_id : The 36 byte GUID of the associated equipment type. Equipment types can be retrieved from /api/customizable_categories.
equipment_status_id : The 36 byte GUID of the associated equipment status. Equipment statuses can be retrieved from /api/get_categories.
Equipment may also have custom fields associated with them. If so, they can be attached to the equipment record as an array of custom_field_values.
{'equipment' : [{'id' : '{GUID}', ..., 'custom_field_values' : [{'id' : '{CUSTOM FIELD VALUE GUID}', 'custom_field_definition_id' : '', 'container_id' : '','container_type' : '', 'value' : ''}]}]}
Each custom field value has the following fields:
id : The 36 byte GUID of the custom field value.
custom_field_definition_id : The 36 byte GUID of the parent custom field definition.
container_id : In this case, it points to the piece of equipment that it's associated with, so it would be the equipment's 36 byte GUID.
container_type : In this case, it would be 'Equipment'.
value : The value of the custom field.
Comments can be added to equipment in a similar way using an array of 'comment' objects. Each comment has the following fields:
id : The 36 byte GUID of the comment.
comment_text : The text of the comment.
object_id : In this case, it points to the piece of equipment that it's associated with, so it would be the equipment's 36 byte GUID.
created_at : The date/time that the comment was created (YYYY-MM-DD HH:MM:SS).
Description:
Return a set of Task objects from a project. Includes comments, audits, signatures, attachments, uri references, custom field values,checklist templates, completed checklists, document references and document folder references.The filter_id comes from the list of filters contained in the project objects (/api/projects). Be sure to only pass IDs of filterswith a container of 'Task'.
Status Codes:
200 Tasks have been returned successfully
Description:
Return a set of Task template objects from a project. Includes comments, audits, signatures, attachments, uri references, custom field values,checklist templates, completed checklists, document references and document folder references.
Status Codes:
200 Task templates have been returned successfully
Description:
Upload and either create or update one or more Tasks or Task templates to the server. If the ID of the Task/template already exists, the record will be updated.
Each item in the tasks array is comprised of the following fields:
id : The 36 byte GUID of the task/template record.
created_at : The date/time that the record was created (YYYY-MM-DD HH:MM:SS).
updated_at : The date/time that the record was updated (YYYY-MM-DD HH:MM:SS).
template : Set to 'true' if this is a Task template. Leave blank for Tasks.
identifier : The Task's human-readable identifier.
description : The description of the Task.
status : The status of the Task.
company_id : The ID of the company associated with the Task.
assigned_user_id : The ID of the user assigned to complete the Task.
location_detail : A free-form string giving clear instructions as to the location associated with the Task.
send_reminders : Set to 'true' if you would like reminders to be sent regarding this Task. Leave blank otherwise.
scheduled_at : The date and time the Task is scheduled to be completed (YYYY-MM-DD HH:MM:SS).
name : A descriptive name for the Task.
task_types : A JSON collection of task type IDs to associate with this Task/template. Each task type is specified using 'customizable_category_id'.
areas : A JSON collection of location IDs to associate with this Task/template. Each location is specified using 'area_id'.
checklists : A JSON collection of checklist IDs to associate with this Task/template. Each checklist is specified using 'checklist_id'.
comments : A JSON collection of comments to associate with this Task/template.
custom_field_values : A JSON collection of custom field values to associate with this Task/template.
uri_references : A JSON collection of uri references to associate with this Task/template.
document_folder_references : A JSON collection of document folder references to associate with this Task/template.
Attachments and Document References may be associated with this Task/template by using the /api/attachments and /api/document_references calls and setting the container_id to the ID of the Task/template, and the container_type to 'Task'.
Status Codes:
200 Task templates have been returned successfully
Description:
Retrieves photo records from the server. The result will contain only photo metadata and will not include the actual image binary.
Note: both limit and offset parameters are required for pagination. Also, application_version should be more than or equal to 4.7 in order to filter by max_updated_at.
Description:
Returns a list of all vela fields for a project.
Note: application_version should be more than 1.10 in order to include root causes
Description:
Returns a list of custom field definitions defined for the entire project.
Each definition is comprised of:
custom_field_id : The primary key for the definition.
container_id : Used to identify the associated checklist in cases where container_type is 'Checklist'
container_type : Identifies the model object associated with the custom field definition. Can be one of Area, Checklist, ChecklistItemResponse, EquipmentType, Issue, Task
display_type : The object type stored for this definition. Can be one of drop-down, group_start, text, numeric, date, signature, single-select, multi-select, checkbox
default_value : The value substituted when no value is given.
required: True if this is a required custom field.
position : The ordinal position of this custom field relative to others.
updated_at : The date/time this record was last updated.
name : The name of the custom field definition
possible_values : YML serialized list of string values
Description:
Uploads one or more checklists.
Description:
Upload and either create or update one or more Tasks or Task templates to the server. If the ID of the Task/template already exists, the record will be updated.
Each item in the tasks array is comprised of the following fields:
id : The 36 byte GUID of the task/template record.
created_at : The date/time that the record was created (YYYY-MM-DD HH:MM:SS).
updated_at : The date/time that the record was updated (YYYY-MM-DD HH:MM:SS).
template : Set to 'true' if this is a Task template. Leave blank for Tasks.
identifier : The Task's human-readable identifier.
description : The description of the Task.
status : The status of the Task.
company_id : The ID of the company associated with the Task.
assigned_user_id : The ID of the user assigned to complete the Task.
location_detail : A free-form string giving clear instructions as to the location associated with the Task.
send_reminders : Set to 'true' if you would like reminders to be sent regarding this Task. Leave blank otherwise.
scheduled_at : The date and time the Task is scheduled to be completed (YYYY-MM-DD HH:MM:SS).
name : A descriptive name for the Task.
task_types : A JSON collection of task type IDs to associate with this Task/template. Each task type is specified using 'customizable_category_id'.
areas : A JSON collection of location IDs to associate with this Task/template. Each location is specified using 'area_id'.
checklists : A JSON collection of checklist IDs to associate with this Task/template. Each checklist is specified using 'checklist_id'.
comments : A JSON collection of comments to associate with this Task/template.
custom_field_values : A JSON collection of custom field values to associate with this Task/template.
uri_references : A JSON collection of uri references to associate with this Task/template.
document_folder_references : A JSON collection of document folder references to associate with this Task/template.
Attachments and Document References may be associated with this Task/template by using the /api/attachments and /api/document_references calls and setting the container_id to the ID of the Task/template, and the container_type to 'Task'.
Status Codes:
200 Task templates have been returned successfully
Description: Publishes a document into a project's library. The document can be published either as a new revision to an existing document, or as a new document.If a document already exists with the given directory and name, a new revision of the existing document will be created.To publish a new revision, you can specify a document_id of the base document id if it has revisions already.
Example of publishing a revision (using CURL):
curl -s -X POST https://bim360field.autodesk.com/api/library/publish \
Description:
Retrieves a listing of document metdata. If the directory parameter is specified, only documents from that directory will be returned. Otherwise, metadata from all documents will be returned.Documents in processing mode will be skipped.
Status Codes:
200 The document metadata has been successfully retrieved. The JSON response contains the metadata.
Description:
Retrieves all documents metadata for the project including pending and processing documents.
Status Codes:
200 The document metadata has been successfully retrieved. The JSON response contains the metadata.
Description:
Retrieves all path information for a project's document library.Does not include the internal use only folders for model and photo storage.
Status Codes:
200 The path metadata has been successfully retrieved. The JSON response contains the metadata.
Example Result:
[{ "path":"Building One" },{ "path":"Building One/Floor One"},{ "path":"Building One/Floor One/Room 311"},{ "path":"Security Booth" }]
Description:
Delete's either a specific revision of a document, or all revisions of a document.
Status Codes:
200 The document metadata has been successfully retrieved. The JSON response contains the metadata.
404 The document with the ID specified could not be found.
Description:
Deletes all revisions of documents.
Status Codes:
200 The document metadata has been successfully retrieved. The JSON response contains the metadata.
404 The document with the ID specified could not be found.
Description:
Creates the folder including any necessary parent folders.
Status Codes:
OK 200 The requested information has been returned successfully.
BAD REQUEST 400 The change was not valid.UNAUTHORIZED 403 TThe user is not a document manager or project admin.
Example Result:
{ "path":"Building One/Floor Two", "id":"....."}
Access:
FREE
Description:
Move or rename the folder.
Status Codes:
OK 200 The requested information has been returned successfully.
BAD REQUEST 400 The change was not valid.UNAUTHORIZED 403 TThe user is not a document manager or project admin.NOT FOUND 404 The requested folder cannot be found.
Example Result:
{ "path":"Building One/Floor 2", "id":"....."}In the event of errors, an array of strings will be returned with detailed validation failures.
Access:
FREE
Description:
Removes the folder. Removes all documents and subfolders along with all associated document references, markups, and pushpins!
Status Codes:
200 The requested information has been returned successfully.
400 The change was not valid.403 TThe user is not a document manager or project admin.404 The requested document or folder cannot be found.
Example Result:
{ "documents_deleted":42 }
Access:
FREE
Description:
Returns the folders for the current project, arranged in hierarchy.
Status Codes:
200 The requested information has been returned successfully.
500 The change was not valid.
Example Result:
[{"id": "91992417-2fa9-4632-9a98-0d0f7e90954e","name": "API_Rails3","child_count": 1,"document_count": 0,"thumbnail_document_id": null,"folders": [{"id": "7137698d-d653-431e-b0f9-d026b9adfe7f","name": "Folder1","child_count": 1,"document_count": 0,"thumbnail_document_id": null,"folders": [{"id": "3759a9d8-8874-433c-b324-c546a89187fb","name": "Folder1-1","child_count": 1,"document_count": 1,"thumbnail_document_id": null,"folders": []}]}]}]
Description:
Returns information about a document in the library. It can return images, metadata, the original document as well as everything.Status Codes:
200 The requested information has been returned successfully.
404 The requested document could not be found.
Description:
Change the documents name from the current value to the new value. The new value cannot include angle brackets or forward or reverse slashes. The extension, if supplied, should match the existing extension. If unsupplied, the existing extension will be added.
Status Codes:
200 The requested information has been returned successfully.
201 The document was already named this.
400 The change was not valid.403 TThe user is not a document manager or project admin.404 The requested document could not be found.
Description:
Move the document to another folder. If folder is blank, the document will move to the Top Level.
Status Codes:
200 The requested information has been returned successfully.
400 The change was not valid.403 The user is not a document manager or project admin.404 The requested document or folder cannot be found.
Description:
Retrieves a listing of document metdata. If the directory parameter is specified, only documents from that directory will be returned. Otherwise, metadata from all documents will be returned.Documents in processing mode will be skipped.
Status Codes:
200 The document metadata has been successfully retrieved. The JSON response contains the metadata.
Description:
Retrieves all documents metadata for the project including pending and processing documents.
Status Codes:
200 The document metadata has been successfully retrieved. The JSON response contains the metadata.
Description:
This call will let you retrieve the chronologically last set of export files for a project. It returns a JSON array of hashes containing thefollowing keys:
url: The direct S3 url to the file. This is a pre-signed, time limited (24hrs) URL. Do not store or modify it.If you need repeated access to these URLs, make calls to this API to retrieve them.
type: The type of export file. Will either be 'database' or 'files'
Example:
GET https://bim360field.autodesk.com/api/latest_project_export/9653a0d9-89a8-11e1-a97a-f6991ab64229?ticket=51d52ad8-5e66-11e2-8322-6f5147705d7f
[{"type":"database","url":"https://s3.amazonaws.com/b3f_staging_project_exports/exports/00000000-1000-0000-0101-000000000001/9653a0d9-89a8-11e1-a97a-f6991ab64229_20130108.zip?AWSAccessKeyId=AKIAIICA2ZV6DG6M5RWA&Expires=1358181932&Signature=OxLyyeOXmuGvdrq6zoqeGEkMpFc%3D&response-content-type=application%2Fzip"},
{"type":"files","url":"https://s3.amazonaws.com/b3f_staging_project_exports/exports/00000000-1000-0000-0101-000000000001/9653a0d9-89a8-11e1-a97a-f6991ab64229_files_20130108.zip?AWSAccessKeyId=AKIAIICA2ZV6DG6M5RWA&Expires=1358181932&Signature=e7Y2XYRYqXT1Q2ecck2IOcxSQao%3D&response-content-type=application%2Fzip"}]
Status Codes:
200 Export files or empty array has been returned successfully.
401 The user's credentials have been rejected.
404 The project is not found or has not been selected for exports.
Description:
This call returns a JSON structued block of information on the status of a given project's export. Data includes:
export_running: True if the export is currently being processed.
last_export_succeeded: True if the last export was successful.
last_export_at: The date and time of the end of the last export.
Example:
GET https://bim360field.autodesk.com/api/project_export_status/9653a0d9-89a8-11e1-a97a-f6991ab64229?ticket=51d52ad8-5e66-11e2-8322-6f5147705d7f
{"export_running"=>false,"last_export_at"=>"2013-04-08T17:58:53Z","last_export_succeeded"=>true}Status Codes:
200 Export files or empty array has been returned successfully.
401 The user's credentials have been rejected.
404 The project is not found or has not been selected for exports.
Description:
The Autodesk BIM 360 Field Admin API offers project-wide and account-wide operations.It complements more specific APIs that are focused on core BIM 360 Field Services such as Issues.
Some calls here are account-wide and do not require a project to be identified.
Other calls in this API take a project identity and, based on the permissions of the effectiveuser, will return information about the project. This is used by a calling application to determinethe list of related locations, companies, users and other information associated to a project andthe internal identity of those resources.
Access: FREEDescription:
Send a message to the server to ensure it is up and running. This method will require you to be authenticatedin large part to satisfy ensuring credentials are sound without other action.
If the system is unreachable, the client HTTP library will indicate such perhaps after a timeout. If authenticationfailure results, the client still can be assurred the BIM 360 Field system is processing requests.
Status Codes:
200 OK Success.Example Result:
I;200;Successful Access: FREEDescription:
Return a list of project names and project identifiers that are associated with the account.
As with all other calls related to multiple projects, the account in question is that which the user identifiedin the authorization parameters refers to.
Status Codes:
200 OK Success.Example Result:
[{"id" : "12345678-12312-12313-1231312","name" : "Daniel's SNout House","a360_project_id" : null,"updated_at" : "2013-07-10T12:30:10Z","include_in_reports" : true},{"id" : "67236712-23112-87777-9999991","name" : Zip Energy Center - Cx","a360_project_id" : "ABC123GHI","updated_at" : "2013-07-10T12:30:10Z","include_in_reports" : true}]
Access:
FREE
Description:
Return a list of locations and location ids for the given project.
Status Codes:
200 OK Success.Example Result:
[{"full_path":"Building Two","path":"","name":"Building Two","identifier":"","id":"00000000-0001-0000-0000-afea10000003","parent_id": null,"deleted": 0},{"full_path":"Building Two>Floor Two","path":"Building Two","name":"Floor Two","identifier":"","id":"00000000-0002-0000-0000-afea20000001","parent_id":"00000000-0001-0000-0000-afea10000003","deleted": 0},{"full_path":"Mezzanine","path":null,"name":"Mezzanine","identifier":"","id":"00000000-0001-0000-0000-feeb00000000","parent_id":null,"deleted": 0},{"full_path":"Office","path":"","name":"Office","identifier":"","id":"00000000-0004-0000-0000-afea20000001","parent_id":null,"deleted": 0},{"full_path":"VIP Lounge","path":null,"name":"VIP Lounge","identifier":"","id":"00000000-0001-0000-0000-feeb00000001","parent_id": null,"deleted": 0}]
Access:
FREE
Description:
Return all information about companies that are registered to the given project.Companies have a unique id supplied by BIM 360 Field. Each user in a project isassigned a single company.
Status Codes:
200 OK Success.Example Result:
[{"account_company":true,"address":{"country":"US","address3":null,"postal_code":"56000","county":null,"latitude":null,"city":"Sioux Falls","address2":null,"state":"SD","longitude":null,"address1":"7 Emeritus St"},"url":"www.testaccount.com","duns_no":null,"ein_no":null,"telephone":null,"company_type":"","name":"Test Account Company","fax":null,"description":null,"company_category":"Contractor","id":"f47f034f-b727-11e1-9edf-ad27ba32cc68"},{"account_company":false,"address":{"country":"US","address3":null,"postal_code":"98496","county":null,"latitude":null,"city":"Lakewood","address2":null,"state":"WA","longitude":null,"address1":"PO Box 39439 "},"url":null,"duns_no":null,"ein_no":null,"telephone":"253-474-5356","company_type":"Other","name":"Benson Industries","fax":"253-474-3529","description":"Doors, Frames, & Hardware Supply","company_category":"Contractor","id":"31b31580-17b2-11e2-9453-24b41a66b040"}]
Access:
FREE
Description:
Return all information about users that are registered to the given project.Users are uniquely identified by email address. The company the user is relatedto is included in name and in identifier. User physical contact informationis included as well.
A user in BIM 360 Field is always associated with one company on the project. A useralso has several roles including:Status Codes:
200 OK Success.Example Result:
[{"roles":"project_admin,document_manager,contractor","company":{"id":f47f034f-b727-11e1-9edf-ad27ba32cc68","name":"Gaylord Focker, Inc."},"junior":false,"first_name":"test","telephone":null,"email":"testadmin@gmail.com","last_name":"admin","id":"f47f035a-b727-11e1-9edf-ad27ba32cc68"}]
Access:
FREE
Description:
Create a custom field. This is an additional field on a core object. The field will be given a generatedidentifier. This identifier is allowed for use in definining fields when, for instance, adding or updatingan issue. Core objects categories include:
A custom field also allowed to optionally be associated only with a certain, specific sub-category. This isspecific to a given category in definition. For example, if a sub-category is given as the id of anthen the custom field is only for that particular form. Similar options exist to isolate to checklistheaders, etc.
Note this requires the authenticated account to be in the project administrator system role within BIM 360 Field.
Status Codes:
200 OK Success.Example Result:
{"id":f47f034f-b727-0000-9edf-ad27ba32cc68","name":"Inspector On Duty","category":"Issue"}
Access:
FREE
Description:
Destroy the identified project.
Note this requires the authenticated account to be in the project administrator system role within BIM 360 Field.
NOTE: This cannot be undone so exercise caution in use of this method.
Status Codes:
200 OK Success.Example Result:
none Access: FREEDescription:
Retrieve the set of existing Filters for the project. If a category is specified, such as Issue, only thosefilters will be returned.
Status Codes:
200 OK Success.Example Result:
TBD Access: FREEDescription:
The Autodesk BIM 360 Field Issues API offers access to create, search, retrieve and update Issues.
There are core APIs for the actual creation and update as well as specific APIs to accessthe ids for information related to an Issue such as the formal type.
Use the BIM 360 Field Admin API to get information related to project-wide data that isbeyond the scope of issues such as the locations, users or companies associated with a project.
Access: FREEDescription:
In BIM 360 Field every Issue is of a given Issue Type. This is a two-levelheirarchy of a given Process or Category of types and a more specifictype of issue.
An example of this might an Infraction as a specific type within theoveral Safety category. Other items in Safety might include Observation.
Categories and types are specific to a project, though many are commonly used, and can beconfigured.
Status Codes:
200 OK Success.Example Result:
[{"category_name":"Punch List","name":"Punch List","id":"f498d0ed-0be0-11e2-9694-14f6960d7e4f"},{"category_name":"Punch List","name":"Pre-Punch List","id":"f498d0f7-0be0-11e2-9694-14f6960d7e4f"},{"category_name":"Punch List","name":"Issue","id":"f498d0f8-0be0-11e2-9694-14f6960d7e4f"},{"category_name":"Work List","name":"Concealment of Work/Closure","id":"f498d11f-0be0-11e2-9694-14f6960d7e4f"},{"category_name":"Work List","name":"Work to Complete List","id":"f498d120-0be0-11e2-9694-14f6960d7e4f"},{"category_name":"QA/QC","name":"Conforming","id":"f498d12a-0be0-11e2-9694-14f6960d7e4f"},{"category_name":"Safety","name":"Safety Infraction","id":"f498d133-0be0-11e2-9694-14f6960d7e4f"},{"category_name":"Safety","name":"Safety Conforming","id":"f498d13a-0be0-11e2-9694-14f6960d7e4f"},{"category_name":"Safety","name":"Safety Non-conforming","id":"f498d13b-0be0-11e2-9694-14f6960d7e4f"},{"category_name":"Commissioning","name":"Commissioning","id":"f4e47249-0be0-11e2-9694-14f6960d7e4f"}]
Access:
FREE
Description:
Create a new Issue Type in the project. If the top-level Category exists, re-useit otherwise create a new one.
Status Codes:
200 OK Success, type existed.Example Result:
{"category_name":"Clash","name":"Clearence","id":"058ba013-42eb-11e2-b406-80c45664f08a"}Description:
Destroy a given Issue Type. In doing so, any Issues assigned to that type must be changed so specifyan alternative Issue Type to assign them to. All types are identified by identifier.
Status Codes:
200 OK Success, type existed.Example Result:
I;200;SuccessfulDescription:
BIM 360 Field includes various standard fields. The visibility of these fields can be controlledallowing a project to either take advantage of them or to hide them to simply the interface. Thiscall will enable a field for view/edit procgramatically.
NOTE: When a field is shown, or hidden, the data remains within the BIM 360 Field system.
Status Codes:
200 OK Success, type existed.Example Result:
I;200;SuccessfulDescription:
BIM 360 Field includes various standard fields. The visibility of these fields can be controlledallowing a project to either take advantage of them or to hide them to simply the interface. Thiscall will disable a field for view/edit procgramatically.
NOTE: When a field is shown, or hidden, the data remains within the BIM 360 Field system.
Status Codes:
200 OK Success, type existed.Example Result:
I;200;SuccessfulDescription:
Return the fields for a given project. Includes the type-specific fields
Element arrays have built in position values that are offset to allow universal ordering. These offsets are:
10000-19999 = common fields (identifier, description, et al.)
20000-29999 = global common fields for all issue types
30000-39999 = common fields specifically for a given type
40000-49999 = ancillary common fields (backcharge, crew, et al.)
Status Codes:
200 OK Success, type existed.Example Result:
{"common":{"fields":[{"display_type":"drop-down","required":true,"position":10001,"name":"Issue type","possible_values":[],"id":"f--issue_type_id"},{"display_type":"text","required":true,"position":10002,"name":"Identifier","possible_values":[],"id":"f--identifier"},{"display_type":"text","required":true,"position":10003,"name":"Description","possible_values":[],"id":"f--description"},{"display_type":"drop-down","required":false,"position":10004,"name":"Responsible company","possible_values":[],"id":"f--responsible_company_id"},{"display_type":"drop-down","required":false,"position":10005,"name":"Priority","possible_values":["","Low","Medium","High","Critical"],"id":"f--priority"},{"display_type":"drop-down","required":false,"position":10006,"name":"Status","possible_values":["Draft","Open","Work Completed","Ready to Inspect","Not Approved","In Dispute","Closed","Void"],"id":"f--status"},{"display_type":"drop-down","required":false,"position":10007,"name":"Area","possible_values":[],"id":"f--area_id"},{"display_type":"text","required":false,"position":10008,"name":"Location detail","possible_values":[],"id":"f--location_detail"},{"display_type":"drop-down","required":false,"position":20001,"name":"Beverage of Choice","possible_values":["","Beer","Wine","Vodka"],"id":"cf--6b0def36-0bfb-11e2-9694-14f6960d7e4f"}]},"category":"Safety","fields":[{"display_type":"date","required":false,"position":30001,"name":"Occurrence Date","possible_values":[],"id":"cf--204a2088-1799-11e2-9453-24b41a66b040"},{"display_type":"text","required":true,"position":30002,"name":"Observers","possible_values":[],"id":"cf--204a2090-1799-11e2-9453-24b41a66b040"},{"display_type":"signature","required":true,"position":30003,"name":"Closing Authority","possible_values":[],"id":"cf--204a2091-1799-11e2-9453-24b41a66b040"}],"name":"Safety Incident","id":"f498d134-0be0-11e2-9694-14f6960d7e4f"},"ancillary":{"fields":[{"display_type":"numeric","required":false,"name":"Labor hours","possible_values":[],"id":"f--labor_hours"}]}}Description:
Return the codes, names, categories and ids for the root causes for the project.
Root causes are, like Issue Types, a two tier categorized element affording grouping of like causes undera common heading.
Status Codes:
200 OK Success, type existed.Example Result:
[{"category_name":"Human","name":"Drunk","id":"99b432f1-13e2-11e2-9453-24b41a66b040"},{"category_name":"Human","name":"Stupid","id":"99b432f2-13e2-11e2-9453-24b41a66b040"},{"category_name":"Human","name":"Lazy","id":"99b432f3-13e2-11e2-9453-24b41a66b040"},{"category_name":"Machine","name":"Gears","id":"99b432fc-13e2-11e2-9453-24b41a66b040"},{"category_name":"Machine","name":"Smell Bad","id":"99b432fd-13e2-11e2-9453-24b41a66b040"}]Description:
Returns the complete Issue record.
Status Codes:
200 OK Success.Example Result:
[{"id":"00000aac-0001-0000-0000-00000000000b","created_by":"quentin@example.org","fields":[{"id":"f--identifier","name":"Identifier","display_type":"text","value":"austinpowers"},{"id":"f--issue_type_id","name":"Issue type","display_type":"issue_type_id","value":"f498d0f5-0be0-11e2-9694-14f6960d7e4f"},{"id":"f--responsible_company_id","name":"Responsible company","display_type":"company_id","value":"9bd63e4b-115b-11e2-a378-760dde346a75"},{"id":"f--description","name":"Description","display_type":"text","value":"mr powers is afraid of circus-folk"},{"id":"f--status","name":"Status","display_type":"drop-down","value":"Work Completed"},{"id":"f--area_id","name":"Location","display_type":"location_id","value":"9bd63e5c-115b-11e2-a378-760dde346a75"},{"id":"f--root_cause_id","name":"Root cause","display_type":"root_cause_id","value":null},{"id":"f--labor_hours","name":"Labor hours","display_type":"numeric","value":6.0},{"id":"f--cost","name":"Cost","display_type":"text","value":null},{"id":"cf--6b0def36-0bfb-11e2-9694-14f6960d7e4f","name":"Beverage of Choice","display_type":"drop-down","value":"Wine"}],"comments":[],"attachments":[{"id":"0169b770-5abe-11e4-b890-000a2702005e","type":"Attachment","name":"Example_JPG_iPhone4S.jpg","caption":"hotel","tags":"suitcase","content_type":"image/jpeg","original_url":"https://bim360field.autodesk.com/api/binary_data?ticket=0125387a-5abe-11e4-b890-000a2702005e&project_id=00000330-0001-0000-0000-000000000001&object_id=0169b770-5abe-11e4-b890-000a2702005e&object_type=Attachment&image_type=original&page=0","thumb_url":"https://bim360field.autodesk.com/api/binary_data?ticket=0125387a-5abe-11e4-b890-000a2702005e&project_id=00000330-0001-0000-0000-000000000001&object_id=0169b770-5abe-11e4-b890-000a2702005e&object_type=Attachment&image_type=thumb&page=0","num_pages":1,"composites":[{"page":0,"url":"https://bim360field.autodesk.com/api/binary_data?ticket=0125387a-5abe-11e4-b890-000a2702005e&project_id=00000330-0001-0000-0000-000000000001&object_id=0169b770-5abe-11e4-b890-000a2702005e&object_type=Attachment&image_type=composite&page=0"}],"created_at":"2014-10-23 10:08:04 -0400","updated_at":"2014-10-23 10:08:04 -0400","created_by":"moe.syzlack@moes.springfield.somewhere.gov"}]}]Description:
Returns a list of issues.
Status Codes:
200 OK Success.Description:
Create a new issue.
The "fields" array is the primary array of field identifiers and values based on the identifiers from the fields call.
There are other optional arrays such as "uri_references" which contain an array of hashes of "name" and "path" (and optionally a "caption" and "tags"). To create new URI References.
Input: "issues"
The following shows an array with one issue. The issue is filling in the minimal fields of the Issue Type Id and the Description.[{"temporary_id":"Q45","fields":[{"id":"f--description","value":"This is a test of creating an issue"},{"id":"f--issue_type_id","value":"f498d0f5-0be0-11e2-9694-14f6960d7e4f"}],"uri_references":[{"name":"Yahoo!","path":"http://www.yahoo.com","caption":"Yahoo"}]}]Status Codes:
200 OK Success.Example Result:
The following is an example result. It shows an array of hashes. Each hash contains the temporary_idmatching the issue it relates to. The id given in the block is the true Issue ID and further are twoarrays: the general_errors are strings if problems are encounted during parsing. The errors is an arrayof arrays of strings. In this case each array in the array will have two elements: the first is thefield and the second is the error in the field. In this way validation errors are reported back.[{"success":true,"general_errors":[],"errors":[],"id":"bea2eb64-4420-11e2-b406-80c45664f08a","temporary_id":"Q45"}]Description:
Update an existing issue or issues.
You may notice that this format is essentially the same as retrieve and differsfrom create only in that the id field is given.
The "fields" array is the primary array of field identifiers and values based on the identifiers fromthe fields call. There are other optional arrays such as "uri_references" which contain an array ofhashes of "name" and "path" (and optionally a "caption" and "tags"). To create new URI References. Youmay also specify the "id" of an existing URI Reference to change it's data. Finally you can add a hashelement "delete" set to "1" along with an "id" of an existing URI Reference to update deleting thatURI Reference.
Input: "issues"
The following shows an array with one issue. The example is setting the priority to High.All other fields in the issue would have remained the same.[{"id":"bea2eb64-4420-11e2-b406-80c45664f08a","temporary_id":"Q45","fields":[{"id":"f--priority","value":"High"},]}]Status Codes:
200 OK Success.Example Result:
The following is an example result. It shows an array of hashes. Each hash contains the temporary_idmatching the issue it relates to. The id given in the block is the true Issue ID and further are twoarrays: the general_errors are strings if problems are encounted during parsing. The errors is an arrayof arrays of strings. In this case each array in the array will have two elements: the first is thefield and the second is the error in the field. In this way validation errors are reported back.[{"success":true,"general_errors":[],"errors":[],"id":"bea2eb64-4420-11e2-b406-80c45664f08a","temporary_id":"Q45"}]Description:
Search based on a saved filter (see elsewhere) combined with an array of conditions or simply with an array of conditions. The conditions translate to a repeated query. Please use limit and offset arguments to allow an application to page through a set of matching issues.
Conditions are essentially tuples of a field identifier, an operation such as equal, starting with, or in a given array. The conditions argument is, itself, a JSON array of strings. The strings are formed as a comma separated string with the arguments being the field identifier, the condition and the value. The value is a JSON formatted string. An example is:
"[\"cf--5bf288e4-21a0-4fe8-9a4b-67c8133fcb92,like,\\\"inspect\\\"\",\"f--status,in,[\\\"Work Completed\\\",\\\"Draft\\\"]\"]"The comparisions include:
Status Codes:
200 OK Success.Example Result:
[{"id":"00000aac-0001-0000-0000-00000000000b","closed_at": "closed at date","fields":[{"value":"000001","name":"Identifier","display_type":"text","id":"f--identifier"},{"value":"Open","name":"Status","display_type":"text","id":"f--status"},{"value":"Inspection has been scheduled","name":"Notes","display_type":"text","id":"cf--5bf288e4-21a0-4fe8-9a4b-67c8133fcb92"}],"additional_fields": {"source_id": "7a2be8d6-d3ba-452e-9113-8598ba2db64e","source_type": "Task","status_changed_at": "2020-04-15 07:01:06 -0400"}}]Description:
Destroy one or more issues by id.
NOTE: This cannot be undone. TODO: return details in case we aren't authorized to close some issues.
Status Codes:
200 OK Success.Example Result:
Description:
Add a comment to the existing issue identified by id. The comment is textual in nature. The author may beoverridden otherwise will be recorded as the current authenticated user or effective user in an SSO case.
Status Codes:
200 OK Success.Example Result:
Description:
Streams binary data for issue pushpin overlay image.
Status Codes:
200 : The request was processed successfully.
400 : The issue ID or project ID was not passed in.
404 : The requested pushpin overlay image does not exist.
500 : The server encountered an error while streaming the file.
Description:
Retrieves a list of BIM 360 Field checklists for a single project, with the option of only retrieving checklists associated with a Task or a piece of Equipment.
Status Codes:
200 OK Success.Example Request:
GET https://bim360field.autodesk.com/fieldapi/checklists/v1.json?ticket=6267caf3-c3ad-11e2-8a88-6dccb730c85e&project_id=ca0e24b0-be43-11e2-92b9-bd56764d1fb2
Example Result:
[{"status": "Open","created_at": "2013-05-20 12:23:07 -0400","checklist_type": "Safety","identifier": "000001","name": "Field Safety Checklist","id": "8e6c33ea-c169-11e2-92bf-93adab508ed6","updated_at": "2013-05-20 12:49:09 -0400","created_by": "moe@example.com","company": {"id": "134ce983-f543-4e15-bfd3-8082aa0815e7","name": "Subcontractor"}}]
Access:
FREE
Description:
Retrieves a single BIM 360 Field checklist.
Status Codes:
200 OK Success.Example Request:
GET https://bim360field.autodesk.com/fieldapi/checklists/v1/3ef1c2a4-c16d-11e2-92bf-93adab508ed6.json?ticket=6267caf3-c3ad-11e2-8a88-6dccb730c85e&project_id=ca0e24b0-be43-11e2-92b9-bd56764d1fb2
Example Result:
{"comments": [{"created_at": "2013-06-04T13:01:18-04:00","created_by": "barry.walker@autodesk.com","comment_text": "This is the first comment on this sample API checklist","id": "f3f72b19-cd37-11e2-a818-cadae7f720b9"}, {"created_at": "2013-06-04T13:01:29-04:00","created_by": "barry.walker@autodesk.com","comment_text": "This is the second comment on this sample API checklist","id": "f3f72b1e-cd37-11e2-a818-cadae7f720b9"}],"status": "Open","created_at": "2013-06-04 13:00:17 -0400","created_by": "moe@example.com","checklist_type": "QA/QC","project_id": "ca0e24b0-be43-11e2-92b9-bd56764d1fb2","company": {"name": "Acme Drywall","id": "9662301c-be44-11e2-92b9-bd56764d1fb2"},"custom_field_values": [{"value": "0","display_type": "checkbox","id": "3b8f9f42-cd38-11e2-a818-cadae7f720b9"}, {"value": "06/05/2013","display_type": "date","id": "3b8f9f43-cd38-11e2-a818-cadae7f720b9"}, {"value": "Choice 2","display_type": "drop-down","id": "3b8f9f44-cd38-11e2-a818-cadae7f720b9"}, {"value": "3.14159265","display_type": "numeric","id": "3b8f9f45-cd38-11e2-a818-cadae7f720b9"}, {"value": "Default Text Value","display_type": "text","id": "3b8f9f46-cd38-11e2-a818-cadae7f720b9"}],"description": "This is a sample checklist for API demonstration purposes.","source": {},"phase": null,"identifier": "000009","signatures": [{"type": "Signature","original_url": "https://bim360field.autodesk.com/api/binary_data?ticket=6267caf3-c3ad-11e2-8a88-6dccb730c85e&project_id=ca0e24b0-be43-11e2-92b9-bd56764d1fb2&object_id=429f6326-cd38-11e2-a818-cadae7f720b9&object_type=Signature&image_type=original&page=0","id": "429f6326-cd38-11e2-a818-cadae7f720b9"}],"name": "Wall closing checklist","template": {"name": "Wall closing checklist","id": "402980b2-cd34-11e2-a818-cadae7f720b9"},"attachments": [{"type": "UriReference","path": "http://www.google.com","name": "Google","id": "565199f2-cd38-11e2-a818-cadae7f720b9"}, {"type": "DocumentReference","num_pages": 1,"content_type": "application/pdf","thumb_url": "https://bim360field.autodesk.com/api/binary_data?ticket=6267caf3-c3ad-11e2-8a88-6dccb730c85e&project_id=ca0e24b0-be43-11e2-92b9-bd56764d1fb2&object_id=429f6331-cd38-11e2-a818-cadae7f720b9&object_type=DocumentReference&image_type=thumb&page=0","composites": [{"page": 0,"url": "https://bim360field.autodesk.com/api/binary_data?ticket=6267caf3-c3ad-11e2-8a88-6dccb730c85e&project_id=ca0e24b0-be43-11e2-92b9-bd56764d1fb2&object_id=429f6331-cd38-11e2-a818-cadae7f720b9&object_type=DocumentReference&image_type=composite&page=0"}],"original_url": "https://bim360field.autodesk.com/api/binary_data?ticket=6267caf3-c3ad-11e2-8a88-6dccb730c85e&project_id=ca0e24b0-be43-11e2-92b9-bd56764d1fb2&object_id=429f6331-cd38-11e2-a818-cadae7f720b9&object_type=DocumentReference&image_type=original&page=0","id": "429f6331-cd38-11e2-a818-cadae7f720b9"}],"id": "3b8f9f38-cd38-11e2-a818-cadae7f720b9","sections": [{"items": [],"section_name": ""}, {"items": [{"created_at": "2013-06-04 13:00:17 -0400","issues": [],"question_text": "Item 1's Item Text","created_by": "barry.walker@autodesk.com","display_type": "drop-down","response": "+","display_number": "1.","position": 2,"comment": "Comment for Item 1.","spec_ref": "","is_conforming": "Yes","attachments": [],"id": "3b8f9f4f-cd38-11e2-a818-cadae7f720b9","possible_values": ["+", "-", "N/A"],"updated_at": "2013-06-04 13:02:10 -0400"}, {"created_at": "2013-06-04 13:00:17 -0400","issues": [],"question_text": "This is a Date response type with a default value of 1 day after the current date.","created_by": "barry.walker@autodesk.com","display_type": "date","response": "06/05/2013","display_number": "2.","position": 3,"comment": null,"spec_ref": "","is_conforming": "Other","attachments": [],"id": "3b8f9f51-cd38-11e2-a818-cadae7f720b9","possible_values": [],"updated_at": "2013-06-04 13:00:17 -0400"}, {"created_at": "2013-06-04 13:00:17 -0400","issues": [{"description": "This is a Single-Select List response type","identifier": "BW-00059","id": "f3f72b20-cd37-11e2-a818-cadae7f720b9"}],"question_text": "This is a Single-Select List response type","created_by": "barry.walker@autodesk.com","display_type": "single-select","response": "Non-conforming choice","display_number": "3.","position": 4,"comment": null,"spec_ref": "Division 10 Specialties","is_conforming": "No","attachments": [{"type": "DocumentReference","num_pages": 1,"content_type": "application/pdf","thumb_url": "https://bim360field.autodesk.com/api/binary_data?ticket=6267caf3-c3ad-11e2-8a88-6dccb730c85e&project_id=ca0e24b0-be43-11e2-92b9-bd56764d1fb2&object_id=a4e9b126-cd38-11e2-a818-cadae7f720b9&object_type=DocumentReference&image_type=thumb&page=0","composites": [{"page": 0,"url": "https://bim360field.autodesk.com/api/binary_data?ticket=6267caf3-c3ad-11e2-8a88-6dccb730c85e&project_id=ca0e24b0-be43-11e2-92b9-bd56764d1fb2&object_id=a4e9b126-cd38-11e2-a818-cadae7f720b9&object_type=DocumentReference&image_type=composite&page=0"}],"original_url": "https://bim360field.autodesk.com/api/binary_data?ticket=6267caf3-c3ad-11e2-8a88-6dccb730c85e&project_id=ca0e24b0-be43-11e2-92b9-bd56764d1fb2&object_id=a4e9b126-cd38-11e2-a818-cadae7f720b9&object_type=DocumentReference&image_type=original&page=0","id": "a4e9b126-cd38-11e2-a818-cadae7f720b9"}],"id": "3b8f9f56-cd38-11e2-a818-cadae7f720b9","possible_values": ["Conforming Choice", "Non-conforming choice"],"updated_at": "2013-06-04 13:03:19 -0400"}, {"created_at": "2013-06-04 13:00:17 -0400","issues": [{"description": "This is a Multi-Select List response type","identifier": "BW-00060","id": "add3ee96-cd38-11e2-a818-cadae7f720b9"}],"question_text": "This is a Multi-Select List response type","created_by": "barry.walker@autodesk.com","display_type": "multi-select","response": "Choice 2|Choice 3|Choice 1","display_number": "4.","position": 5,"comment": null,"spec_ref": "","is_conforming": "No","attachments": [],"id": "3b8f9f58-cd38-11e2-a818-cadae7f720b9","possible_values": ["Choice 1", "Choice 2", "Choice 3"],"updated_at": "2013-06-04 13:03:28 -0400"}],"section_name": "Section 1"}],"priority": "Medium","updated_at": "2013-06-04 13:03:28 -0400"}
Access:
FREE
Description:
Returns list of companies. If project_id is not given all companies from the user's account will be returned.
Status Codes:
200 OK Success.Example Result:
[{"name":"Admin Company API","id":"00000101-0001-0000-0000-000000000013","address":{"country":"US","state":null,"address3":null,"postal_code":"1322","county":null,"city":"Waltham","address2":null,"address1":null},"url":"www.admincompanyapi.com","telephone":"206-340-2256","ctype":"Other","custom_fields":[{"value":null,"default_value":null,"possible_values":null,"display_type":"text","name":"State Identifier"}],"fax":"206-340-2267","ein_no":"00-1234568","description":"General Contractor","category":"Contractor","duns_no":"12-345-6780"},{"name":"Sample Construction API","id":"00000101-0001-0000-0000-000000000014","address":{"country":"US","state":null,"address3":null,"postal_code":"1111","county":null,"city":"Boston","address2":null,"address1":null},"url":"www.sampleconstructionapi.com","telephone":"206-340-2255","ctype":"Other","custom_fields":[{"value":"000-123-456","default_value":null,"possible_values":null,"display_type":"text","name":"State Identifier"}],"fax":"206-340-2266","ein_no":"00-1234567","description":"Engineer","category":"Contractor","duns_no":"12-345-6789"}]Description:
Retrieves a single company.
Status Codes:
200 OK Success.Example Result:
{"name":"Admin Company API","id":"00000101-0001-0000-0000-000000000013","address":{"country":"US","state":null,"address3":null,"postal_code":"1322","county":null,"city":"Waltham","address2":null,"address1":null},"url":"www.admincompanyapi.com","telephone":"206-340-2256","ctype":"Other","custom_fields":[{"value":null,"default_value":null,"possible_values":null,"display_type":"text","name":"State Identifier"}],"fax":"206-340-2267","ein_no":"00-1234568","description":"General Contractor","category":"Contractor","duns_no":"12-345-6780"}Description:
Create a new account level company.
Input: "company"
The following shows a hash of company attributes:{"name":"Sample Construction API","address":{"country":"US","state":null,"address3":null,"postal_code":"1111","county":null,"city":"Boston","address2":null,"address1":null},"url":"www.sampleconstructionapi.com","telephone":"206-340-2255","ctype":"Other","custom_fields":[{"value":"000-123-456","default_value":null,"possible_values":null,"display_type":"text","name":"State Identifier"}],"fax":"206-340-2266","ein_no":"00-1234567","description":"Engineer","category":"Contractor","duns_no":"12-345-6789"}Status Codes:
200 OK Success.Example Result:
The following is an example result hash. The id given in the block is the true Company ID.Errors is an array of arrays of strings. Each array in the array will have two elements: the first is thefield and the second is the error in the field. In this way validation errors are reported back.{"success":true,"errors":[],"id":"bea2eb64-4420-11e2-b406-80c45664f08a"}Description:
Update an existing company.
Input: "companies"
The following shows a company attributes hash. The example is setting a custom field "State Identifier" and address.All other fields in the company would have remained the same.{"address":{"country":"US","state":MA,"postal_code":"02451","city":"Waltham","address1":"1560 Trapelo Rd"},"custom_fields":[{"value":"000-123-456","display_type":"text","name":"State Identifier"}]}Status Codes:
200 OK Success.Example Result:
The following is an example result hash. The id given in the block is the Company ID.Errors is an array of arrays of strings. Each array in the array will have two elements: the first is thefield and the second is the error in the field. In this way validation errors are reported back.{"success":true,"errors":[],"id":"bea2eb64-4420-11e2-b406-80c45664f08a"}Description:
Add companies to projects. Note, companies should be created first for the account.
Status Codes:
200 OK Success.Example Result:
{"errors":[],"success":true}Description:
Remove companies from projects. Note, companies will not be deleted from the account.
Status Codes:
200 OK Success.Example Result:
{"errors":[],"success":true}Description:
Returns a list of project users.
Access: FREEDescription:
Retrieves a single project user.
Access: FREEDescription:
Add users to a project. It will create new users if they don't exist. Make sure company assigned to the project. The list of project companies could be retrieve using /fieldapi/companies/v1
Project user role ids:
00000000-0005-0000-0001-000000000003 = contractor
00000000-0006-0000-0001-000000000003 = architect
00000000-0007-0000-0001-000000000003 = engineer
00000000-0008-0000-0001-000000000003 = owner
00000000-0009-0000-0001-000000000003 = subcontractor
00000000-000b-0000-0001-000000000003 = inspector
Input: "users"
The following shows an example array of users:[{"name": "John Smith","email": "john.smith@example.com","project_admin": false,"document_manager": false,"photo_viewer": false,"role_id": "00000000-0006-0000-0001-000000000003","company": {"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}}]Description:
Update an existing project user
Input: "user"
The following shows a hash of project user attributes:{"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","company_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","project_admin": true,"document_manager": true,"photo_viewer": true}Description:
Removes a user from a project
Access: FREEDescription:
Returns a list of daily updates.
Access: FREEDescription:
Retrieves a single daily update.
Access: FREEDescription:
Create a new daily update.
Input: "daily_update"
The following shows a hash of daily update attributes:{"status": "Closed","update_date": "2015-08-17","sections": {"summary": {"notes": "White House Update"},"weather": {"notes": "Weather notes","humidity": 79,"precip_accumulation": 0.1392,"precip_type": "rain","summary": "Light rain starting in the afternoon, continuing until evening.","temperature_max": 83.4,"temperature_max_time": "2015-08-12T18:00:00Z","temperature_min": 63.25,"temperature_min_time": "2015-08-12T10:00:00Z","visibility": 8.31,"wind_speed": 4.3,"zipcode": "20500","location_search_term": "11600 Pennsylvania Avenue Northwest, Washington, DC 20500 US"},"labor": {"labors": [{"company_id": "3553cb07-17fb-4f17-b0da-a524b1dcc8a1","workers": 2,"total_hours": 16,"notes": "Painted with Blue"}]}}}Description:
Update an existing daily update.
Input: "daily_update"
The following shows a hash of daily update attributes. The example is setting status to "Open", changing the update date, and updates summary section notes.{"status": "Open","update_date": "2015-08-16","sections": {"summary": {"id": "7ee2d5f9-68b9-4ed2-884e-36508f8e87bb","notes": "Update date changed to 2015-08-16"}}}Description:
Deletes a daily update
Access: FREEDescription:
Return a set of matching Equipment status change records. The records indicate when the status was started, transitioned to, and, optionally, when the status ended and was transitioned away from. If the record is still in the status the ending date will be blank.
The format of the resulting array of JSON is:
[{"id": "equipment id value","status": "status value as string","previous_status": "previous status if any""user": "email of user if known","starting_at": "date when we entered the given status","ending_at": "date when we left the given status or nil"}]
Access:
FREE
Description:
Return status changes for a given Equipment item.
The format of the resulting array of JSON is:
[{"id": "equipment id value","status": "status value as string","user": "email of user if available","starting_at": "date when we entered the given status","ending_at": "date when we left the given status or nil"}]
Access:
FREE
Description:
Return a set of matching Equipment status change records. The records indicate when the status was started, transitioned to, and, optionally, when the status ended and was transitioned away from. If the record is still in the status the ending date will be blank.
The format of the resulting array of JSON is:
[{"id": "issue id value","status": "status value as string","previous_status": "previous status value if available""user": "email of user if available","start_dt": "date when we entered the given status","end_dt": "date when we left the given status or nil"}]
Access:
FREE
Description:
Return status changes for a given Issue item.
The format of the resulting array of JSON is:
[{"id": "issue id value","status": "status value as string","user": "email of user","start_dt": "date when we entered the given status","end_dt": "date when we left the given status or nil"}]
Access:
FREE
Description:
Activat/De-activate users
Status Codes:
200 OK Success.Example Result:
{"user_id":"f47f035a-b727-11e1-9edf-ad27ba32cc68","status":"active",}
Access:
FREE
Description:
link some tasks to a Completed checklist
Status Codes:
200 OK Success.