Versions Compared

Old Version 3

changes.mady.by.user Joseph Keenan

Saved on

compared with

New Version 4

changes.mady.by.user Joseph Keenan

Saved on

Key

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

...

#IssueNotesDecision
1



Analysis

...

Below is the implementation proposal for this story.

Interface Proposal

2
#URIDesign NotesComment
1POST /ncmp/v1/data/ch/searches

Sample Request Payload:

Code Block
languageyml
{
  "publicCmHandleProperties" : {
          "Name-1" : "some-value",
          "Name-2" : "other-value"
   }
}


_____________________________________________________________________

Scenario : 
Method : POST
URI : {ncmpRoot}/ncmp/v1/data/ch/searches  
Header :
    Content-Type: application/json


Request Body

Code Block
languageyml
{
  "publicCmHandleProperties" : {           
        "module1": "revision1",
		"module2": "revision2"    }
}


Response Body

Code Block
languageyml
[{
		"cmHandle": "cmHandle001",
		"cmHandleProperties": {
			"module1": "revision1",
			"module2": "revision2"
		}
	},
	{
		"cmHandle": "cmHandle002",
		"cmHandleProperties": {
			"module1": "revision1",
			"module2": "revision2"
		}
	}
]


Future Example (Out-of-scope)
...

POST /ncmp/v1/data/ch/searches

 Code Block
languageyml
{
  "publicCmHandleProperties" : {
     "publicPropertyName-1" : "publicPropertyValue-1",
     "publicPropertyName-2" : "publicPropertyValue-2"
   },
  "modules": [
    {
           "moduleName": "", (Mandatory)
           "revision": "" (Optional)
        }
  ]
}
Modules here is to demonstrate future intentions of endpoint but is out of scope for this user story.

References
...