PUT api/v2/rflow/objectlinks/list

ListObjectRflowLink

Request Information

URI Parameters

None.

Body Parameters

The query

ListObjectRflowLinkQuery
NameDescriptionTypeAdditional information
ObjectId

universally unique identifier

Required

Kind

ObjectRflowLinkKind

Required

Enabled

boolean

None.

PageNumber

integer (32 bits)

Required

Default value: 1

PageSize

integer (32 bits)

Required

Default value: 100

Request Formats

application/json

Sample:
{
  "ObjectId": "00000000-0000-0000-0000-000000000000",
  "Kind": "RflowCompany",
  "Enabled": true,
  "PageNumber": 1,
  "PageSize": 1
}

Response Information

Resource Description

ListObjectRflowLinkQueryResult

ListObjectRflowLinkQueryResult
NameDescriptionTypeAdditional information
Links

Collection of ListObjectRflowLinkQueryResultLink

Required

Count

integer (32 bits)

Range: inclusive between 0 and 2147483647

Response Formats

application/json

Sample:
{
  "Links": [
    {
      "ObjectRflowLinkId": "00000000-0000-0000-0000-000000000000",
      "Kind": "RflowCompany",
      "Company": {
        "RflowCompanyId": "00000000-0000-0000-0000-000000000000",
        "Name": "sample string 1",
        "Kind": "None",
        "Street": "sample string 2",
        "StreetNumber": "sample string 3",
        "PostalCode": "sample string 4",
        "Locality": "sample string 5",
        "CountryName": "sample string 6"
      },
      "Installation": {
        "RflowInstallationId": "00000000-0000-0000-0000-000000000000",
        "Owner": {
          "RflowCompanyId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1",
          "Kind": "None",
          "Street": "sample string 2",
          "StreetNumber": "sample string 3",
          "PostalCode": "sample string 4",
          "Locality": "sample string 5",
          "CountryName": "sample string 6"
        },
        "User": {
          "RflowCompanyId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1",
          "Kind": "None",
          "Street": "sample string 2",
          "StreetNumber": "sample string 3",
          "PostalCode": "sample string 4",
          "Locality": "sample string 5",
          "CountryName": "sample string 6"
        },
        "Supplier": {
          "RflowCompanyId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1",
          "Kind": "None",
          "Street": "sample string 2",
          "StreetNumber": "sample string 3",
          "PostalCode": "sample string 4",
          "Locality": "sample string 5",
          "CountryName": "sample string 6"
        },
        "Installer": {
          "RflowCompanyId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1",
          "Kind": "None",
          "Street": "sample string 2",
          "StreetNumber": "sample string 3",
          "PostalCode": "sample string 4",
          "Locality": "sample string 5",
          "CountryName": "sample string 6"
        },
        "Commissioner": {
          "RflowCompanyId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1",
          "Kind": "None",
          "Street": "sample string 2",
          "StreetNumber": "sample string 3",
          "PostalCode": "sample string 4",
          "Locality": "sample string 5",
          "CountryName": "sample string 6"
        },
        "Number": "sample string 1",
        "Kind": "None",
        "RefigerantName": "sample string 2"
      },
      "Enabled": true,
      "LinkAutomatically": true,
      "IsLinkedAutomatically": true,
      "Remarks": "sample string 1"
    },
    {
      "ObjectRflowLinkId": "00000000-0000-0000-0000-000000000000",
      "Kind": "RflowCompany",
      "Company": {
        "RflowCompanyId": "00000000-0000-0000-0000-000000000000",
        "Name": "sample string 1",
        "Kind": "None",
        "Street": "sample string 2",
        "StreetNumber": "sample string 3",
        "PostalCode": "sample string 4",
        "Locality": "sample string 5",
        "CountryName": "sample string 6"
      },
      "Installation": {
        "RflowInstallationId": "00000000-0000-0000-0000-000000000000",
        "Owner": {
          "RflowCompanyId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1",
          "Kind": "None",
          "Street": "sample string 2",
          "StreetNumber": "sample string 3",
          "PostalCode": "sample string 4",
          "Locality": "sample string 5",
          "CountryName": "sample string 6"
        },
        "User": {
          "RflowCompanyId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1",
          "Kind": "None",
          "Street": "sample string 2",
          "StreetNumber": "sample string 3",
          "PostalCode": "sample string 4",
          "Locality": "sample string 5",
          "CountryName": "sample string 6"
        },
        "Supplier": {
          "RflowCompanyId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1",
          "Kind": "None",
          "Street": "sample string 2",
          "StreetNumber": "sample string 3",
          "PostalCode": "sample string 4",
          "Locality": "sample string 5",
          "CountryName": "sample string 6"
        },
        "Installer": {
          "RflowCompanyId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1",
          "Kind": "None",
          "Street": "sample string 2",
          "StreetNumber": "sample string 3",
          "PostalCode": "sample string 4",
          "Locality": "sample string 5",
          "CountryName": "sample string 6"
        },
        "Commissioner": {
          "RflowCompanyId": "00000000-0000-0000-0000-000000000000",
          "Name": "sample string 1",
          "Kind": "None",
          "Street": "sample string 2",
          "StreetNumber": "sample string 3",
          "PostalCode": "sample string 4",
          "Locality": "sample string 5",
          "CountryName": "sample string 6"
        },
        "Number": "sample string 1",
        "Kind": "None",
        "RefigerantName": "sample string 2"
      },
      "Enabled": true,
      "LinkAutomatically": true,
      "IsLinkedAutomatically": true,
      "Remarks": "sample string 1"
    }
  ],
  "Count": 1
}