get_settings_organizations_organizationName_senders_senderName

v1.0.0

The settings of a single of sender

Input

{
  "type": "object",
  "properties": {
    "organizationName": {
      "type": "string"
    },
    "senderName": {
      "type": "string"
    }
  },
  "required": [
    "organizationName",
    "senderName"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "An sender of reports to the data hub",
  "required": [
    "description",
    "format",
    "name",
    "schema",
    "topic"
  ],
  "properties": {
    "description": {
      "type": "string",
      "description": "Display ready description of the sender"
    },
    "format": {
      "type": "string",
      "description": "the payload format",
      "enum": [
        "CSV"
      ]
    },
    "meta": {
      "type": "object",
      "description": "The metadata associated with an setting",
      "properties": {
        "createdAt": {
          "type": "string",
          "format": "time-date",
          "description": "the time that the particular revision was created"
        },
        "createdBy": {
          "type": "string",
          "description": "the user who created the particular revision"
        },
        "version": {
          "type": "number",
          "description": "the version number of the object"
        }
      }
    },
    "name": {
      "type": "string",
      "description": "Unique name for the senders, includes the orgninzation name"
    },
    "organizationName": {
      "type": "string",
      "description": "Name of the organization that this sender belongs to"
    },
    "schema": {
      "type": "string",
      "description": "the schema name for this sender"
    },
    "topic": {
      "type": "string",
      "description": "Topic of for this sender. Must match the supported topics."
    }
  }
}