Versions Compared

Key

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

Table of Contents


Jira Legacy
serverSystem Jira
columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176
keyCPS-731

...

#URIDesign NotesComment(s)
1POST /ncmp/v1/data/ch/searches

Scenario :  Request received to return all cm handles matching properties given
Method   : POST
URI          : {ncmpRoot}/ncmp/v1/data/ch/searches 
Header    : Content-Type: application/json

Request Body

Code Block
languageyml
{
  "publicCmHandleProperties" : {
     "Colour" : "green",
     "Size" : "small"
   }
}


Response Body Example 1

Code Block
languageyml
[
	"cmHandle1",
	"cmHandle2",
	...,
	"cmHandleN"
]



...

#ScenarioScreenshot

cURL Command

REST
1

Both properties match

(CM Handles Returned that Match) (tick)

curl --location --request POST 'http://localhost:8883/ncmp/v1/data/ch/searches' \
--header 'Authorization: Basic Y3BzdXNlcjpjcHNyMGNrcyE=' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=node0p01jwoucppe9e0t2ksksk2ns7.node0' \
--data-raw '{
    "publicCmHandleProperties": {
        "Contact""newemailforstore@bookstore.com"
    }
}'


{
    "publicCmHandleProperties": {
        "Contact""newemailforstore@bookstore.com"
    }
}

2

One property doesn't match 

(Nothing Returned) (tick)

curl --location --request POST 'http://localhost:8883/ncmp/v1/data/ch/searches' \
--header 'Authorization: Basic Y3BzdXNlcjpjcHNyMGNrcyE=' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=node0p01jwoucppe9e0t2ksksk2ns7.node0' \
--data-raw '{
    "publicCmHandleProperties": {
        "Contact""something else"
    }
}'


{
    "publicCmHandleProperties": {
        "Contact""something else"
    }
}

3unknown properties given - NO cm handles returned


{

    "publicCmHandleProperties": {
        "UnknownProperty""doesn't matter"
    }
}

4

InvalidEmpty property name

Return 400

(BAD_REQUEST)

curl --location --request POST 'http://localhost:8883/ncmp/v1/data/ch/searches' \
--header 'Authorization: Basic Y3BzdXNlcjpjcHNyMGNrcyE=' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=node0p01jwoucppe9e0t2ksksk2ns7.node0' \
--data-raw '{
    "publicCmHandleProperties": {
        """"
    }
}'


{
    "publicCmHandleProperties": {
        """doesn't matter "
    }
}

5

No properties given - all cm handles returned

(that contain public properties) (tick)




{
    "publicCmHandleProperties": {
    }
}

6

Return 400

(BAD_REQUEST) (tick)

curl --location --request POST 'http://localhost:8883/ncmp/v1/data/ch/searches' \
--header 'Authorization: Basic Y3BzdXNlcjpjcHNyMGNrcyE=' \
--header 'Content-Type: application/json' \
--header 'Cookie: JSESSIONID=node0p01jwoucppe9e0t2ksksk2ns7.node0' \
--data-raw '{
    "publicCmHandleProperties": [
        "Contact""newemailforstore@bookstore.com"
    ]
}'


{
    "publicCmHandleProperties": [
        "Contact""newemailforstore@bookstore.com"
    ]
}

7


empty value


Future Example (Out-of-scope)

...