API Guide / API Reference / Metadata API / Describe
Describe

Use this API to get the module information including fields, relation and metadata information. 


URL

https://Witly.co/api/v2/{module name}/describe?token={0}[&format={1}]


HTTP Method

GET


Request Body

Not required


Request Parameters

Parameter

Required

Description

module name

Yes

Module API name (Acquired from Module API call)

token

Yes

Access token

format

Optional

Expected return format. The default is JSON. Values are JSON and XML. This parameter is optional.


Example Request

https://Witly.co/api/v2/customer/describe?token=5c33446ac1c049049f9232cf296bdf10


Example Response

{

"Name""Customer",

"API Name""customer",

"Type""Main",

"accessible""true",

"creatable""true",

"editable""true",

"deletable""true",

"Icon Url""http://Witly.co/res/customer/images/module-

icons/60f0e063-fbad-4576-a81b-2066035d589e_48px.png",

"Url""http://Witly.co/module/customer/home",

"Key Field""AutoNumber",

"Fields": [

{

"Name""Customer Name",

"Type""Text",

"Length"50,

"Updatable""true",

"Required""true",

"Unique""false",

"Default Value""",

},

{

"Name""Customer Status",

"Type""Picklist",

"Updatable""true",

"Required""false",

"Unique""false",

"Default Value""",

"List Value"["Account","Prospect"]

},

...

],

"Relations": [

{

"Name""Contacts",

"Type": "Bind"

},

{

"Name""Address",

"Type""Parent/Child"

}

]

}


Last modified on Jan 23, 2018