$format

If supported, the $format system query option allows clients to request a response in a particular format.

The Beas Service Layer allows additional formats.

youtube OData $format command, export types

 

Main formats:

Format

Description

json

Return value in JSON format

jsonarray

Return json array

xml

Return value in XML format

text/html

Return as HTML Table <table> ..</table>

csv

Return as CSV string

 

Additional formats:

You can define additional formats with comma, for example json,notempty,linefeed.

Only usable in combination with JSON, JSONARRAY or XML Format. No support in text/HTML, CSV or other formats.

Format

Description

notempty

Export only string fields, which are not empty.

(check only fields of Edm.String type)

notnull

Do not export fields, which are null.

trim

Delete all spaces on the right side.

(only fields of Edm.String type)

noheader

Do not export the header.

linefeed

Insert a line feed and return the JSON/XML in a readable format.

 

Note: Max. return size = 16 MByte (Unicode = 8 Million chars)

hmtoggle_plus1Examples:

Standard JSON

Workorder(1038)?$select=DocEntry,MailAddres,PrjCode

 

{"value": {"DocEntry":1038,"MailAddres":" ","PrjCode":null}}

 

JSON formated

Workorder(1038)?$select=DocEntry,MailAddres,PrjCode&$format=linefeed
{
    
    "value": 
         {
        "DocEntry": 1038,
        "MailAddres": " ",
        "PrjCode": null
        }
    
}

 

JSON without NULL values (PrjCode)

Workorder(1038)?$select=DocEntry,MailAddres,PrjCode&$format=linefeed,notnull

{
    
    "value": 
         {
        "DocEntry": 1038,
        "MailAddres": " "
        }
    
}

 

JSON without Spaces (see MailAddress)

Workorder(1038)?$select=DocEntry,MailAddres,PrjCode&$format=linefeed,notnull,trim
{
    
    "value": 
         {
        "DocEntry": 1038,
        "MailAddres": ""
        }
    
}

 

JSON Array with linefeed
Workorder(1038)?$select=DocEntry,MailAddres,PrjCode&$format=jsonarray,linefeed
{
    
    "value": 
         [
        1038,
        " ",
        null
        ]
    
}
 
XML with linefeed
Workorder(1038)?$select=DocEntry,MailAddres,PrjCode&$format=xml
 
<?xml version="1.0"?>
<row>
    <DocEntry>1038</DocEntry>
    <MailAddres> </MailAddres>
    <PrjCode>null</PrjCode>
</row>
 
CSV Format
Workorder(1038)?$select=DocEntry,MailAddres,PrjCode&$format=csv
docentry,mailaddres,prjcode
1038, ,
 
HTML
Workorder(1038)?$select=DocEntry,MailAddres,PrjCode&$format=html
<title></title>
<TABLE BORDER>
<TR><TH>docentry</TH><TH>mailaddres</TH><TH>prjcode</TH></TR><TR><TD>1038</TD><TD> </TD><TD></TD></TR></TABLE>

 

If you insert this in the browser, it returns the result in table format.

docentry

mailaddres

prjcode

1038