Breaking changes to classical Field API GET /fieldapi/checklists/v1/:id

Breaking changes to classical Field API GET /fieldapi/checklists/v1/:id

eason.kangEDLV4
Autodesk Support Autodesk Support
1,089 Views
1 Reply
Message 1 of 2

Breaking changes to classical Field API GET /fieldapi/checklists/v1/:id

eason.kangEDLV4
Autodesk Support
Autodesk Support

Attention BIM 360 Field Checklist API developers –

 

Starting from June 03, the GET /fieldapi/checklists/v1/:id API has a breaking change on its response.  The datatype of the source will be changed from an object to an array since then. This change is going to fix a known issue of the checklist API, and now each checklist will have numbers of source data. Therefore, it becomes an array type.

 

What does this mean for BIM 360 Field developers?

 

When you call GET https://bim360field.autodesk.com/fieldapi/checklists/v1/checklist_id, you will see the source attribute is not an object anymore.

 

{

 "status": "Open",

  "created_at": "2013-06-04 13:00:17 -0400",

  "created_by": "[email protected]",

  "checklist_type": "QA\/QC",

 

 // ….

 

  "source": [                     //!<<< it’s an array now

       {

            "id": "15bce774-7964-430a-b11a-b05546837c11",

            "type": "Task"

        },

        {

            "id": "b71fb15e-f77e-4046-b124-dc51e8491a2a",

            "type": "Equipment"

        }

  ],

 

 // ….

 

  "phase": null,

  "identifier": "000009",

 

   // ….

 

  "priority": "Medium",

  "updated_at": "2013-06-04 13:03:28 -0400"

}

 

Originally, the source attribute is an object:

 

{

 "status": "Open",

  "created_at": "2013-06-04 13:00:17 -0400",

  "created_by": "[email protected]",

  "checklist_type": "QA\/QC",

 

 // ….

 

 "source": {                    //!<<< it’s an object before

        "id": "15bce774-7964-430a-b11a-b05546837c11",

         "type": "Task"

  },

 

 // ….

 

  "phase": null,

  "identifier": "000009",

 

   // ….

 

  "priority": "Medium",

  "updated_at": "2013-06-04 13:03:28 -0400"

}

 

Apologizing for the late notification. Please made possible corresponding changes to your codes to the GET /fieldapi/checklists/v1/:id API.

 

Cheers,

 

 


Eason Kang
Developer Advocate
Developer Advocacy & Support Service
Autodesk Platform Service (formerly Forge)

1,090 Views
1 Reply
Reply (1)
Message 2 of 2

mikako_harada
Alumni
Alumni

(adding a note here for admin purpose.)  Thank you, Eason!


Mikako Harada
Developer Technical Services