Retrieve List of Cell

Overview

Get a list of existing Cell information

Required Privileges

Only unit users permitted

Restrictions

OData Restrictions
- Always handles Content-Type in the request header as application/json
- Only accepts the request body in the JSON format
- Only application/json is supported for Content-Type in the request header and the JSON format for the response body
- Response body data is not ensured if atom or xml is specified in the $format query option, although it does not result in an error

Request

Request URL

{UnitURL}__ctl/Cell

Request Method

GET

Request Query

The following query parameters are available

Query Name	Overview	Effective Value	Required	Notes
p_cookie_peer	Cookie Authentication Value	The cookie authentication value returned from the server during authentication	No	Valid only if no Authorization header specified Specify this when cookie authentication information is to be used

Full-text Search (q) Query

Request Header

Common Request Header

Header Name	Overview	Effective Value	Required	Notes
X-HTTP-Method-Override	Method override function	User-defined	No	Specifying this value in a request with the POST method indicates that the specified value is used as the method
X-Override	Header override function	${OverwrittenHeaderName}:${Value}	No	The normal HTTP header value is overwritten. Specify multiple X-Override headers for the overwriting of multiple headers
X-Personium-RequestKey	RequestKey field value output in the event log	Single-byte alphanumeric characters, hyphens ("-"), and underscores ("_") Maximum of 128 characters	No	When not specified, default value given with ${4 digits}_${22 digits} Base64url characters format representing an UUID for each request

OData Common Request Header

Header Name	Overview	Effective Value	Required	Notes
Authorization	Specifies authentication information in the OAuth 2.0 format	Bearer {AccessToken}	No	* Authentication tokens are the tokens acquired using the Authentication Token Acquisition API

OData List Request Header

Header Name	Overview	Effective Value	Required	Notes
Accept	Specifies the response body format	application/json	No	[application/json] by default

Request Body

None

Response

Response Code

200

Response Header

Header Name	Overview	Notes
Content-Type	Format of data to be returned
DataServiceVersion	OData version
Access-Control-Allow-Origin	Cross domain communication permission header	Return value fixed to "*"
X-Personium-Version	Personium API version	Version of the API used to process the request

Response Body

Common

The response is a JSON object defined in an object (subobject)

Object	Name(Key)	Type	Value
Root	d	object	Object{1}
{1}	results	array	Array object {2}
{2}	__metadata	object	Object{3}
{3}	uri	string	URL to the resource that was created
{3}	etag	string	Etag value
{2}	__published	string	Creation date (UNIX time)
{2}	__updated	string	Update date (UNIX time)
{1}	__count	string	Get number of results in $inlinecount query

Cell specific response body

Object	Name(Key)	Type	Value
{3}	type	string	UnitCtl.Cell
{2}	Name	string	Cell name

Error Messages

Refer to Error Message List

Response Sample

{
  "d": {
    "results": [
      {
        "__metadata": {
          "uri": "https://unit1.example/__ctl/Cell (Name = cell1)",
          "etag": "W/\"1-1480553481439\"",
          "type": "UnitCtl.Cell"
        },
        "Name": "cell1",
        "__published": "/Date(1480553481439)/",
        "__updated": "/Date(1480553481439)/"
      },
      {
        "__metadata": {
          "uri": "https://unit1.example/__ctl/Cell (Name = cell2)",
          "etag": "W/\"1-1480659614484\"",
          "type": "UnitCtl.Cell"
        },
        "Name": "cell2",
        "__published": "/Date(1480659614484)/",
        "__updated": "/Date(1480659614484)/"
      }
    ]
  }
}

cURL Command

curl "https://unit1.example/__ctl/Cell" -X GET -i \
-H 'Authorization: Bearer PEFzc2V...(snip)...lvbj4' -H 'Accept: application/json'