Find the metadata of a given message.

GET 
/api/v1/messages/:messageId/metadata

Find the metadata of a given message.

Request

Path Parameters

messageId stringrequired
Identifier of the message.
Example: f532a53545103276b46876c473846d98648ee418468bce76df4868648dd73e5d

Responses

200

Successful operation.

application/json

Schema

Schema

data objectrequired

messageId stringrequired

The identifier of the message.

parentMessageIds string[]required

The identifiers of the messages this message references.

isSolid booleanrequired

Tells if the message could get solidified by the node or not.

referencedByMilestoneIndex integernullable

Tells which milestone references this message. If null the message was not referenced by a milestone yet.

milestoneIndex integer

If set, this message can be considered as a valid milestone message. This field therefore describes the milestone index of the involved milestone. A message can be considered as a valid milestone message if the milestone payload is valid and if the referenced parents in the milestone payload do match the referenced parents in the message itself. Note it's possible to have different milestone messages that all represent the same milestone.

ledgerInclusionState string

Possible values: [included, conflicting, noTransaction]

If included, the message contains a transaction that has been included in the ledger. If conflicitng, the message contains a transaction that has not been included in the ledger because it conflicts with another transaction. If the message does not contain a transaction, ledgerInclusionState is set to noTransaction.

conflictReason integer

Defines the reason why a message is marked as conflicting. Value 1 denotes that the referenced UTXO was already spent. Value 2denotes that the referenced UTXO was already spent while confirming this milestone. Value 3 denotes that the referenced UTXO cannot be found. Value 4 denotes that the sum of the inputs and output values does not match. Value 5 denotes that the unlock block signature is invalid. Value 6 denotes that the input or output type used is unsupported. Value 7 denotes that the used address type is unsupported. Value 8 denotes that the dust allowance for the address is invalid. Value 9 denotes that the semantic validation failed.

shouldPromote boolean

Tells if the message should be promoted to get more likely picked up by the Coordinator.

shouldReattach boolean

Tells if the message should be reattached.

Example (from schema)

{
  "data": {
    "messageId": "string",
    "parentMessageIds": [
      "string"
    ],
    "isSolid": true,
    "referencedByMilestoneIndex": 0,
    "milestoneIndex": 0,
    "ledgerInclusionState": "included",
    "conflictReason": 0,
    "shouldPromote": true,
    "shouldReattach": true
  }
}

New Message

{
  "data": {
    "messageId": "f532a53545103276b46876c473846d98648ee418468bce76df4868648dd73e5d",
    "parentMessageIds": [
      "7ed3d67fc7b619e72e588f51fef2379e43e6e9a856635843b3f29aa3a3f1f006",
      "d97e89e49ed263b763afeda192515fe154ec826ceb92ef08926cd68ec02c9510"
    ],
    "isSolid": false,
    "shouldPromote": true,
    "shouldReattach": false
  }
}

Solid

{
  "data": {
    "messageId": "f532a53545103276b46876c473846d98648ee418468bce76df4868648dd73e5d",
    "parentMessageIds": [
      "7ed3d67fc7b619e72e588f51fef2379e43e6e9a856635843b3f29aa3a3f1f006",
      "d97e89e49ed263b763afeda192515fe154ec826ceb92ef08926cd68ec02c9510"
    ],
    "isSolid": true,
    "shouldPromote": false,
    "shouldReattach": false
  }
}

Included

{
  "data": {
    "messageId": "f532a53545103276b46876c473846d98648ee418468bce76df4868648dd73e5d",
    "parentMessageIds": [
      "7ed3d67fc7b619e72e588f51fef2379e43e6e9a856635843b3f29aa3a3f1f006",
      "d97e89e49ed263b763afeda192515fe154ec826ceb92ef08926cd68ec02c9510"
    ],
    "isSolid": true,
    "referencedByMilestoneIndex": 15465,
    "ledgerInclusionState": "included"
  }
}

Conflicting

{
  "data": {
    "messageId": "f532a53545103276b46876c473846d98648ee418468bce76df4868648dd73e5d",
    "parentMessageIds": [
      "7ed3d67fc7b619e72e588f51fef2379e43e6e9a856635843b3f29aa3a3f1f006",
      "d97e89e49ed263b763afeda192515fe154ec826ceb92ef08926cd68ec02c9510"
    ],
    "isSolid": true,
    "referencedByMilestoneIndex": 15465,
    "ledgerInclusionState": "conflicting",
    "conflictReason": 1
  }
}

400

Unsuccessful operation: indicates that the provided data is invalid.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 400,
    "message": "invalid data provided"
  }
}

403

Unsuccessful operation: indicates that the endpoint is not available for public use.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 403,
    "message": "not available for public use"
  }
}

404

Unsuccessful operation: indicates that the requested data was not found.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 404,
    "message": "could not find data"
  }
}

500

Unsuccessful operation: indicates that an unexpected, internal server error happened which prevented the node from fulfilling the request.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 500,
    "message": "internal server error"
  }
}

503

Unsuccessful operation: indicates that the node is not synced.

application/json

Schema

Schema

error objectrequired

code stringrequired

The application error code.

message stringrequired

The error reason.

Example (from schema)

{
  "error": {
    "code": 503,
    "message": "service unavailable"
  }
}

Loading...