GetElements

Retrieve Elements in the Asset Framework server with the specified GUID of the elements, depth, and maximum count.

Input Parameter

Item
Description
Request
GET
URL Parameter
  • request
    : JSON.
  • URL Parameter Members
    :
    • AfServerName: String (required). The Asset Framework server name.
    • DatabaseName: String (required). The database name to be queried in the Asset Framework server.
    • ElementsGuid: Array in the string format (required). The GUID of the Elements. GUID is a unique 128-bit data type used for the global identification of objects.
      TIP:
      If the Element GUID is null or empty, the root Elements will be retrieved, and the settings of Depth and MaxCount will not take effect.
    • Depth: INT (optional). Levels of child Element to be retrieved. The default value is one.
    • MaxCount: INT (optional). The maximum number of child Elements to be retrieved based on the given Elements GUID. The default value is one.
Request Header
Authentication
: String (required). Bearer Token string returned from the Login action.
Request Body
None
Status Code
  • 200
    : The request succeeded.
  • 206
    : Partially processed.
  • 401
    : Unauthorized.
  • 403
    : Forbidden.
  • 404
    : Resource not found.
  • 500
    : Internal server error.

Sample

Request Header
"Authorization": "eyJhbGciOiJIUzI1N…"
Request URL Parameter
request={"AfServerName":"YOURAFSERVER","DatabaseName":["YOURDATABASE"],"ElementsGuid":[""]}
Response Body
{
	"Result": [{
		"Name": "Element1",
		"Id": "6d943cca-820c-11ee-b277-000c2981d07e",
		"Path": "\\\\YOURAFSERVER\\YOURDATABASE\\Element1",
		"ParentId": "00000000-0000-0000-0000-000000000000"
	}],
	"Success": true,
	"ErrorMessage": ""
}
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal