SWAPI DOCS

Appearance

Exposes data + entity metadata v

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

This service is located at /odata/v4/-data/

Entity Data Model ​

ER Diagram

Legend ​

Legend

Base URLs:

Data

The actual data, organized by column name

Retrieves a list of data. ​

Code samples

shell
# You can also use wget
curl -X GET /odata/v4/-data/Data \
  -H 'Accept: application/json'
http
GET /odata/v4/-data/Data HTTP/1.1

Accept: application/json
javascript

const headers = {
  'Accept':'application/json'
};

fetch('/odata/v4/-data/Data',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/odata/v4/-data/Data',
  params: {
  }, headers: headers

p JSON.parse(result)
python
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/odata/v4/-data/Data', headers = headers)

print(r.json())
php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/odata/v4/-data/Data', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
java
URL obj = new URL("/odata/v4/-data/Data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/odata/v4/-data/Data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /Data

Parameters

NameInTypeRequiredDescription
$topqueryintegerfalseShow only the first n items, see Paging - Top
$skipqueryintegerfalseSkip the first n items, see Paging - Skip
$searchquerystringfalseSearch items by search phrases, see Searching
$filterquerystringfalseFilter items by property values, see Filtering
$countquerybooleanfalseInclude count of items, see Count
$orderbyqueryarray[string]falseOrder items by property values, see Sorting
$selectqueryarray[string]falseSelect properties to be returned, see Select

Enumerated Values ​

ParameterValue
$orderbydummy
$orderbydummy desc
$orderbyrecord/column
$orderbyrecord/column desc
$orderbyrecord/data
$orderbyrecord/data desc
$selectdummy
$selectrecord

Example responses

200 Response

json
{
  "@count": 0,
  "value": [
    {
      "dummy": "string",
      "record": [
        {
          "column": "string",
          "data": "string"
        }
      ]
    }
  ]
}

Responses

StatusMeaningDescriptionSchema
200OKRetrieved dataInline
4XXUnknownErrorerror

Response Schema

Status Code 200

Collection of Data

NameTypeRequiredRestrictionsDescription
» @countanyfalsenoneThe number of entities in the collection. Available when using the $count query option.

anyOf

NameTypeRequiredRestrictionsDescription
»» anonymousnumberfalsenonenone

or

NameTypeRequiredRestrictionsDescription
»» anonymousstringfalsenonenone

continued

NameTypeRequiredRestrictionsDescription
» value[DataService.Data]falsenonenone
»» The actual data, organized by column nameDataService.Datafalsenonenone
»»» dummystringfalsenonenone
»»» record[allOf]falsenonenone
»»»» Data_recordDataService.Data_record¦nullfalsenonenone
»»»»» columnstring¦nullfalsenonenone
»»»»» datastring¦nullfalsenonenone

Creates a single datum. ​

Code samples

shell
# You can also use wget
curl -X POST /odata/v4/-data/Data \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'
http
POST /odata/v4/-data/Data HTTP/1.1

Content-Type: application/json
Accept: application/json
javascript
const inputBody = '{
  "dummy": "string",
  "record": [
    {
      "column": "string",
      "data": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/odata/v4/-data/Data',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
ruby
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post '/odata/v4/-data/Data',
  params: {
  }, headers: headers

p JSON.parse(result)
python
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/odata/v4/-data/Data', headers = headers)

print(r.json())
php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/odata/v4/-data/Data', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
java
URL obj = new URL("/odata/v4/-data/Data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/odata/v4/-data/Data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /Data

Body parameter

json
{
  "dummy": "string",
  "record": [
    {
      "column": "string",
      "data": "string"
    }
  ]
}

Parameters

NameInTypeRequiredDescription
bodybodyDataService.Data-createtrueThe actual data, organized by column name

Example responses

201 Response

json
{
  "dummy": "string",
  "record": [
    {
      "column": "string",
      "data": "string"
    }
  ]
}

Responses

StatusMeaningDescriptionSchema
201CreatedCreated datumDataService.Data
4XXUnknownErrorerror

Retrieves a single datum. ​

Code samples

shell
# You can also use wget
curl -X GET /odata/v4/-data/Data('{dummy}') \
  -H 'Accept: application/json'
http
GET /odata/v4/-data/Data('{dummy}') HTTP/1.1

Accept: application/json
javascript

const headers = {
  'Accept':'application/json'
};

fetch('/odata/v4/-data/Data('{dummy}')',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/odata/v4/-data/Data('{dummy}')',
  params: {
  }, headers: headers

p JSON.parse(result)
python
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/odata/v4/-data/Data('{dummy}')', headers = headers)

print(r.json())
php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/odata/v4/-data/Data('{dummy}')', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
java
URL obj = new URL("/odata/v4/-data/Data('{dummy}')");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/odata/v4/-data/Data('{dummy}')", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /Data('{dummy}')

Parameters

NameInTypeRequiredDescription
$selectqueryarray[string]falseSelect properties to be returned, see Select
dummypathstringtruekey: dummy

Enumerated Values ​

ParameterValue
$selectdummy
$selectrecord

Example responses

200 Response

json
{
  "dummy": "string",
  "record": [
    {
      "column": "string",
      "data": "string"
    }
  ]
}

Responses

StatusMeaningDescriptionSchema
200OKRetrieved datumDataService.Data
4XXUnknownErrorerror

Changes a single datum. ​

Code samples

shell
# You can also use wget
curl -X PATCH /odata/v4/-data/Data('{dummy}') \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'
http
PATCH /odata/v4/-data/Data('{dummy}') HTTP/1.1

Content-Type: application/json
Accept: application/json
javascript
const inputBody = '{
  "record": [
    {
      "column": "string",
      "data": "string"
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/odata/v4/-data/Data('{dummy}')',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
ruby
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch '/odata/v4/-data/Data('{dummy}')',
  params: {
  }, headers: headers

p JSON.parse(result)
python
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('/odata/v4/-data/Data('{dummy}')', headers = headers)

print(r.json())
php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/odata/v4/-data/Data('{dummy}')', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
java
URL obj = new URL("/odata/v4/-data/Data('{dummy}')");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/odata/v4/-data/Data('{dummy}')", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /Data('{dummy}')

Body parameter

json
{
  "record": [
    {
      "column": "string",
      "data": "string"
    }
  ]
}

Parameters

NameInTypeRequiredDescription
bodybodyDataService.Data-updatetrueThe actual data, organized by column name
dummypathstringtruekey: dummy

Example responses

4XX Response

json
{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      {
        "code": "string",
        "message": "string",
        "target": "string"
      }
    ],
    "innererror": {}
  }
}

Responses

StatusMeaningDescriptionSchema
204No ContentSuccessNone
4XXUnknownErrorerror

Deletes a single datum. ​

Code samples

shell
# You can also use wget
curl -X DELETE /odata/v4/-data/Data('{dummy}') \
  -H 'Accept: application/json'
http
DELETE /odata/v4/-data/Data('{dummy}') HTTP/1.1

Accept: application/json
javascript

const headers = {
  'Accept':'application/json'
};

fetch('/odata/v4/-data/Data('{dummy}')',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.delete '/odata/v4/-data/Data('{dummy}')',
  params: {
  }, headers: headers

p JSON.parse(result)
python
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/odata/v4/-data/Data('{dummy}')', headers = headers)

print(r.json())
php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/odata/v4/-data/Data('{dummy}')', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
java
URL obj = new URL("/odata/v4/-data/Data('{dummy}')");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/odata/v4/-data/Data('{dummy}')", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /Data('{dummy}')

Parameters

NameInTypeRequiredDescription
dummypathstringtruekey: dummy

Example responses

4XX Response

json
{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      {
        "code": "string",
        "message": "string",
        "target": "string"
      }
    ],
    "innererror": {}
  }
}

Responses

StatusMeaningDescriptionSchema
204No ContentSuccessNone
4XXUnknownErrorerror

Entities

Metadata like name and columns/elements

Retrieves a list of entities. ​

Code samples

shell
# You can also use wget
curl -X GET /odata/v4/-data/Entities \
  -H 'Accept: application/json'
http
GET /odata/v4/-data/Entities HTTP/1.1

Accept: application/json
javascript

const headers = {
  'Accept':'application/json'
};

fetch('/odata/v4/-data/Entities',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/odata/v4/-data/Entities',
  params: {
  }, headers: headers

p JSON.parse(result)
python
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/odata/v4/-data/Entities', headers = headers)

print(r.json())
php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/odata/v4/-data/Entities', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
java
URL obj = new URL("/odata/v4/-data/Entities");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/odata/v4/-data/Entities", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /Entities

Parameters

NameInTypeRequiredDescription
$topqueryintegerfalseShow only the first n items, see Paging - Top
$skipqueryintegerfalseSkip the first n items, see Paging - Skip
$searchquerystringfalseSearch items by search phrases, see Searching
$filterquerystringfalseFilter items by property values, see Filtering
$countquerybooleanfalseInclude count of items, see Count
$orderbyqueryarray[string]falseOrder items by property values, see Sorting
$selectqueryarray[string]falseSelect properties to be returned, see Select
$expandqueryarray[string]falseThe value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see Expand

Enumerated Values ​

ParameterValue
$orderbyname
$orderbyname desc
$selectname
$expand*
$expandcolumns

Example responses

200 Response

json
{
  "@count": 0,
  "value": [
    {}
  ]
}

Responses

StatusMeaningDescriptionSchema
200OKRetrieved entitiesInline
4XXUnknownErrorerror

Response Schema

Status Code 200

Collection of Entities

NameTypeRequiredRestrictionsDescription
» @countanyfalsenoneThe number of entities in the collection. Available when using the $count query option.

anyOf

NameTypeRequiredRestrictionsDescription
»» anonymousnumberfalsenonenone

or

NameTypeRequiredRestrictionsDescription
»» anonymousstringfalsenonenone

continued

NameTypeRequiredRestrictionsDescription
» value[object]falsenonenone

Creates a single entity. ​

Code samples

shell
# You can also use wget
curl -X POST /odata/v4/-data/Entities \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'
http
POST /odata/v4/-data/Entities HTTP/1.1

Content-Type: application/json
Accept: application/json
javascript
const inputBody = '{
  "name": "string",
  "columns": [
    {
      "up__name": "string",
      "name": "string",
      "type": "string",
      "isKey": true
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/odata/v4/-data/Entities',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
ruby
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post '/odata/v4/-data/Entities',
  params: {
  }, headers: headers

p JSON.parse(result)
python
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/odata/v4/-data/Entities', headers = headers)

print(r.json())
php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/odata/v4/-data/Entities', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
java
URL obj = new URL("/odata/v4/-data/Entities");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/odata/v4/-data/Entities", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /Entities

Body parameter

json
{
  "name": "string",
  "columns": [
    {
      "up__name": "string",
      "name": "string",
      "type": "string",
      "isKey": true
    }
  ]
}

Parameters

NameInTypeRequiredDescription
bodybodyDataService.Entities-createtrueMetadata like name and columns/elements

Example responses

201 Response

json
{}

Responses

StatusMeaningDescriptionSchema
201CreatedCreated entityInline
4XXUnknownErrorerror

Response Schema

Status Code 201

See DataService.Entities

NameTypeRequiredRestrictionsDescription

Retrieves a single entity. ​

Code samples

shell
# You can also use wget
curl -X GET /odata/v4/-data/Entities('{name}') \
  -H 'Accept: application/json'
http
GET /odata/v4/-data/Entities('{name}') HTTP/1.1

Accept: application/json
javascript

const headers = {
  'Accept':'application/json'
};

fetch('/odata/v4/-data/Entities('{name}')',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/odata/v4/-data/Entities('{name}')',
  params: {
  }, headers: headers

p JSON.parse(result)
python
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/odata/v4/-data/Entities('{name}')', headers = headers)

print(r.json())
php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/odata/v4/-data/Entities('{name}')', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
java
URL obj = new URL("/odata/v4/-data/Entities('{name}')");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/odata/v4/-data/Entities('{name}')", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /Entities('{name}')

Parameters

NameInTypeRequiredDescription
$selectqueryarray[string]falseSelect properties to be returned, see Select
$expandqueryarray[string]falseThe value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see Expand
namepathstringtruekey: name

Enumerated Values ​

ParameterValue
$selectname
$expand*
$expandcolumns

Example responses

200 Response

json
{}

Responses

StatusMeaningDescriptionSchema
200OKRetrieved entityInline
4XXUnknownErrorerror

Response Schema

Status Code 200

See DataService.Entities

NameTypeRequiredRestrictionsDescription

Changes a single entity. ​

Code samples

shell
# You can also use wget
curl -X PATCH /odata/v4/-data/Entities('{name}') \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'
http
PATCH /odata/v4/-data/Entities('{name}') HTTP/1.1

Content-Type: application/json
Accept: application/json
javascript
const inputBody = '{
  "columns": [
    {
      "up__name": "string",
      "name": "string",
      "type": "string",
      "isKey": true
    }
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/odata/v4/-data/Entities('{name}')',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
ruby
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch '/odata/v4/-data/Entities('{name}')',
  params: {
  }, headers: headers

p JSON.parse(result)
python
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('/odata/v4/-data/Entities('{name}')', headers = headers)

print(r.json())
php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/odata/v4/-data/Entities('{name}')', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
java
URL obj = new URL("/odata/v4/-data/Entities('{name}')");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/odata/v4/-data/Entities('{name}')", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /Entities('{name}')

Body parameter

json
{
  "columns": [
    {
      "up__name": "string",
      "name": "string",
      "type": "string",
      "isKey": true
    }
  ]
}

Parameters

NameInTypeRequiredDescription
bodybodyDataService.Entities-updatetrueMetadata like name and columns/elements
namepathstringtruekey: name

Example responses

4XX Response

json
{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      {
        "code": "string",
        "message": "string",
        "target": "string"
      }
    ],
    "innererror": {}
  }
}

Responses

StatusMeaningDescriptionSchema
204No ContentSuccessNone
4XXUnknownErrorerror

Deletes a single entity. ​

Code samples

shell
# You can also use wget
curl -X DELETE /odata/v4/-data/Entities('{name}') \
  -H 'Accept: application/json'
http
DELETE /odata/v4/-data/Entities('{name}') HTTP/1.1

Accept: application/json
javascript

const headers = {
  'Accept':'application/json'
};

fetch('/odata/v4/-data/Entities('{name}')',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.delete '/odata/v4/-data/Entities('{name}')',
  params: {
  }, headers: headers

p JSON.parse(result)
python
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/odata/v4/-data/Entities('{name}')', headers = headers)

print(r.json())
php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/odata/v4/-data/Entities('{name}')', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
java
URL obj = new URL("/odata/v4/-data/Entities('{name}')");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/odata/v4/-data/Entities('{name}')", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /Entities('{name}')

Parameters

NameInTypeRequiredDescription
namepathstringtruekey: name

Example responses

4XX Response

json
{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      {
        "code": "string",
        "message": "string",
        "target": "string"
      }
    ],
    "innererror": {}
  }
}

Responses

StatusMeaningDescriptionSchema
204No ContentSuccessNone
4XXUnknownErrorerror

Retrieves a list of columns of a entity. ​

Code samples

shell
# You can also use wget
curl -X GET /odata/v4/-data/Entities('{name}')/columns \
  -H 'Accept: application/json'
http
GET /odata/v4/-data/Entities('{name}')/columns HTTP/1.1

Accept: application/json
javascript

const headers = {
  'Accept':'application/json'
};

fetch('/odata/v4/-data/Entities('{name}')/columns',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/odata/v4/-data/Entities('{name}')/columns',
  params: {
  }, headers: headers

p JSON.parse(result)
python
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/odata/v4/-data/Entities('{name}')/columns', headers = headers)

print(r.json())
php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/odata/v4/-data/Entities('{name}')/columns', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
java
URL obj = new URL("/odata/v4/-data/Entities('{name}')/columns");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/odata/v4/-data/Entities('{name}')/columns", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /Entities('{name}')/columns

Parameters

NameInTypeRequiredDescription
$topqueryintegerfalseShow only the first n items, see Paging - Top
$skipqueryintegerfalseSkip the first n items, see Paging - Skip
$searchquerystringfalseSearch items by search phrases, see Searching
$filterquerystringfalseFilter items by property values, see Filtering
$countquerybooleanfalseInclude count of items, see Count
$orderbyqueryarray[string]falseOrder items by property values, see Sorting
$selectqueryarray[string]falseSelect properties to be returned, see Select
$expandqueryarray[string]falseThe value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see Expand
namepathstringtruekey: name

Enumerated Values ​

ParameterValue
$orderbyup__name
$orderbyup__name desc
$orderbyname
$orderbyname desc
$orderbytype
$orderbytype desc
$orderbyisKey
$orderbyisKey desc
$selectup__name
$selectname
$selecttype
$selectisKey
$expand*
$expandup_

Example responses

200 Response

json
{
  "@count": 0,
  "value": [
    {}
  ]
}

Responses

StatusMeaningDescriptionSchema
200OKRetrieved columnsInline
4XXUnknownErrorerror

Response Schema

Status Code 200

Collection of Entities_columns

NameTypeRequiredRestrictionsDescription
» @countanyfalsenoneThe number of entities in the collection. Available when using the $count query option.

anyOf

NameTypeRequiredRestrictionsDescription
»» anonymousnumberfalsenonenone

or

NameTypeRequiredRestrictionsDescription
»» anonymousstringfalsenonenone

continued

NameTypeRequiredRestrictionsDescription
» value[object]falsenonenone

Creates a single column of a entity. ​

Code samples

shell
# You can also use wget
curl -X POST /odata/v4/-data/Entities('{name}')/columns \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'
http
POST /odata/v4/-data/Entities('{name}')/columns HTTP/1.1

Content-Type: application/json
Accept: application/json
javascript
const inputBody = '{
  "up__name": "string",
  "name": "string",
  "type": "string",
  "isKey": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/odata/v4/-data/Entities('{name}')/columns',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
ruby
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post '/odata/v4/-data/Entities('{name}')/columns',
  params: {
  }, headers: headers

p JSON.parse(result)
python
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/odata/v4/-data/Entities('{name}')/columns', headers = headers)

print(r.json())
php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/odata/v4/-data/Entities('{name}')/columns', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
java
URL obj = new URL("/odata/v4/-data/Entities('{name}')/columns");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/odata/v4/-data/Entities('{name}')/columns", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /Entities('{name}')/columns

Body parameter

json
{
  "up__name": "string",
  "name": "string",
  "type": "string",
  "isKey": true
}

Parameters

NameInTypeRequiredDescription
bodybodyDataService.Entities_columns-createtrueNew column
namepathstringtruekey: name

Example responses

201 Response

json
{}

Responses

StatusMeaningDescriptionSchema
201CreatedCreated columnInline
4XXUnknownErrorerror

Response Schema

Status Code 201

See DataService.Entities_columns

NameTypeRequiredRestrictionsDescription

Entities_columns

Retrieves a list of entities_columns. ​

Code samples

shell
# You can also use wget
curl -X GET /odata/v4/-data/Entities_columns \
  -H 'Accept: application/json'
http
GET /odata/v4/-data/Entities_columns HTTP/1.1

Accept: application/json
javascript

const headers = {
  'Accept':'application/json'
};

fetch('/odata/v4/-data/Entities_columns',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/odata/v4/-data/Entities_columns',
  params: {
  }, headers: headers

p JSON.parse(result)
python
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/odata/v4/-data/Entities_columns', headers = headers)

print(r.json())
php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/odata/v4/-data/Entities_columns', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
java
URL obj = new URL("/odata/v4/-data/Entities_columns");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/odata/v4/-data/Entities_columns", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /Entities_columns

Parameters

NameInTypeRequiredDescription
$topqueryintegerfalseShow only the first n items, see Paging - Top
$skipqueryintegerfalseSkip the first n items, see Paging - Skip
$searchquerystringfalseSearch items by search phrases, see Searching
$filterquerystringfalseFilter items by property values, see Filtering
$countquerybooleanfalseInclude count of items, see Count
$orderbyqueryarray[string]falseOrder items by property values, see Sorting
$selectqueryarray[string]falseSelect properties to be returned, see Select
$expandqueryarray[string]falseThe value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see Expand

Enumerated Values ​

ParameterValue
$orderbyup__name
$orderbyup__name desc
$orderbyname
$orderbyname desc
$orderbytype
$orderbytype desc
$orderbyisKey
$orderbyisKey desc
$selectup__name
$selectname
$selecttype
$selectisKey
$expand*
$expandup_

Example responses

200 Response

json
{
  "@count": 0,
  "value": [
    {}
  ]
}

Responses

StatusMeaningDescriptionSchema
200OKRetrieved entities_columnsInline
4XXUnknownErrorerror

Response Schema

Status Code 200

Collection of Entities_columns

NameTypeRequiredRestrictionsDescription
» @countanyfalsenoneThe number of entities in the collection. Available when using the $count query option.

anyOf

NameTypeRequiredRestrictionsDescription
»» anonymousnumberfalsenonenone

or

NameTypeRequiredRestrictionsDescription
»» anonymousstringfalsenonenone

continued

NameTypeRequiredRestrictionsDescription
» value[object]falsenonenone

Creates a single entities_column. ​

Code samples

shell
# You can also use wget
curl -X POST /odata/v4/-data/Entities_columns \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'
http
POST /odata/v4/-data/Entities_columns HTTP/1.1

Content-Type: application/json
Accept: application/json
javascript
const inputBody = '{
  "up__name": "string",
  "name": "string",
  "type": "string",
  "isKey": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/odata/v4/-data/Entities_columns',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
ruby
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post '/odata/v4/-data/Entities_columns',
  params: {
  }, headers: headers

p JSON.parse(result)
python
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/odata/v4/-data/Entities_columns', headers = headers)

print(r.json())
php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/odata/v4/-data/Entities_columns', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
java
URL obj = new URL("/odata/v4/-data/Entities_columns");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/odata/v4/-data/Entities_columns", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /Entities_columns

Body parameter

json
{
  "up__name": "string",
  "name": "string",
  "type": "string",
  "isKey": true
}

Parameters

NameInTypeRequiredDescription
bodybodyDataService.Entities_columns-createtrueNew entities_column

Example responses

201 Response

json
{}

Responses

StatusMeaningDescriptionSchema
201CreatedCreated entities_columnInline
4XXUnknownErrorerror

Response Schema

Status Code 201

See DataService.Entities_columns

NameTypeRequiredRestrictionsDescription

Retrieves a single entities_column. ​

Code samples

shell
# You can also use wget
curl -X GET /odata/v4/-data/Entities_columns('{up__name}') \
  -H 'Accept: application/json'
http
GET /odata/v4/-data/Entities_columns('{up__name}') HTTP/1.1

Accept: application/json
javascript

const headers = {
  'Accept':'application/json'
};

fetch('/odata/v4/-data/Entities_columns('{up__name}')',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/odata/v4/-data/Entities_columns('{up__name}')',
  params: {
  }, headers: headers

p JSON.parse(result)
python
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/odata/v4/-data/Entities_columns('{up__name}')', headers = headers)

print(r.json())
php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/odata/v4/-data/Entities_columns('{up__name}')', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
java
URL obj = new URL("/odata/v4/-data/Entities_columns('{up__name}')");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/odata/v4/-data/Entities_columns('{up__name}')", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /Entities_columns('{up__name}')

Parameters

NameInTypeRequiredDescription
$selectqueryarray[string]falseSelect properties to be returned, see Select
$expandqueryarray[string]falseThe value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see Expand
up__namepathstringtruekey: up__name

Enumerated Values ​

ParameterValue
$selectup__name
$selectname
$selecttype
$selectisKey
$expand*
$expandup_

Example responses

200 Response

json
{}

Responses

StatusMeaningDescriptionSchema
200OKRetrieved entities_columnInline
4XXUnknownErrorerror

Response Schema

Status Code 200

See DataService.Entities_columns

NameTypeRequiredRestrictionsDescription

Changes a single entities_column. ​

Code samples

shell
# You can also use wget
curl -X PATCH /odata/v4/-data/Entities_columns('{up__name}') \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'
http
PATCH /odata/v4/-data/Entities_columns('{up__name}') HTTP/1.1

Content-Type: application/json
Accept: application/json
javascript
const inputBody = '{
  "name": "string",
  "type": "string",
  "isKey": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/odata/v4/-data/Entities_columns('{up__name}')',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
ruby
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.patch '/odata/v4/-data/Entities_columns('{up__name}')',
  params: {
  }, headers: headers

p JSON.parse(result)
python
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.patch('/odata/v4/-data/Entities_columns('{up__name}')', headers = headers)

print(r.json())
php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/odata/v4/-data/Entities_columns('{up__name}')', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
java
URL obj = new URL("/odata/v4/-data/Entities_columns('{up__name}')");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/odata/v4/-data/Entities_columns('{up__name}')", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /Entities_columns('{up__name}')

Body parameter

json
{
  "name": "string",
  "type": "string",
  "isKey": true
}

Parameters

NameInTypeRequiredDescription
bodybodyDataService.Entities_columns-updatetrueNew property values
up__namepathstringtruekey: up__name

Example responses

4XX Response

json
{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      {
        "code": "string",
        "message": "string",
        "target": "string"
      }
    ],
    "innererror": {}
  }
}

Responses

StatusMeaningDescriptionSchema
204No ContentSuccessNone
4XXUnknownErrorerror

Deletes a single entities_column. ​

Code samples

shell
# You can also use wget
curl -X DELETE /odata/v4/-data/Entities_columns('{up__name}') \
  -H 'Accept: application/json'
http
DELETE /odata/v4/-data/Entities_columns('{up__name}') HTTP/1.1

Accept: application/json
javascript

const headers = {
  'Accept':'application/json'
};

fetch('/odata/v4/-data/Entities_columns('{up__name}')',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.delete '/odata/v4/-data/Entities_columns('{up__name}')',
  params: {
  }, headers: headers

p JSON.parse(result)
python
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/odata/v4/-data/Entities_columns('{up__name}')', headers = headers)

print(r.json())
php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/odata/v4/-data/Entities_columns('{up__name}')', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
java
URL obj = new URL("/odata/v4/-data/Entities_columns('{up__name}')");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/odata/v4/-data/Entities_columns('{up__name}')", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /Entities_columns('{up__name}')

Parameters

NameInTypeRequiredDescription
up__namepathstringtruekey: up__name

Example responses

4XX Response

json
{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      {
        "code": "string",
        "message": "string",
        "target": "string"
      }
    ],
    "innererror": {}
  }
}

Responses

StatusMeaningDescriptionSchema
204No ContentSuccessNone
4XXUnknownErrorerror

Retrieves up_ of a entities_column. ​

Code samples

shell
# You can also use wget
curl -X GET /odata/v4/-data/Entities_columns('{up__name}')/up_ \
  -H 'Accept: application/json'
http
GET /odata/v4/-data/Entities_columns('{up__name}')/up_ HTTP/1.1

Accept: application/json
javascript

const headers = {
  'Accept':'application/json'
};

fetch('/odata/v4/-data/Entities_columns('{up__name}')/up_',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
ruby
require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get '/odata/v4/-data/Entities_columns('{up__name}')/up_',
  params: {
  }, headers: headers

p JSON.parse(result)
python
import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/odata/v4/-data/Entities_columns('{up__name}')/up_', headers = headers)

print(r.json())
php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/odata/v4/-data/Entities_columns('{up__name}')/up_', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
java
URL obj = new URL("/odata/v4/-data/Entities_columns('{up__name}')/up_");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/odata/v4/-data/Entities_columns('{up__name}')/up_", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /Entities_columns('{up__name}')/up_

Parameters

NameInTypeRequiredDescription
$selectqueryarray[string]falseSelect properties to be returned, see Select
$expandqueryarray[string]falseThe value of $expand query option is a comma-separated list of navigation property names, stream property names, or $value indicating the stream content of a media-entity. The corresponding related entities and stream values will be represented inline, see Expand
up__namepathstringtruekey: up__name

Enumerated Values ​

ParameterValue
$selectname
$expand*
$expandcolumns

Example responses

200 Response

json
{}

Responses

StatusMeaningDescriptionSchema
200OKRetrieved up_Inline
4XXUnknownErrorerror

Response Schema

Status Code 200

See DataService.Entities

NameTypeRequiredRestrictionsDescription

Batch Requests

Sends a group of requests ​

Code samples

shell
# You can also use wget
curl -X POST /odata/v4/-data/$batch \
  -H 'Content-Type: multipart/mixed;boundary=request-separator' \
  -H 'Accept: multipart/mixed'
http
POST /odata/v4/-data/$batch HTTP/1.1

Content-Type: multipart/mixed;boundary=request-separator
Accept: multipart/mixed
javascript
const inputBody = 'string';
const headers = {
  'Content-Type':'multipart/mixed;boundary=request-separator',
  'Accept':'multipart/mixed'
};

fetch('/odata/v4/-data/$batch',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});
ruby
require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'multipart/mixed;boundary=request-separator',
  'Accept' => 'multipart/mixed'
}

result = RestClient.post '/odata/v4/-data/$batch',
  params: {
  }, headers: headers

p JSON.parse(result)
python
import requests
headers = {
  'Content-Type': 'multipart/mixed;boundary=request-separator',
  'Accept': 'multipart/mixed'
}

r = requests.post('/odata/v4/-data/$batch', headers = headers)

print(r.json())
php
<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'multipart/mixed;boundary=request-separator',
    'Accept' => 'multipart/mixed',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/odata/v4/-data/$batch', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...
java
URL obj = new URL("/odata/v4/-data/$batch");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());
go
package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"multipart/mixed;boundary=request-separator"},
        "Accept": []string{"multipart/mixed"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/odata/v4/-data/$batch", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /$batch

Group multiple requests into a single request payload, see Batch Requests.

Please note that "Try it out" is not supported for this request.

Body parameter

Parameters

NameInTypeRequiredDescription
bodybodystringtrueBatch request

Example responses

200 Response

4XX Response

json
{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      {
        "code": "string",
        "message": "string",
        "target": "string"
      }
    ],
    "innererror": {}
  }
}

Responses

StatusMeaningDescriptionSchema
200OKBatch responsestring
4XXUnknownErrorerror

Schemas ​

DataService.Data

json
{
  "dummy": "string",
  "record": [
    {
      "column": "string",
      "data": "string"
    }
  ]
}

The actual data, organized by column name

Properties ​

NameTypeRequiredRestrictionsDescription
dummystringfalsenonenone
record[allOf]falsenonenone

DataService.Data-create

json
{
  "dummy": "string",
  "record": [
    {
      "column": "string",
      "data": "string"
    }
  ]
}

The actual data, organized by column name (for create)

Properties ​

NameTypeRequiredRestrictionsDescription
dummystringtruenonenone
record[allOf]falsenonenone

DataService.Data-update

json
{
  "record": [
    {
      "column": "string",
      "data": "string"
    }
  ]
}

The actual data, organized by column name (for update)

Properties ​

NameTypeRequiredRestrictionsDescription
record[allOf]falsenonenone

DataService.Data_record

json
{
  "column": "string",
  "data": "string"
}

Data_record

Properties ​

NameTypeRequiredRestrictionsDescription
columnstring¦nullfalsenonenone
datastring¦nullfalsenonenone

DataService.Data_record-create

json
{
  "column": "string",
  "data": "string"
}

Data_record (for create)

Properties ​

NameTypeRequiredRestrictionsDescription
columnstring¦nullfalsenonenone
datastring¦nullfalsenonenone

DataService.Data_record-update

json
{
  "column": "string",
  "data": "string"
}

Data_record (for update)

Properties ​

NameTypeRequiredRestrictionsDescription
columnstring¦nullfalsenonenone
datastring¦nullfalsenonenone

DataService.Entities

json
{
  "name": "string",
  "columns": [
    {}
  ],
  "columns@count": 0
}

Metadata like name and columns/elements

Properties ​

NameTypeRequiredRestrictionsDescription
namestringfalsenonenone
columns[object]falsenonenone
columns@countcountfalsenoneThe number of entities in the collection. Available when using the $count query option.

DataService.Entities-create

json
{
  "name": "string",
  "columns": [
    {
      "up__name": "string",
      "name": "string",
      "type": "string",
      "isKey": true
    }
  ]
}

Metadata like name and columns/elements (for create)

Properties ​

NameTypeRequiredRestrictionsDescription
namestringtruenonenone
columns[DataService.Entities_columns-create]falsenonenone

DataService.Entities-update

json
{
  "columns": [
    {
      "up__name": "string",
      "name": "string",
      "type": "string",
      "isKey": true
    }
  ]
}

Metadata like name and columns/elements (for update)

Properties ​

NameTypeRequiredRestrictionsDescription
columns[DataService.Entities_columns-create]falsenonenone

DataService.Entities_columns

json
{
  "up_": {},
  "up__name": "string",
  "name": "string",
  "type": "string",
  "isKey": true
}

Entities_columns

Properties ​

NameTypeRequiredRestrictionsDescription
up_objectfalsenoneSee DataService.Entities
up__namestringfalsenonenone
namestring¦nullfalsenonenone
typestring¦nullfalsenonenone
isKeyboolean¦nullfalsenonenone

DataService.Entities_columns-create

json
{
  "up__name": "string",
  "name": "string",
  "type": "string",
  "isKey": true
}

Entities_columns (for create)

Properties ​

NameTypeRequiredRestrictionsDescription
up__namestringtruenonenone
namestring¦nullfalsenonenone
typestring¦nullfalsenonenone
isKeyboolean¦nullfalsenonenone

DataService.Entities_columns-update

json
{
  "name": "string",
  "type": "string",
  "isKey": true
}

Entities_columns (for update)

Properties ​

NameTypeRequiredRestrictionsDescription
namestring¦nullfalsenonenone
typestring¦nullfalsenonenone
isKeyboolean¦nullfalsenonenone

count

json
0

The number of entities in the collection. Available when using the $count query option.

Properties ​

anyOf

NameTypeRequiredRestrictionsDescription
anonymousnumberfalsenonenone

or

NameTypeRequiredRestrictionsDescription
anonymousstringfalsenonenone

error

json
{
  "error": {
    "code": "string",
    "message": "string",
    "target": "string",
    "details": [
      {
        "code": "string",
        "message": "string",
        "target": "string"
      }
    ],
    "innererror": {}
  }
}

Properties ​

NameTypeRequiredRestrictionsDescription
errorobjecttruenonenone
» codestringtruenonenone
» messagestringtruenonenone
» targetstringfalsenonenone
» details[object]falsenonenone
»» codestringtruenonenone
»» messagestringtruenonenone
»» targetstringfalsenonenone
» innererrorobjectfalsenoneThe structure of this object is service-specific