GMS Service API

This icon identifies all the queries related to data managed on the GMS side. These queries cover service management.

• Service Resources
  • End Event List: List of the end events that your application can receive if a service, state, or task is terminated.
  • Extension: JSON extension for the service API.
  • State Transition Event: Your application can receive this event if a service performs a transition between two states.
  • Service: The service resource, which is a container for nested states and tasks.
  • State: The state resource.
  • Start Event List: List of the start events that your application can receive if a service, state, or task is started.
  • Task: The task resource.

• Maintenance Operations
  • GET /maintenance/services/stream
  • POST /maintenance/services/files
  • POST /maintenance/purge
• Service Operations
  • POST /services/start
  • POST /customers/${customer id}/services/${service id}
  • POST /services/${service id}/end
  • GET /services/${service id}
  • DELETE /services/${service id}
  • GET /services/anonymous/${contact key}/active
  • GET /services/anonymous/${contact key}/completed
  • GET /services/anonymous/${contact key}
  • GET /customers/${customer id}/services/active
  • GET /customers/${customer id}/services/completed
  • GET /customers/${customer id}/services
  • PUT /services/${service id}/extensions/${ext name}
• State Operations
  • POST /services/${service id}/states/${state id}/end
  • POST /services/${service id}/states/transition
  • GET /services/${service id}/states
  • GET /services/${service id}/states/${state id}
  • POST /services/${service id}/states/start
  • PUT /services/${service id}/states/${state id}/extensions/${ext name}
• Task Operations
  • POST /services/${service id}/tasks/${task id}/end
  • GET /services/${service id}/tasks
  • GET /services/${service id}/tasks/${task id}
  • POST /services/${service id}/tasks/start
  • PUT /services/${service id}/tasks/${task id}/extensions/${extension name}

Important

Because extensions are replaced with flexible JSON data on the GMS side, all resources and requests specific to extensions are deprecated for services, states, and tasks.