Only a limited number of object classes in Alfabet can be created or updated via the Alfabet RESTful services. You can create objects of the object classes listed below. Expand the sections for information about the technical object class name to be specified in the call for creation of new objects and for a list of object class properties that you can set for objects of the selected object class.

Specification of values depends on the data type:

  • String: A string written in inverted commas. Size restrictions are noted with the string type in the data type specification of the object class properties.
    • 'Name': 'Alfabet'
  • String - Enum: A string written in inverted commas. Allowed values are restricted by an enumeration. Only values in the enumeration can be specified.
    • 'ObjectState':'Active'
  • Text: A string written in inverted commas.
    • 'Description':'This application provides enterprise architecture management capabilities'
  • Date: The date in the format yyyy-MM-dd in inverted commas.
    • 'StartDate':'2022-10-15'
  • Boolean: The value is 1 for true, 0 for false or null if the property is not set.
    • 'SAG_StrategicApplication': 1

  • Object class: Application

    Make a service call to the endpoint object with the report SAG_RAPI_Application to return the REFSTR values and the settings for the relevant object class properties of existing objects.

    Object class property caption Field name in RESTful service call Mandatory/optional Data type
    Name Name Mandatory String 255
    Short Name ShortName Optional String 16
    Version Version Mandatory String 128
    Description Description Optional Text
    Start Date StartDate Mandatory Date
    End Date EndDate Mandatory Date
    Object State ObjectState Mandatory String - Enum
    Status Status Mandatory String - Enum
    Architecture Type SAG_ArchitectureType Optional String - Enum
    Development Type SAG_DevelopmentType Optional String - Enum
    Authentication SAG_Authentication Optional String - Enum
    Alias SAG_Alias Optional String 512
    Recommendation SAG_Recommendation Optional String - Enum
    Strategic Application SAG_StrategicApplication Optional Boolean
    Pace-Layered Governance SAG_PACEGovernance Optional String - Enum

  • Object class: ApplicationGroup

    Make a service call to the endpoint object with the report SAG_RAPI_ApplicationGroup to return the REFSTR values and the settings for the relevant object class properties of existing objects.

    Object class property caption Field name in RESTful service call Mandatory/optional Data type
    Name Name Mandatory String 255
    Short Name ShortName Optional String 16
    Type Type Optional String - Enum
    Description Description Optional Text

  • Object class: Component

    Make a service call to the endpoint object with the report SAG_RAPI_Component to return the REFSTR values and the settings for the relevant object class properties of existing objects.

    Object class property caption Field name in RESTful service call Mandatory/optional Data type
    Name Name Mandatory String 255
    Short Name ShortName Optional String 16
    Version Version Mandatory String 128
    Description Description Optional Text
    Start Date StartDate Mandatory Date
    End Date EndDate Mandatory Date
    Object State ObjectState Mandatory String - Enum
    Status Status Mandatory String - Enum
    Type SAG_ComponentType Optional String - Enum
    Support Model SAG_SupportModel Optional String - Enum
    Alias SAG_Alias Optional String 512
    Strategic Component SAG_StrategicComponent Optional Boolean

  • Object class: Device

    Make a service call to the endpoint object with the report SAG_RAPI_PhysicalServer to return the REFSTR values and the settings for the relevant object class properties of existing objects.

    Object class property caption Field name in RESTful service call Mandatory/optional Data type
    Name Name Mandatory String 255
    Stereotype Stereotype Mandatory String 64 (required value: PhysicalServer)
    Short Name ShortName Optional String 16
    Version Version Mandatory String 128
    Description Description Optional Text
    Start Date StartDate Mandatory Date
    End Date EndDate Mandatory Date
    Object State ObjectState Mandatory String - Enum
    Status Status Mandatory String - Enum
    Serial Number SerialNumber Optional String 128

  • Object class: Device

    Make a service call to the endpoint object with the report SAG_RAPI_VirtualServer to return the REFSTR values and the settings for the relevant object class properties of existing objects.

    Object class property caption Field name in RESTful service call Mandatory/optional Data type
    Name Name Mandatory String 255
    Stereotype Stereotype Mandatory String 64 (required value: VirtualServer)
    Short Name ShortName Optional String 16
    Version Version Mandatory String 128
    Description Description Optional Text
    Start Date StartDate Mandatory Date
    End Date EndDate Mandatory Date
    Object State ObjectState Mandatory String - Enum
    Status Status Mandatory String - Enum
    Server Type DeviceType Optional String - Enum