UPLOADENTITYDEFINITIONS()`¶

About UploadEntityDefinitions¶

Asynchronously uploads one or more entity definitions to the user's namespace. The document parameter is required if syncWithPublicNamespace and deleteExistingEntites are false. If the syncWithPublicNamespace parameter is set to true, the user's namespace will synchronize with the latest version of the public namespace. If deprecateExistingEntities is set to true, all entities in the latest version will be deleted before the new DefinitionDocument is uploaded.

When a user uploads entity definitions for the first time, the service creates a new namespace for the user. The new namespace tracks the public namespace. Currently users can have only one namespace. The namespace version increments whenever a user uploads entity definitions that are backwards-incompatible and whenever a user sets the syncWithPublicNamespace parameter or the deprecateExistingEntities parameter to true.

The IDs for all of the entities should be in URN format. Each entity must be in the user's namespace. Users can't create entities in the public namespace, but entity definitions can refer to entities in the public namespace.

Valid entities are Device, DeviceModel, Service, Capability, State, Action, Event, Property, Mapping, Enum.

Method Signature¶

METHODS /AWS1/IF_IOG~UPLOADENTITYDEFINITIONS
  IMPORTING
    !IO_DOCUMENT TYPE REF TO /AWS1/CL_IOGDEFINITIONDOCUMENT OPTIONAL
    !IV_SYNCWITHPUBLICNAMESPACE TYPE /AWS1/IOGSYNCWITHPUBNAMESPACE OPTIONAL
    !IV_DEPRECATEEXISTINGENTITIES TYPE /AWS1/IOGDEPRECATEEXISTINGENTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ioguploadentdefnsrsp
  RAISING
    /AWS1/CX_IOGINTERNALFAILUREEX
    /AWS1/CX_IOGINVALIDREQUESTEX
    /AWS1/CX_IOGTHROTTLINGEX
    /AWS1/CX_IOGCLIENTEXC
    /AWS1/CX_IOGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`io_document` `TYPE REF TO /AWS1/CL_IOGDEFINITIONDOCUMENT` `/AWS1/CL_IOGDEFINITIONDOCUMENT`¶

The DefinitionDocument that defines the updated entities.

`iv_syncwithpublicnamespace` `TYPE /AWS1/IOGSYNCWITHPUBNAMESPACE` `/AWS1/IOGSYNCWITHPUBNAMESPACE`¶

A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to true, the upload will create a new namespace version.

`iv_deprecateexistingentities` `TYPE /AWS1/IOGDEPRECATEEXISTINGENTS` `/AWS1/IOGDEPRECATEEXISTINGENTS`¶

A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new DefinitionDocument. If set to true, the upload will create a new namespace version.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ioguploadentdefnsrsp` `/AWS1/CL_IOGUPLOADENTDEFNSRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->uploadentitydefinitions(
  io_document = new /aws1/cl_iogdefinitiondocument(
    iv_language = |string|
    iv_text = |string|
  )
  iv_deprecateexistingentities = ABAP_TRUE
  iv_syncwithpublicnamespace = ABAP_TRUE
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_uploadid = lo_result->get_uploadid( ).
ENDIF.

/AWS1/IF_IOG=>UPLOADENTITYDEFINITIONS()¶