AgileApps Support Wiki Pre Release

Difference between revisions of "REST API:object Resource"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
The <tt>object</tt> resource lets you access and modify object metadata (the data that defines object types).
The <tt>object</tt> resource lets you access and modify object metadata (the data that defines object types).
{{Warn|Information on this page is [[Provisional]].}}


===Retrieve an Object===
===Retrieve an Object===
Line 17: Line 15:
{{Query Parameters|
{{Query Parameters|
:*<tt>appId</tt> - Retrieve object metadata for the specified application, only.
:*<tt>appId</tt> - Retrieve object metadata for the specified application, only.
::Example: <tt>{{platformURL}}/rest/object?appId=28473662nkry99az</tt>
::Example: <tt><nowiki>https://yourDomain/rest/object?appId=28473662nkry99az</nowiki></tt>
::To get an application ID:
::To get an application ID:
::# Go to '''[[File:GearIcon.png]] > Administration > Applications'''<br>A list of applications is displayed.
::# Go to '''[[File:GearIcon.png]] > Administration > Applications'''<br>A list of applications is displayed.
::# Get the ID from '''Application ID''' column
::# Get the ID from '''Application ID''' column
 
}}
;Response:Metadata structure of the Object identified by the [[Object Type Identifier]]
;Response:Metadata structure of the Object identified by the [[Object Type Identifier]]


Latest revision as of 20:52, 23 July 2015

The object resource lets you access and modify object metadata (the data that defines object types).

Retrieve an Object

Identifies and retrieves metadata for the specified object.

Access Permissions

Lock-tiny.gif

Users that have the Customize Objects permission can manage Objects. 
Method
GET
URI
https://{yourDomain}/networking/rest/object/{objectName}
Response
Metadata structure of the Object identified by the Object Type Identifier

Retrieve all Objects

Retrieve all Objects

Method
GET
URI
https://{yourDomain}/networking/rest/object
Query Parameters
  • appId - Retrieve object metadata for the specified application, only.
Example: https://yourDomain/rest/object?appId=28473662nkry99az
To get an application ID:
  1. Go to GearIcon.png > Administration > Applications
    A list of applications is displayed.
  2. Get the ID from Application ID column
For more information, see: Specifying Query Parameters in REST APIs
Response
Metadata structure of the Object identified by the Object Type Identifier

Add an Object

Adds an object.

Considerations
  • Object names:
  • Must start with an alphabetic character.
  • May contain only alphanumeric (a-z A-Z 0-9) and underscores (_).
  • May not contain spaces or other characters.
  • Must be 32 characters or less.
  • When objects are added using REST APIs, they do not have a corresponding data-entry Form that would allow them to be accessed and updated in the GUI. Such forms must be defined using the GUI.
Method
POST
URI
https://{yourDomain}/networking/rest/object
Request
<syntaxhighlight lang="xml" enclose="div">

<platform> 

   <object>
       <objectName>AddObjectViaREST</objectName>
       <displayTitle>AddObjectViaRESTApi</displayTitle>
       <singluarDisplayTitle>AddObjectViaRESTApi</singluarDisplayTitle>
       <canTrackActivities>true</canTrackActivities>
       <canTrackNotes>true</canTrackNotes>
       <isActive>true</isActive>
       <isEnabledAsATab>true</isEnabledAsATab>
       <custHelpUrl>www.example.com</custHelpUrl>
       <allowReports>true</allowReports>
       <allowSearch>true</allowSearch>
       <extendedObjectMetaData>REST add</extendedObjectMetaData>
       <description>Adding an Object through REST API</description>
   </object>

</platform> </syntaxhighlight>

Response
<syntaxhighlight lang="xml" enclose="div">

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <platform> 

   <message>
       0
       <description>Success</description>
       <id>34813dcd768740ad91dc4f168023a9cc</id>
   </message>

</platform> </syntaxhighlight>

See also: REST API:Error Codes

Update an Object

Notepad.png

Note: When fields are added to an object using REST APIs, they do not appear in Object Forms. To appear there, they must be specified using the GUI.

Method
PUT
URI
https://{yourDomain}/networking/rest/object/{objectName}
Request
<syntaxhighlight lang="xml" enclose="div">

<platform> 

   <object>
       <objectName>AddObjectViaREST</objectName>
       <displayTitle>AddObjectViaRESTApi</displayTitle>
       <singluarDisplayTitle>AddObjectViaRESTApi</singluarDisplayTitle>
       <canTrackActivities>true</canTrackActivities>
       <canTrackNotes>true</canTrackNotes>
       <isActive>true</isActive>
       <isEnabledAsATab>true</isEnabledAsATab>
       <custHelpUrl>www.example.com</custHelpUrl>
       <allowReports>true</allowReports>
       <allowSearch>true</allowSearch>
       <extendedObjectMetaData>Updating a  Object through REST API</extendedObjectMetaData>
       <description>Updating a  Object through REST API</description>
   </object>

</platform> </syntaxhighlight>

Response
<syntaxhighlight lang="xml" enclose="div">

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <platform> 

   <message>
       0
       <description>Success</description>
   </message>

</platform> </syntaxhighlight>

See also: REST API:Error Codes

Delete an Object

Deletes an object and the metadata that defines it.

Method
DELETE
URI
https://{yourDomain}/networking/rest/object/{objectName}
Response
<syntaxhighlight lang="xml" enclose="div">

<platform> 

   <message>
       0
       <description>Success</description>        
   </message>

</platform> </syntaxhighlight>

See also: REST API:Error Codes

Fields

Note: In this object, Boolean fields accept only 1 or 0 (not TRUE/FALSE).

Name Type Attributes Required During Add Description Additional Information
objectName String Editable on Add/Update Checkmark.gif Object name
displayTitle String Editable on Add/Update Checkmark.gif Display title
singluarDisplayTitle String Editable on Add/Update Checkmark.gif Display title - Singular form
canTrackActivities Boolean Editable on Add/Update Checkmark.gif Flag to track activities
canTrackNotes Boolean Editable on Add/Update Checkmark.gif Flag to track notes and attachments
isActive Boolean Editable on Add/Update Checkmark.gif Flag to set object as active/inactive
isEnabledAsATab Boolean Editable on Add/Update Checkmark.gif Flag to enable object as a tab in the UI
custHelpUrl String Editable on Add/Update Checkmark.gif Custom help URL
allowReports Boolean Editable on Add/Update Checkmark.gif Flag to allow reporting on object
allowSearch Boolean Editable on Add/Update Checkmark.gif Flag to allow searching of object
extendedObjectMetaData String Editable on Add/Update Checkmark.gif Object metadata
description String Editable on Add/Update Checkmark.gif Object description
Retrieved from "https://agileappscloud.info/aadev-src/index.php?title=REST_API:object_Resource&oldid=9825"