INPUT_OBJECT

EwaiAssetUpdateDto

Information to be provided to update an EWAI asset.

link GraphQL Schema definition

  • input EwaiAssetUpdateDto {
  • # The EW-Switchboard role which DER DIDs much possess in order to send messages to
  • # this asset. @example 'datapub.roles.market1.apps.adivate.iam.ewc'
  • dataPublishRole: String
  • # The type of PTD data packets (messages) which are sent into this asset, must be
  • # Json or Text. @example 'json'
  • incomingMsgFormat: IncomingMessageFormat
  • # Not currently implemented.
  • incomingMsgCustomHandler: String
  • # Where in the incoming message the timestamp field is from the DER. For text,
  • # this should be a RegEx to extract the timestamp value, for Json, it should be a
  • # Json Path specification down into the message for the timestamp property.
  • # @example 'sensor1.data.ts' (for Json) or 'time=(.*?);' (for text RegEx
  • # extraction)
  • pathToMsgTimestamp: String
  • # If true, and incoming message format is Json, and a msgSchema has been set, EWAI
  • # will validate incoming PTD messages to ensure they comply with the schema
  • # required before storing them in the asset data table. Schema validation is only
  • # supported for Json incoming message format type assets. @example true
  • schemaValidationOn: Boolean
  • # The Json Schema validation object to be used to validate incoming messages for
  • # this data asset. Messages which do not meet this schema are rejected.
  • msgSchema: JSON
  • # Not currently implemented.
  • customSchemaValidator: String
  • # The output formats supported for the REST API data retrieve call for this
  • # asset's data. @example 'json' | 'csv' | 'xml'
  • outputFormatsSupported: [OutputDataFormat!]
  • # The default output format for the REST API data retrieve call for this asset's
  • # data. @example 'json'
  • defaultOutputFormat: OutputDataFormat
  • # The number of records to send in the preview REST API data retrieve calls for
  • # this asset. @example 10
  • previewNumberOfRecords: Int
  • # The number of days of data to send on asset data REST API data retrieve calls.
  • # The latest "N" days of data is returned. @example 30
  • dataNumberOfDays: Int
  • # The identifier of an external entity to which this EWAI asset is linked in the
  • # EWAI-MARKET (or other dApp/App). This is completely user defined. For
  • # EWAI-MARKET which uses Ocean Protocol to publish EWAI Assets on the marketplace,
  • # this external did is the Ocean Protocol Data Asset DID. @example
  • # 'did:op:D55B682cdf8443f04257aB46461783CA7Ca65EB2'
  • externalDid: String
  • # Json object containing user definable fields. @example
  • # {"tags":["solar","energy","energyweb"],"title":"Solar Farm
  • # 1","vendor":"Sunspec","category":"Solar","description":"This is the description
  • # for solar farm 1"}
  • metadata: JSON
  • }

link Require by