action alertersystem_api_transport_octopush_id_get { label: "Retrieves a TransportOctopush resource." description: "Retrieves a TransportOctopush resource." provider: alertersystem method: GET path: "/api/transport-octopush/{id}" encoding: json input: { type: "object" properties: { id: { type: "string" } } required: ["id"] additionalProperties: false } output: { type: "object" description: "The TransportOctopush resource is a collection of transports that carry dispatched alerts to the external Octopush service." required: ["octopushApiKey", "octopushFrom", "octopushType", "octopushUserLogin", "partition", "transportName"] properties: { createdAt: { type: "string" format: "date-time" description: "When the resource instance was created. This date-time is in the UTC timezone." } 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." } octopushApiKey: { type: "string" description: "The API key for the Octopush service. Stored in encrypted format." } octopushFrom: { type: "string" description: "The sender value for the Octopush service." } octopushType: { type: "string" description: "The SMS type ('XXX' = SMS LowCost; 'FR' = SMS Premium; 'WWW' = SMS World) for the Octopush service." } octopushUserLogin: { type: "string" description: "The user login (email) for the Octopush service." } partition: { type: "string" format: "iri-reference" description: "The partition that contains this resource instance. The resource cannot be moved to another partition." } resourceOwner: { type: "string" description: "The name of the person who owns this resource." } transportName: { type: "string" description: "The name of the transport." } } } }