Request

Response

    Queries

    getExchangeCreationStatus

    GraphQL: Query

    Retrieves the status of the latest version of the exchange. But if the exchange status is in progress/failed, it will return the exchange of the last success version of the exchange.

    Template for Query:

    query GetGetExchangeCreationStatus($exchangeId: ID!) {
      getExchangeCreationStatus(exchangeId: $exchangeId) {
        # GetExchangeCreationStatus Fields
      }
    }
    

    Template for Query Variables:

    {
      "exchangeId" : "<SOME-ID-TYPE-SCALAR-VALUE>"
    }
    


    Arguments

    exchangeId*
    ID! non-null
    The ID of the exchange.
    * Required

    Possible Returns

    Value TypeDescription
    ExchangeCreationStatus Represents the creation status of an exchange.


    Examples

    Example 1

    Get Exchange Processing status for the already created exchange or in progress exchange.

    Query:

    query GetExchangeStatus($exchangeId: ID!) {
      getExchangeCreationStatus(exchangeId: $exchangeId) {
          status
          versionNumber
          exchange {
              id
              name
              elements {
                  results {
                      id
                      name
                  }
              }
          }
        }
     }
    
    Show More

    Query Variables:

    {
       "exchangeId": "ZXhjfnlwdWFzY1NicWlIT0R1R0s4OUkwTHdfTDJDfjkwMGM5ODY1LWI2ZmMtMzI0Ny04NWUxLTgxMmZhOGY1ZTJkNA"
    }
    

    Response:

    {
      "data": {
          "getExchangeCreationStatus": {
              "status": "COMPLETED",
              "versionNumber": 1,
              "exchange": {
                  "id": "ZXhjfnlwdWFzY1NicWlIT0R1R0s4OUkwTHdfTDJDfjkwMGM5ODY1LWI2ZmMtMzI0Ny04NWUxLTgxMmZhOGY1ZTJkNA",
                  "name": "SHARE -Multi-Fam Apt-Wing 2",
                  "elements": {
                      "results": [
                          {
                              "id": "09946F0F7CDFCB299A911758F53A941FE5FA106A",
                              "name": "1050086"
                          },
                          {
                              "id": "08087FE00C00C0816458C80BFF254ACD74EF8FFC",
                              "name": "2608023"
                          },
                          {
                              "id": "03BE5D2D95443D278912B10CA07305DD107564FB",
                              "name": "2608091"
                          },
                          {
                              "id": "03A2EB143912445D72A928B288C8B8F888766EFF",
                              "name": "1365909"
                          },
                          {
                              "id": "088FE8BD1A96319617A30E6A88FE4A6C64EB8CD8",
                              "name": "717011"
                          }
                      ]
                  }
              }
           }
        }
     }
    
    Show More