Execute workflow for issue

POST 
/project/issues/:issueID

Execute workflow for issue.

History

Version	Changes
v3.14.117, v3.15.26	Added in: v3.14.117, v3.15.26

Request

Path Parameters

issueID stringrequired

The issue ID

Query Parameters

teamID stringrequired

The team ID

action stringrequired
• action: Actions on issue,support executeWorkflow.

application/json

Body

required

The issue workflow information to update

id stringrequired

Possible values: non-empty and <= 8 characters

The id of the issue workflow.

fieldValues

object[]

The fieldValues of the issue project.

Array [

fieldID stringrequired

Possible values: >= 8 characters

The ID of fieldValue.

type integerrequired

Possible values: >= 1

The type of fieldValue.

value objectrequired

The value of fieldValue.

]

resources

object[]

Attachment ids to be associated, separated by commas.

Array [

id string

]

comment

object[]

The comment of the issue.

Array [

contentType integerrequired

Possible values: >= 1

The contentType of comment.

text stringrequired

The text of comment.

]

timeEstimated

object

The timeEstimated of the issue.

hours integer

timeSpent

object[]

The timeSpent of the issue.

Array [

owner stringrequired

The owner of timeSpent.

startTime integerrequired

The startTime of timeSpent.

hours integerrequired

The hours of timeSpent.

description string

The description of timeSpent.

]

Responses

200

Request is successful.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

errorData object

Error meta data for this request.

Example (from schema)

[
  {
    "result": "SUCCESS"
  },
  {
    "result": "FAIL",
    "errorCode": "NotFound",
    "errorMsg": "NotFound issue"
  },
  {
    "result": "FAIL",
    "errorCode": "NotFound",
    "errorMsg": "NotFound parentissue"
  },
  {
    "result": "FAIL",
    "errorCode": "MissingParameter",
    "errorMsg": "MissingParameter workflow manhour"
  },
  {
    "result": "FAIL",
    "errorCode": "MissingParameter",
    "errorMsg": "MissingParameter workflow attachment"
  },
  {
    "result": "FAIL",
    "errorCode": "MissingParameter",
    "errorMsg": "MissingParameter workflow comment"
  },
  {
    "result": "FAIL",
    "errorCode": "MissingParameter",
    "errorMsg": "MissingParameter workflow relatedwikiPage"
  },
  {
    "result": "FAIL",
    "errorCode": "MissingParameter",
    "errorMsg": "MissingParameter workflow assign"
  },
  {
    "result": "FAIL",
    "errorCode": "MissingParameter",
    "errorMsg": "MissingParameter workflow fieldvalue"
  },
  {
    "result": "FAIL",
    "errorCode": "MissingParameter",
    "errorMsg": "MissingParameter workflow fieldValue"
  }
]

401

Returned if the authentication credentials are incorrect or missing.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Unauthorized",
  "errorMsg": "Access token is invalid"
}

403

Returns if the scope check fails.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Forbidden",
  "errorMsg": "Scope is invalid"
}

404

Returned if the resource object was not found.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "NotFound",
  "errorMsg": "Not Found"
}

500

Internal Server Error.

application/json

Schema

Schema

result string

The result of this request.

errorCode string

The error code of this request.

errorMsg string

Error message for this request.

Example (from schema)

{
  "result": "FAIL",
  "errorCode": "Internal Server Error",
  "errorMsg": "Internal Server Error"
}

Loading...