LongJump Support Wiki

Difference between revisions of "REST API:object Resource"

From LongJump Support Wiki
imported>Aeric
m (Text replace - '<tt><nowiki>https://{domain}/networking' to '<tt>{{platformURL}}')
imported>Aeric
 
(3 intermediate revisions by the same user not shown)
Line 5: Line 5:
===Retrieve an Object===
===Retrieve an Object===
Identifies and retrieves metadata for the specified object.
Identifies and retrieves metadata for the specified object.
;Access Permissions:{{Permissions|Customize Objects|manage Objects}}
;Access Permissions:{{permissionRef|Customize Objects|manage Objects}}
;Method:GET
;Method:GET
;URI:<tt>{{platformURL}}/rest/object/{objectName}
;URI:<tt>{{platformURL}}/rest/object/{objectName}</tt>
</nowiki></tt>
;Response:Metadata structure of the Object identified by the [[Object Type Identifier]]
;Response:Metadata structure of the Object identified by the [[Object Type Identifier]]


Line 14: Line 13:
Retrieve all Objects
Retrieve all Objects
;Method:GET
;Method:GET
;URI:<tt>{{platformURL}}/rest/object</nowiki></tt>
;URI:<tt>{{platformURL}}/rest/object</tt>
 
{{Query Parameters|
:*<tt>appId</tt> - Retrieve object metadata for the specified application, only.
::Example: <tt><nowiki>https://yourDomain/rest/object?appId=28473662nkry99az</nowiki></tt>
::To get an application ID:
::# Click '''[My Applications]'''<br>A list of applications is displayed.
::# Launch the application of interest
::# Get the ID from the end of the URL: <tt><nowiki>...&app_id=28473662nkry99az</nowiki></tt>
}}
;Response:Metadata structure of the Object identified by the [[Object Type Identifier]]
;Response:Metadata structure of the Object identified by the [[Object Type Identifier]]


Line 25: Line 33:


;Method:POST
;Method:POST
;URI:<tt>{{platformURL}}/rest/object </nowiki></tt>
;URI:<tt>{{platformURL}}/rest/object </tt>
;Request:
;Request:
:<syntaxhighlight lang="xml" enclose="div">
:<syntaxhighlight lang="xml" enclose="div">
Line 66: Line 74:
;Method:PUT
;Method:PUT


;URI:<tt>{{platformURL}}/rest/object/{objectName}</nowiki></tt>
;URI:<tt>{{platformURL}}/rest/object/{objectName}</tt>


;Request:
;Request:
Line 104: Line 112:
Deletes an object and the metadata that defines it.
Deletes an object and the metadata that defines it.
;Method:DELETE
;Method:DELETE
;URI:<tt>{{platformURL}}/rest/object/{objectName}</nowiki></tt>
;URI:<tt>{{platformURL}}/rest/object/{objectName}</tt>
;Response:
;Response:
:<syntaxhighlight lang="xml" enclose="div">
:<syntaxhighlight lang="xml" enclose="div">

Latest revision as of 02:22, 14 January 2014

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

Warn.png

Warning: Information on this page is Provisional.

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://na.longjump.com/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://na.longjump.com/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. Click [My Applications]
    A list of applications is displayed.
  2. Launch the application of interest
  3. Get the ID from the end of the URL: ...&app_id=28473662nkry99az
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://na.longjump.com/networking/rest/object
Request
<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>
Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<platform>
    <message>
        <code>0</code>
        <description>Success</description>
        <id>34813dcd768740ad91dc4f168023a9cc</id>
    </message>
</platform>
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://na.longjump.com/networking/rest/object/{objectName}
Request
<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>
Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<platform>
    <message>
        <code>0</code>
        <description>Success</description>
    </message>
</platform>
See also: REST API:Error Codes

Delete an Object

Deletes an object and the metadata that defines it.

Method
DELETE
URI
https://na.longjump.com/networking/rest/object/{objectName}
Response
<platform>
    <message>
        <code>0</code>
        <description>Success</description>        
    </message>
</platform>
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/ljwiki-src/index.php?title=REST_API:object_Resource&oldid=6991"