action alertersystem_api_alert_service_id_get {
  label: "Retrieves a AlertService resource."
  description: "Retrieves a AlertService resource."
  provider: alertersystem
  method: GET
  path: "/api/alert-service/{id}"
  encoding: json
  input: {
    type: "object"
    properties: {
      id: {
        type: "string"
      }
    }
    required: ["id"]
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "The AlertService resource is a collection of services that can be used to dispatch an alert. Each alert service uses a distinct message transport."
    required: ["alertServiceName", "alertServiceTransportCode", "partition", "recipientEmailAddress", "recipientPhoneNumber"]
    properties: {
      alertServiceName: {
        type: "string"
        description: "The name of the alert service. Max 255 characters."
      }
      alertServiceNotes: {
        type: "string"
        description: "Notes about the alert service. Max 10,000 characters. Formatting using Markdown is allowed. HTML will be removed."
      }
      alertServiceTransportCode: {
        type: "string"
        format: "iri-reference"
        description: "The transport of the alert service."
      }
      createdAt: {
        type: "string"
        format: "date-time"
        description: "When the resource instance was created. This date-time is in the UTC timezone."
      }
      creditsPerTransportAlert: {
        type: "integer"
        description: "The phone number where alerts will be sent. Ensure that the number format complies with the external transport service that will send the alert."
      }
      dataSegmentCode: {
        type: "string"
        description: "User-provided string on which to segment and filter data. Max 50 characters."
      }
      id: {
        type: "string"
        format: "uuid"
        description: "The unique identifier of the resource instance."
      }
      mediaObjects: {
        type: "array"
        description: "Media objects that must be sent with each alert. Only applicable when you use your own email alert services."
        items: {
          type: "string"
          format: "iri-reference"
        }
      }
      partition: {
        type: "string"
        format: "iri-reference"
        description: "The partition that contains this resource instance. The resource cannot be moved to another partition."
      }
      recipientEmailAddress: {
        type: "string"
        format: "email"
        description: "The email address where alerts will be sent."
      }
      recipientPhoneNumber: {
        type: "string"
        description: "The phone number where alerts will be sent. Ensure that the number format complies with the external transport service that will send the alert."
      }
      resourceOwner: {
        type: "string"
        description: "The name of the person who owns this resource."
      }
      transportAlerta: {
        type: "string"
        format: "iri-reference"
      }
      transportAllMySms: {
        type: "string"
        format: "iri-reference"
      }
      transportAmazonSns: {
        type: "string"
        format: "iri-reference"
      }
      transportBandwidth: {
        type: "string"
        format: "iri-reference"
      }
      transportChatwork: {
        type: "string"
        format: "iri-reference"
      }
      transportClickSend: {
        type: "string"
        format: "iri-reference"
      }
      transportClickatell: {
        type: "string"
        format: "iri-reference"
      }
      transportContactEveryone: {
        type: "string"
        format: "iri-reference"
      }
      transportDiscord: {
        type: "string"
        format: "iri-reference"
      }
      transportEmail: {
        type: "string"
        format: "iri-reference"
      }
      transportEngagespot: {
        type: "string"
        format: "iri-reference"
      }
      transportEsendex: {
        type: "string"
        format: "iri-reference"
      }
      transportExpo: {
        type: "string"
        format: "iri-reference"
      }
      transportFirebase: {
        type: "string"
        format: "iri-reference"
      }
      transportFortySixElks: {
        type: "string"
        format: "iri-reference"
      }
      transportFreeMobile: {
        type: "string"
        format: "iri-reference"
      }
      transportFreshdesk: {
        type: "string"
        format: "iri-reference"
      }
      transportGatewayApi: {
        type: "string"
        format: "iri-reference"
      }
      transportGitter: {
        type: "string"
        format: "iri-reference"
      }
      transportGoogleChat: {
        type: "string"
        format: "iri-reference"
      }
      transportGotify: {
        type: "string"
        format: "iri-reference"
      }
      transportHelpScout: {
        type: "string"
        format: "iri-reference"
      }
      transportInfobip: {
        type: "string"
        format: "iri-reference"
      }
      transportIqsms: {
        type: "string"
        format: "iri-reference"
      }
      transportKazInfoTeh: {
        type: "string"
        format: "iri-reference"
      }
      transportLightSms: {
        type: "string"
        format: "iri-reference"
      }
      transportLineNotify: {
        type: "string"
        format: "iri-reference"
      }
      transportLinkedIn: {
        type: "string"
        format: "iri-reference"
      }
      transportMailjet: {
        type: "string"
        format: "iri-reference"
      }
      transportMastodon: {
        type: "string"
        format: "iri-reference"
      }
      transportMattermost: {
        type: "string"
        format: "iri-reference"
      }
      transportMercure: {
        type: "string"
        format: "iri-reference"
      }
      transportMessageBird: {
        type: "string"
        format: "iri-reference"
      }
      transportMessageMedia: {
        type: "string"
        format: "iri-reference"
      }
      transportMicrosoftTeams: {
        type: "string"
        format: "iri-reference"
      }
      transportMobyt: {
        type: "string"
        format: "iri-reference"
      }
      transportOctopush: {
        type: "string"
        format: "iri-reference"
      }
      transportOneSignal: {
        type: "string"
        format: "iri-reference"
      }
      transportOpsgenie: {
        type: "string"
        format: "iri-reference"
      }
      transportOrangeSms: {
        type: "string"
        format: "iri-reference"
      }
      transportOvhCloud: {
        type: "string"
        format: "iri-reference"
      }
      transportPagerDuty: {
        type: "string"
        format: "iri-reference"
      }
      transportPagerTree: {
        type: "string"
        format: "iri-reference"
      }
      transportPlivo: {
        type: "string"
        format: "iri-reference"
      }
      transportPushbullet: {
        type: "string"
        format: "iri-reference"
      }
      transportPushover: {
        type: "string"
        format: "iri-reference"
      }
      transportPushy: {
        type: "string"
        format: "iri-reference"
      }
      transportRingCentral: {
        type: "string"
        format: "iri-reference"
      }
      transportRocketChat: {
        type: "string"
        format: "iri-reference"
      }
      transportSendberry: {
        type: "string"
        format: "iri-reference"
      }
      transportSendinblue: {
        type: "string"
        format: "iri-reference"
      }
      transportSimpleTextin: {
        type: "string"
        format: "iri-reference"
      }
      transportSinch: {
        type: "string"
        format: "iri-reference"
      }
      transportSlack: {
        type: "string"
        format: "iri-reference"
      }
      transportSms77: {
        type: "string"
        format: "iri-reference"
      }
      transportSmsBiuras: {
        type: "string"
        format: "iri-reference"
      }
      transportSmsFactor: {
        type: "string"
        format: "iri-reference"
      }
      transportSmsapi: {
        type: "string"
        format: "iri-reference"
      }
      transportSmsc: {
        type: "string"
        format: "iri-reference"
      }
      transportSmsmode: {
        type: "string"
        format: "iri-reference"
      }
      transportSpotHit: {
        type: "string"
        format: "iri-reference"
      }
      transportTelegram: {
        type: "string"
        format: "iri-reference"
      }
      transportTelnyx: {
        type: "string"
        format: "iri-reference"
      }
      transportTermii: {
        type: "string"
        format: "iri-reference"
      }
      transportTrello: {
        type: "string"
        format: "iri-reference"
      }
      transportTurboSms: {
        type: "string"
        format: "iri-reference"
      }
      transportTwilio: {
        type: "string"
        format: "iri-reference"
      }
      transportTwitter: {
        type: "string"
        format: "iri-reference"
      }
      transportVonage: {
        type: "string"
        format: "iri-reference"
      }
      transportWebhook: {
        type: "string"
        format: "iri-reference"
      }
      transportYunpian: {
        type: "string"
        format: "iri-reference"
      }
      transportZendesk: {
        type: "string"
        format: "iri-reference"
      }
      transportZulip: {
        type: "string"
        format: "iri-reference"
      }
    }
  }
}