Export data about objects

The endpoint objects returns information about objects in the Alfabet database. In the service call, a preconfigured tabular report must be specified which returns data about a number of objects.

You can return different sets of information via the endpoint:

• The response returns the data that is included in the report. This method is recommended because the report returns information in a readable way. For example, if an object references another object, the REFSTR value of the referenced object is stored in the database table, but the report will provide the name of the object as displayed in the user interface.
• The response returns information about all property values for all objects found in the report independent of the data defined in the dataset of the report.
• The response returns all REFSTR values of all objects found in the report. This kind of response is useful if the REFSTR values of a defined group of objects are required as input (for example, for external applications that shall provide links that open the Alfabet user interface).

Endpoint name: objects

HTTP method: POST

Service call: URLOfTheAlfabetAPIServer/api/v2/objects

Authorization Header: Authorization:TypeValue

Click for details about authorization.

Additional Header Fields: Content-Type: application/json; charset=utf-8

Body: The body is a JSON object with the following structure:

• {
• "CurrentProfile":"Portfolio Admin",
• "Language": 1033,
• "DataCulture": "fr-FR",
• "ApiCulture": "APICultureReporting",
• "EmptyValues": true,
• "Report": "Report_1",
• "ReportResult": "DataSet",
• "Limit": 500,
• "Offset": 250
• }

Return value

The return value depends on the setting of the ReportResult field of the call.

• Return value for ReportResult = References

  The call returns a JSON object with the following fields.

  • Refs: A JSON array containing the REFSTR values of the base objects in the report. The array can contain a REFSTR value multiple times if the base object of multiple rows is identical.
  • Count: The number of REFSTR values in the Refs field.
  • Name: The name of the report which has been executed.
  • Description: The description of the report which has been executed if a description is available in the report configuration.
• Return value for ReportResult=Objects

  The call returns a JSON object with the following fields.

  • Objects A list with one JSON object for each base object found in the executed report. The JSON object contains the following fields:
    • ClassName: The name of the Alfabet object class that the object belongs to.
    • RefStr: The value of the REFSTR of the object.
    • Values: A JSON object that includes all information defined about the object in the database via object class properties. Each property is a field with a name corresponding to the property name. The value of the field provides information about the value of the property. The return value for a property depends on the value type of the property:

      Property Type	Return value
      String, Text	The string, text is returned as string (in inverted commas): "description":"This application manages customer relations."
      StringArray	All selected options of the string array are returned in one string: "subcategories": "APP_SecurityAssessment APP_CloseSubworkflow"
      Boolean	Boolean values are 1 for true, 0 for false, or null if the property is not set: "variant": 1
      Real, Integer	Real and integer values are returned as a number: "xpos": 485.4
      Date, DateTime	Date and date time information are returned as date strings of the format yyyy-mm-dd: "last_update": "2012-02-21"
      URL	URLs are returned as a string (in inverted commas): "url": "http://company.com/ReportServer"
      Reference	The REFSTR of the object that the reference targets is returned: "ictobject": "26-608-0"
      ReferenceArray	For reference arrays, the REFSTRs of all objects that the current object references with this property are listed in an array: "applicationgroups": [3] 0: "95-38-0" 1: "95-8-0" 2: "95-9-0"

    • GenericAttributes: If attributes are defined for the object via the object class GenericAttribute , all generic attributes with the object class property Owner set to the current object are listed in this field as a JSON list of objects. Each object in the list returns one object of the class GenericAttribute , with the fields Refstr , Values and Translations that return data about the generic attribute in the same format as returned for the main object.
  • Count: The number of rows returned by the report.
  • Name: The name of the report which has been executed.
  • Description: The description of the report which has been executed if a description is available in the report configuration.
• Return value for ReportResult = DataSet
  • Objects: A JSON list of objects with one JSON object per row in the dataset of the configured report. The object contains the following fields:
    • ClassName: The name of the Alfabet object class that the base object of the current row belongs to.
    • RefStr: The value of the REFSTR of the base object of the current row.
    • Values: A JSON object that includes all information defined in the cells of the current row of the configured report. Each column in the dataset is a field with a name corresponding to the column name. The value of the field provides information about the value in the current row. All values are returned as strings.
    • NestedObjects: This field is currently not used.
  • Count: The number of rows returned by the report.
  • Name: The name of the report that has been executed.
  • Description: The description of the report that has been executed if a description is available in the report configuration.