Sign in
ServiceOrders

Changed on

List service orders of the service<br> Required role: <b>admin</b> or <b>isv</b> or <b>user</b> </br>

get/xpanse/services/{serviceId}/orders

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/xpanse/services/{serviceId}/orders
  • Auth: OAuth 2 (authorization code, authorization URL https://xpanse-demo.eclipseprojects.io/oauth/v2/authorize, token URL https://xpanse-demo.eclipseprojects.io/oauth/v2/token)

Path parameters

serviceIdstring uuid required

Id of the service

Query parameters

taskType'deploy' | 'retry' | 'rollback' | 'modify' | 'destroy' | 'port' | 'recreate' | 'lockChange' | 'configChange' | 'serviceAction' | 'purge' | 'serviceStart' | 'serviceStop' | 'serviceRestart' | 'objectCreate' | 'objectModify' | 'objectDelete'

Task type of the service order.

orderStatus'created' | 'in-progress' | 'successful' | 'failed'

Task status of the service order

Response

OK

orderIdstring uuid required

The id of the service order.

serviceIdstring uuid required

The id of the deployed service.

taskType'deploy' | 'retry' | 'rollback' | 'modify' | 'destroy' | 'port' | 'recreate' | 'lockChange' | 'configChange' | 'serviceAction' | 'purge' | 'serviceStart' | 'serviceStop' | 'serviceRestart' | 'objectCreate' | 'objectModify' | 'objectDelete' required
orderStatus'created' | 'in-progress' | 'successful' | 'failed' required
originalServiceIdstring uuid

The id of the original service.

parentOrderIdstring uuid

The id of the parent service order.

workflowIdstring

The id of the workflow.

userIdstring

The id of the user who created the service order.

startedTimestring date-time required

The started time of the service order.

completedTimestring date-time

The completed time of the service order.

requestBodyobject

The requests of the service order.

resultPropertiesobject

The result properties of the service order.

Changes

  • 10c3487eebbcRevision changes
    • breaking

      removed the enum value service_action from the query request parameter taskType

    • warning

      added the new Invalid Service Deployment State enum value to the response property for the response status

    • warning

      added the new Invalid Service Deployment State enum value to the response property for the response status

    • warning

      added the new Invalid Service Deployment State enum value to the response property for the response status

    • warning

      added the new Invalid Service Deployment State enum value to the response property for the response status

    • warning

      added the new Invalid Service Deployment State enum value to the response property for the response status

    • warning

      added the new Invalid Service Deployment State enum value to the response property for the response status

    • warning

      added the new Invalid Service Deployment State enum value to the response property for the response status

    • warning

      added the new Invalid Service Deployment State enum value to the // response property for the response status

    • warning

      added the new Invalid Service Object Request enum value to the response property for the response status

    • warning

      added the new Invalid Service Object Request enum value to the response property for the response status

    • warning

      added the new Invalid Service Object Request enum value to the response property for the response status

    • warning

      added the new Invalid Service Object Request enum value to the response property for the response status

    • warning

      added the new Invalid Service Object Request enum value to the response property for the response status

    • warning

      added the new Invalid Service Object Request enum value to the response property for the response status

    • warning

      added the new Invalid Service Object Request enum value to the response property for the response status

    • warning

      added the new Invalid Service Object Request enum value to the // response property for the response status

    • warning

      added the new Service Object Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Object Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Object Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Object Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Object Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Object Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Object Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Object Change Order Already Exists enum value to the // response property for the response status

    • warning

      added the new Service Object Not Found enum value to the response property for the response status

    • warning

      added the new Service Object Not Found enum value to the response property for the response status

    • warning

      added the new Service Object Not Found enum value to the response property for the response status

    • warning

      added the new Service Object Not Found enum value to the response property for the response status

    • warning

      added the new Service Object Not Found enum value to the response property for the response status

    • warning

      added the new Service Object Not Found enum value to the response property for the response status

    • warning

      added the new Service Object Not Found enum value to the response property for the response status

    • warning

      added the new Service Object Not Found enum value to the // response property for the response status

    • warning

      added the new objectCreate enum value to the / response property for the response status

    • warning

      added the new objectDelete enum value to the / response property for the response status

    • warning

      added the new objectModify enum value to the / response property for the response status

    • warning

      added the new serviceAction enum value to the / response property for the response status

    • info

      added the new enum value objectCreate to the query request parameter taskType

    • info

      added the new enum value objectDelete to the query request parameter taskType

    • info

      added the new enum value objectModify to the query request parameter taskType

    • info

      added the new enum value serviceAction to the query request parameter taskType

    • info

      removed the service_action enum value from the / response property for the response status

  • 4595066769f9Revision changes
    • warning

      added the new Service Action Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Action Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Action Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Action Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Action Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Action Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Action Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Action Change Order Already Exists enum value to the // response property for the response status

    • warning

      added the new Service Configuration Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Configuration Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Configuration Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Configuration Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Configuration Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Configuration Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Configuration Change Order Already Exists enum value to the response property for the response status

    • warning

      added the new Service Configuration Change Order Already Exists enum value to the // response property for the response status