Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

DescriptionCreate an review

URL

/api/reviews

MethodPOST
Security

Requires User role on the projectauthentication

Examples

  1. Create a review on the violation of id '123':
    • Status: OPEN
    • Assignee: admin
    • Comment: myComment
       

      Code Block
      languagenone
      curl -u admin:admin -d "violation_id=123&status=OPEN&comment=myComment&assignee=admin" -X POST http://localhost:9000/api/reviews

...

DescriptionAdd a comment

URL

/api/reviews/add_comment

MethodPUT
Security

Requires User role on the projectauthentication

Examples

  1. Add the following comment on the review of id '345': 'myComment'

    Code Block
    languagenone
    curl -u admin:admin -d "id=345&comment=myComment" -X PUT http://localhost:9000/api/reviews/add_comment

...

DescriptionReassign a review

URL

/api/reviews/reassign

MethodPUT
Security

Requires User role on the projectauthentication

Examples

  1. Reassign the review of id '345' to user 'admin':

    Code Block
    languagenone
    curl -u admin:admin -d "id=345&assignee=admin" -X PUT http://localhost:9000/api/reviews/reassign

...

DescriptionResolve a review

URL

/api/reviews/resolve

MethodPUT
Security

Requires User role on the projectauthentication

Examples

  1. Resolve a review:
  2. XXX
  3. XXX
  4. XXX
     

    Flag the review of id '345' as false-positive:

    Code Block
    languagenone
    curl -u admin:admin -d "id=345&
    assignee=admin
    resolution=FALSE-POSITIVE&comment=myComment" -X PUT http://localhost:9000/api/reviews/resolve

Parameters

Parameter

Description

Required

Default Value

id

Review id

Yes

None
resolutionCan be 'FIXED' or 'FALSE-POSITIVE'

Yes

None

comment

 

YesNo

None

Reopen a Review

DescriptionReopen a review

URL

/api/reviews/reopen

MethodPUT
Security

Requires User role on the projectauthentication

Examples

  1. Reopen

    a

    the review of id '345':

  2. XXX
  3. XXX
  4. XXX
     

    Code Block
    languagenone
    ??????????????
    curl -u admin:admin -d "id=345&comment=myComment" -X PUT http://localhost:9000/api/reviews/reopen

Parameters

Parameter

Description

Required

Default Value

id

Review id

Yes

None

comment

 

YesNo

None