Search

GET /home/search/usercode

Read list of service adaptors with completely matching management codes

Detail

Request

Body

Key	Type	Value
q	String	Search key (required) Management code (exact match)

Response

See “ List of search results “

Sample

Request

• URL

  GET https://*.sacm.jp/public-api/v1/home/search/usercode?q=tsa99990001
  

Response

• Response Header

  Content-Type: application/json
  

• Response Body

  {
    "results": [
      {
        "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678"
        "saCode": "tss99990001"
        "saName": "SEIL/B1 001"
        "up": true
        "userCode": "tsa99990001"
        "userName": "API Sample Inc."
      }
    ]
  }
  

Description

• If no matching content exists, a blank Array is returned as a response

GET /home/search/username

Read list of service adaptors with partially matching management labels

Detail

Request

Body

Key	Type	Value
q	String	Search key (required) Management label (partial match)

Response

See “ List of search results “

Sample

Request

URL

GET https://*.sacm.jp/public-api/v1/home/search/username?q=%E3%82%B5%E3%83%B3%E3%83%97%E3%83%AB

Response

Header

Content-Type: application/json

Body

{
  "results": [
    {
      "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678"
      "saCode": "tss99990001"
      "saName": "SEIL/B1 001"
      "up": true
      "userCode": "tsa99990001"
      "userName": "API Sample Inc."
    }
  ]
}

Description

• If no matching content exists, a blank Array is returned as a response

• Search key requires URL encoding (Ex.: “%E3%82%B5%E3%83%B3%E3%83%97%E3%83%AB” = “sample”)

GET /home/search/sacode

Read list of service adaptors with matching SA codes

Detail

Request

Body

Key	Type	Value
q	String	Search key (required) SA code (exact match)

Response

See “ List of search results “

Request

URL

GET https://*.sacm.jp/public-api/v1/home/search/sacode?q=tss99990001

Response

Header

Content-Type: application/json

Body

{
  "results": [
    {
      "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678"
      "saCode": "tss99990001"
      "saName": "SEIL/B1 001"
      "up": true
      "userCode": "tsa99990001"
      "userName": "API Sample Inc."
    }
  ]
}

Description

• If no matching content exists, a blank Array is returned as a response

GET /home/search/saname

Read list of service adaptors with partially matching SA labels

Detail

Request

Body

Key	Type	Value
q	String	Search key (required) SA label (partial match)

Response

See “ List of search results “

Sample

Request

URL

GET https://*.sacm.jp/public-api/v1/home/search/saname?q=SEIL%2FB1+001

Response

Header

Content-Type: application/json

Body

{
  "results": [
    {
      "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678"
      "saCode": "tss99990001"
      "saName": "SEIL/B1 001"
      "up": true
      "userCode": "tsa99990001"
      "userName": "API Sample Inc."
    }
  ]
}

Description

• If no matching content exists, a blank Array is returned as a response

• Search key requires URL encoding (Ex: “SEIL%2FB1+001” = “SEIL/B1 001”)

GET /home/search/distid

Read list of service adaptors with matching Distribution IDs

Detail

Request

Body

Key	Type	Value
q	String	Search key (required) Distribution ID (exact match)

Response

See “ List of search results “

Sample

Request

URL

GET https://*.sacm.jp/public-api/v1/home/search/distid?q=0001-0000-0101-0000-0000-0000-1234-5678

Response

Header

Content-Type: application/json

Body

{
  "results": [
    {
      "distributionId": "0001-0000-0101-0000-0000-0000-1234-5678"
      "saCode": "tss99990001"
      "saName": "SEIL/B1 001"
      "up": true
      "userCode": "tsa99990001"
      "userName": "API Sample Inc."
    }
  ]
}

Description

• If no matching content exists, a blank Array is returned as a response

Shared parameters

List of search results

Key	Type	Value
results	Array	List of search results saCode String SA code saName String SA label distributionId String Distribution ID configState String Config status initial Config unpulled or not synced pulled Config pulled pushready RS control confirmed pushed Config being operated pushconfirming RS control being confirmed up boolean Whether connected or not userCode String Management code that sets the service adaptor userName String Management label that sets the service adaptor