REST API:object Resource
From LongJump Support Wiki
REST API:object Resource
The object resource lets you access and modify object metadata (the data that defines object types).
Warning: Information on this page is Provisional.
Contents |
Retrieve an Object
Identifies and retrieves metadata for the specified object.
- Access Permissions
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:
- Click [My Applications]
A list of applications is displayed. - Launch the application of interest
- Get the ID from the end of the URL: ...&app_id=28473662nkry99az
- Click [My Applications]
- 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
- 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 | ![]() | Object name | |
displayTitle | String | Editable on Add/Update | ![]() | Display title | |
singluarDisplayTitle | String | Editable on Add/Update | ![]() | Display title - Singular form | |
canTrackActivities | Boolean | Editable on Add/Update | ![]() | Flag to track activities | |
canTrackNotes | Boolean | Editable on Add/Update | ![]() | Flag to track notes and attachments | |
isActive | Boolean | Editable on Add/Update | ![]() | Flag to set object as active/inactive | |
isEnabledAsATab | Boolean | Editable on Add/Update | ![]() | Flag to enable object as a tab in the UI | |
custHelpUrl | String | Editable on Add/Update | ![]() | Custom help URL | |
allowReports | Boolean | Editable on Add/Update | ![]() | Flag to allow reporting on object | |
allowSearch | Boolean | Editable on Add/Update | ![]() | Flag to allow searching of object | |
extendedObjectMetaData | String | Editable on Add/Update | ![]() | Object metadata | |
description | String | Editable on Add/Update | ![]() | Object description |