Autodesk BIM 360 Field API

[Peter.j.Kelly]

Documentation missing from  the page

The following documentation does not detail the values that can be specified in the 'details' parameter.

POST/api/get_equipment

Access: FREE

Parameters:

• ticket : string - The ticket obtained from the login call.
• project_id : string - The ID of the project to perform this action against.
• step : string - Can be headers, softdeletes, updatedownloaded or filter
• details : string - Whether to retrieve equipment details, or just header information.
• equipment_ids : string - An array of equipment IDs to retrieve
• filter_id : string - The 36 byte GUID of the equipment filter to apply to the download
• limit : int - Used to progressively download equipment records. Limits the number of equipment records in each download batch.
• offset : int - Used to progressively download equipment records. Tells the server which equipment record number to download from.
• max_date : Date - If specified, used to limit the equipment to just those changed or deleted after this date (YYYY-MM-DD).

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