GET /api/properties

Returns properties for the tenant on the platform.

Authorization Roles/Permissions: Login is not required.

This topic includes the following sections:

HTTP Method

GET

URL

https://{hostname}/api/properties

Sample Request

The example below shows a request for the properties for the tenant.

Sample Request URL

https://{hostname}/api/properties

Sample request headers

xxsample_req_hdrxx

Sample request body

Not applicable.

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

None.

Response

If successful, this operation returns HTTP status code 200, with the tenant properties.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Content-Type: application/json
Date: Wed, 22 Aug 2018 20:00:29 GMT

Sample response body

{
  "DefaultTheme":"default",
  "ConsoleAddress":"http://acmepaymentscorp.com/portal/",
  "Themes":[
    {
      "Theme":"default",
      "VirtualHosts":[
        "default.acmepaymentscorp.com"
      ],
      "ConsoleAddress":"http://default.acmepaymentscorp.com/portal/",
      "TenantID":10001,
      "FedmemberID":"acmepaymentscorp"
    },
    {
      "Theme":"devops",
      "VirtualHosts":[
        "devops.acmepaymentscorp.com"
      ],
      "ConsoleAddress":"http://devops.acmepaymentscorp.com/portal/",
      "TenantID":10001,
      "FedmemberID":"acmepaymentscorp",
      "ThemeImpl":"default"
    },
    {
      "Theme":"hermosa",
      "VirtualHosts":[
        "cloud.acmepaymentscorp.com"
      ],
      "ConsoleAddress":"http://cloud.acmepaymentscorp.com/portal/",
      "TenantID":10001,
      "FedmemberID":"acmepaymentscorp",
      "ThemeImpl":"default"
    },
    {
      "Theme":"simpledev",
      "VirtualHosts":[
        "simpledev.acmepaymentscorp.com"
      ],
      "ConsoleAddress":"http://simpledev.acmepaymentscorp.com/portal/",
      "TenantID":10001,
      "FedmemberID":"acmepaymentscorp"
    }
  ],
  "TenantID":"acmepaymentscorp",
  "SiteAdminGroupID":"tenantadmin.acmepaymentscorp",
  "TenantBusinessID":"tenantbusiness.acmepaymentscorp",
  "TenantBusinessKey":"uddi:soa.com:atmosphere:tenant:acmepaymentscorp",
  "BusinessAdminGroupID":"bizadmin-tenantbusiness.acmepaymentscorp",
  "TenantName":"acmepaymentscorp",
  "LaaSIntegrationSupport":"com.soa.feature.disabled",
  "ForwardProxyAllowedHosts":[
    "*"
  ]
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json

Response Body

Name	Type	Description
TenantProperties	TenantProperties	Contains information about basic properties for the current tenant.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics