You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

CustomTableService


 

CustomTable Service


A particular custom table belonging to an object can be modified using the custom table service.

  • Please use the  Bimplus Object Service for creating a custom table or to deal with the group of custom tables belonging to an object.

Get details of the comment
    Resource: customtables/<customtable_id> 

    URLhttps://api-stage.bimplus.net/v2/<team_slug>/customtables/<customtable_id>

    Example:https://api-stage.bimplus.net/v2/bimplus/customtables/db540336-47a3-426e-b3bf-1e532bfac8ea 

     GET
     Get details of a specified custom table.
    Headers
    Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
    Content-Type: application/json
    
    Status
    Status: 200 OK
    
    JSON
    {
        "issueId": "8415bd8d-7e27-4975-bddb-b1b365719770",
        "text": "Second Comment: The fire exit should be x:120, y: 120; z: 340",
        "createdAt": "2013-11-20T08:17:36+00:00",
        "modifiedAt": "2013-11-20T08:17:36+00:00",
        "author": {
            "id": "132a78a5-b523-4bf2-8382-7098fac3f803",
            "email": "test@bimplus.net",
            "status": "Active",
            "firstname": null,
            "lastname": null,
            "company": null,
            "displayname": null,
            "info": null,
            "gender": null,
            "phoneWork": null,
            "phoneHome": null,
            "fax": null,
            "mobile": null,
            "birthDate": null,
            "address": {
                "street": "",
                "streetNr": "",
                "zip": "",
                "city": "",
                "country": ""
            },
            "preferedLanguage": null
        },
        "id": "db540336-47a3-426e-b3bf-1e532bfac8ea"
    }

    Update the comment
      Resource: customtables/<customtable_id> 

      URLhttps://api-stage.bimplus.net/v2/<team_slug>/customtables/<customtable_id>

      Examplehttps://api-stage.bimplus.net/v2/bimplus/customtables/db540336-47a3-426e-b3bf-1e532bfac8ea

      JSON Structure:

      Name

      Mandatory / Optional

      Type

      Description

      issueId will be ignored string(guid) The id of the issue

      text

      mandatory

      string

      The comment text

      createdAt

      will be ignored

      string (date)

      Creation date of the comment

      modifiedAt will be ignored string (date) Modified date of the comment

      author

      optional

      object

      The author of the comment

       PUT
      Update the specified customtable.
      Headers
      Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
      Content-Type: application/json
      
      JSON
      {
          "issueId": "8415bd8d-7e27-4975-bddb-b1b365719770",
          "text": "Second Comment: The fire exit should be x:120, y: 120; z: 340",
          "createdAt": "2013-11-20T08:17:36+00:00",
          "modifiedAt": "2013-11-20T08:17:36+00:00",
          "author": {
              "id": "132a78a5-b523-4bf2-8382-7098fac3f803"
          }
      }
      Status
      Status: 200 OK
      
      JSON
      {
          "issueId": "8415bd8d-7e27-4975-bddb-b1b365719770",
          "text": "Second Comment: The fire exit should be x:120, y: 120; z: 340",
          "createdAt": "2013-11-20T08:17:36+00:00",
          "modifiedAt": "2013-11-20T08:17:36+00:00",
          "author": {
              "id": "132a78a5-b523-4bf2-8382-7098fac3f803",
              "email": "test@bimplus.net",
              "status": "Active",
              "firstname": null,
              "lastname": null,
              "company": null,
              "displayname": null,
              "info": null,
              "gender": null,
              "phoneWork": null,
              "phoneHome": null,
              "fax": null,
              "mobile": null,
              "birthDate": null,
              "address": {
                  "street": "",
                  "streetNr": "",
                  "zip": "",
                  "city": "",
                  "country": ""
              },
              "preferedLanguage": null
          },
          "id": "db540336-47a3-426e-b3bf-1e532bfac8ea"
      }

      Delete the comment
        Resource: customtables/<customtable_id> 

        URLhttps://api-stage.bimplus.net/v2/<team_slug>/customtables/<customtable_id>

        Examplehttps://api-stage.bimplus.net/v2/bimplus/customtables/8836308d-f09f-4bb7-b6d2-354a2db205a6


         DELETE
         Deletes a specified customtable.
        Headers
        Authorization: BimPlus 9c1874a62c974dcfa75e0132c423a088
        Content-Type: application/json
        
        Status
        Status: 200 OK
        
        • No labels