List Custom Object Attributes

Returns the list of attributes available for a custom object.

 

URL

{RMUrl}/api/objects/info/<ObjectVariableName>/attributes

 

REQUEST METHOD

GET

 

URL PARAMETERS

This feature does not have parameters.

 

REQUEST EXAMPLE

{RMUrl}/api/objects/info/book/attributes

 

SUCCESS RESPONSE

For more information on attribute types, see Appendix 1: Attribute Types.

 

SUCCESS RESPONSE EXAMPLES

[

{

"MaxLength":10,

"MinLength":2,

"Name":"Text",

"TypeName":"Text",

"Types":[

"Type 1",

"Type 2",

"Type 3"

],

"VariableName":"text"

"Required":false

},

{

"AllowedValues":["Op1","Op2"],

"Format":"SingleSelection",

"Name":"Single Selection",

"TypeName":"SingleSelect",

"VariableName":"single_selection"

"Required":false

},

{

"AllowedValues":["Op1","Op2"],

"Format":"MultipleSelection",

"Name":"List of Options",

"TypeName":"MultiSelect",

"VariableName":"listofoptions"

"Required":true

},

{

"Format":"Bullet",

"Name":"Topic",

"TypeName":"BulletList",

"VariableName":"topic"

"Required":true

},

{

"Name":"Link",

"TypeName":"Link",

"VariableName":"link"

"Required":false

},

{

"Format":"DateAndTime",

"Name":"Date/Time",

"TypeName":"DateTime",

"VariableName":"date_time"

"Required":true

},

{

"DecimalPlaces":2,

"MaxValue":100.0,

"MinValue":-100.0,

"Name":"Value",

"TypeName":"Number",

"VariableName":"numericvalue"

"Required":false

},

{

"Name":"Paragraph",

"TypeName":"Paragraph",

"VariableName":"paragraph"

"Required":true

},

{

"Name":"Email",

"TypeName":"Email",

"VariableName":"email"

"Required":true

},

{

"FileTypes":"doc;pdf;txt",

"MaxFileSize":2097152,

"MaxFiles":2,

"Name":"Attachment",

"TypeName":"Attachment",

"VariableName":"attachment"

"Required":true

},

{

"Format":"DateOnly",

"Name":"Date Only",

"TypeName":"DateOnly",

"VariableName":"date_only"

"Required":false

{,

{

"Name":"businesscompmultirel",

"TypeName":"MultipleRelationships",

"VariableName":"businesscompmultirel",

"Format":"MultipleRelationship",

"RelatedObjectInfo":{"Name":"BusinessComponent","DisplayName":"Business Component"}

"Required":true

},

{

"Name":"groupsinglerel",

"TypeName":"SingleRelationship",

"VariableName":"groupsinglerel",

"Description":"","Format":"SingleRelationship",

"RelatedObjectInfo":{"Name":"HumanResourcesGroup","DisplayName":"Group of People"}

"Required":true

},

]