DeviceTriggering

OpenAPI

OpenAPI Version: 3.0.0

info

Title: 3gpp-device-triggering

Version: "1.0.0"

externalDocs

Description: 3GPP TS 29.122 V15.2.0 T8 reference point for Northbound APIs

URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.122/'

security

- {}

- oAuth2ClientCredentials: []

servers

URL: '{apiRoot}/3gpp-device-triggering/v1'

Variables:

API Root:

Default: https://example.com

Description: apiRoot as defined in subclause 5.2.4 of 3GPP TS 29.122.

paths

/{scsAsId}/transactions

get:

Summary: read all active device triggering transactions for a given SCS/AS.

Tags:

- Device Triggering API SCS/AS level GET Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS

Required/Optional: true

Schema:

Reference: 'TS29122_CommonData.yaml#/components/schemas/ScsAsId'

Responses:

'200' OK (Successful get all of the active device triggering transactions for the SCS/AS)

Content:

Application/JSON:

Schema:

Type: array

items:

Reference: '#/components/schemas/DeviceTriggering'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'406': Reference 'TS29122_CommonData.yaml#/components/responses/406'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

Method: Post

Summary: Create a long-term transaction for a device triggering.

Tags:

- DeviceTriggering API Transaction level POST Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS

Required/Optional: true

Schema:

Reference: 'TS29122_CommonData.yaml#/components/schemas/ScsAsId'

Request Body:

Description: Parameters to request a device triggering delivery.

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/DeviceTriggering'

Callbacks:

notificationDestination:

'{request.body#/notificationDestination}':

Method: Post

Request Body: # contents of the callback message

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/DeviceTriggeringDeliveryReportNotification'

Responses:

'200' OK (successful notification)

Content:

Application/JSON:

Schema:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Acknowledgement'

'204' No Content (successful notification)

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

Responses:

'201' Created (Successful creation of subscription)

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/DeviceTriggering'

Headers:

Location:

Description: 'Contains the URI of the newly created resource'

Required/Optional: true

Schema:

Type: string

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

/{scsAsId}/transactions/{transactionId}

get:

Summary: Read a device triggering transaction resource.

Tags:

- DeviceTriggering API Transaction level GET Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS

Required/Optional: true

Schema:

Reference: 'TS29122_CommonData.yaml#/components/schemas/ScsAsId'

- name: transactionId

In: path

Description: Identifier of the transaction resource

Required/Optional: true

Schema:

Type: string

Responses:

'200' OK (Successful get the active subscription)

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/DeviceTriggering'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'406': Reference 'TS29122_CommonData.yaml#/components/responses/406'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

put:

Summary: Replace an existing device triggering transaction resource and the corresponding device trigger request.

Tags:

- DeviceTriggering API transaction level PUT Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS

Required/Optional: true

Schema:

Reference: 'TS29122_CommonData.yaml#/components/schemas/ScsAsId'

- name: transactionId

In: path

Description: Identifier of the transaction resource

Required/Optional: true

Schema:

Type: string

Request Body:

Description: Parameters to update/replace the existing device triggering

Required/Optional: true

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/DeviceTriggering'

Responses:

'200' OK (Successful update of the device triggering)

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/DeviceTriggering'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'

'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'

'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

delete:

Summary: Deletes an already existing device triggering transaction.

Tags:

- DeviceTriggering API Transaction level DELETE Operation

Parameters:

- name: scsAsId

In: path

Description: Identifier of the SCS/AS

Required/Optional: true

Schema:

Reference: 'TS29122_CommonData.yaml#/components/schemas/ScsAsId'

- name: transactionId

In: path

Description: Identifier of the transaction resource

Required/Optional: true

Schema:

Type: string

Responses:

'204' No Content (Successful deletion of the existing subscription)

'200' OK (Successful deletion of the existing subscription)

Content:

Application/JSON:

Schema:

Reference: '#/components/schemas/DeviceTriggering'

'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'

'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'

'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'

'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'

'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'

'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'

'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'

default: Reference 'TS29122_CommonData.yaml#/components/responses/default'

components

securitySchemes

oAuth2ClientCredentials

Type: oauth2

Flows:

clientCredentials:

tokenUrl: '{tokenUrl}'

scopes: {}

schemas

DeviceTriggering

Type: object

Properties:

self:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Link'

externalId:

Reference: 'TS29122_CommonData.yaml#/components/schemas/ExternalId'

msisdn:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Msisdn'

supportedFeatures:

Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'

validityPeriod:

Reference: 'TS29122_CommonData.yaml#/components/schemas/DurationSec'

priority:

Reference: '#/components/schemas/Priority'

applicationPortId:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Port'

triggerPayload:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Bytes'

notificationDestination:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Link'

requestTestNotification:

Type: boolean

Description: Set to true by the SCS/AS to request the SCEF to send a test notification as defined in subclause 5.2.5.3. Set to false or omitted otherwise.

websockNotifConfig:

Reference: 'TS29122_CommonData.yaml#/components/schemas/WebsockNotifConfig'

deliveryResult:

Reference: '#/components/schemas/DeliveryResult'

Required:

  • validityPeriod

  • priority

  • applicationPortId

  • triggerPayload

  • notificationDestination

oneOf:

  • required: [externalId]

  • required: [msisdn]

DeviceTriggeringDeliveryReportNotification

Type: object

Properties:

transaction:

Reference: 'TS29122_CommonData.yaml#/components/schemas/Link'

result:

Reference: '#/components/schemas/DeliveryResult'

Required:

  • transaction

  • result

DeliveryResult

anyOf:type: string

This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.

Possible values are:

  • SUCCESS: This value indicates that the device action request was successfully completed.

  • UNKNOWN: This value indicates any unspecified errors.

  • FAILURE: This value indicates that this trigger encountered a delivery error and is deemed permanently undeliverable.

  • TRIGGERED: This value indicates that device triggering request is accepted by the SCEF.

  • EXPIRED: This value indicates that the validity period expired before the trigger could be delivered.

  • UNCONFIRMED: This value indicates that the delivery of the device action request is not confirmed.

  • REPLACED: This value indicates that the device triggering replacement request is accepted by the SCEF.

  • TERMINATE: This value indicates that the delivery of the device action request is terminated by the SCS/AS.

readOnly: true

Priority

anyOf: type: string

This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.

Possible values are:

  • NO_PRIORITY: This value indicates that the device trigger has no priority.

  • PRIORITY: This value indicates that the device trigger has priority.