Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Current »

Get Project S3 Documents

GET http://localhost:8080/rest/projects3documents/1.0/utility/list/documents

Query Parameters:

  • projectKey (String) or projectId (Number) - (Required)

  • documentId (Number) - Optional

  • search (String) - Optional

Response: [Status: 200]

$ curl -u"user:password" -XGET http://localhost:8080/rest/projects3documents/1.0/utility/list \
/documents/?projectKey=SWTEST

Attach existing Amazon S3 Document

POST http://localhost:8080/rest/projects3documents/1.0/utility/attach/documents

Required Schema Fields:

  • projectKey (String) - Jira Project Key

  • documentKey (String) - AWS S3 Document Path

Response: [Status: 200]

$ curl -u"user:password" -XPOST \
http://localhost:8080/rest/projects3documents/1.0/utility/attach/documents \
-H "Content-Type: application/json" --data "{\"projectKey\":\"SWTEST\",\"documentKey\": \
\"test2/README\"}"
{"status":17,"message":"[Info] Project S3 Document has been attached."}
$

Detach Amazon S3 Document on Jira

DELETE http://localhost:8080/rest/projects3documents/1.0/utility/detach/document

Query Parameters:

  • projectKey (String) or projectId (Number) - (Required)

  • documentId (Number) - Optional

$ curl -u"user:password" -XDELETE \
"http://localhost:8080/rest/projects3documents/1.0/utility/detach/document/?projectKey=SWTEST&documentId=17"
{"status":17,"message":"[Info] S3 Document has been detached."}
$

IAM User Utilities REST API

  • No labels