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

Compare with Current View Page History

« Previous Version 3 Next »



CPS-731 - Getting issue details... STATUS


Scope


It should be able to query all cmhandles with a given set of public cmhandle properties.

Requirements

  • We want all cm-Handles where both things are true.
  • Those properties also need to exist.
  • If query body does not follow supported structure return 400.
  • Empty query will return all cm-Handles.

A/C:

  1. Demo - with "and" behaviour
  2. CI Test - two attributes


Issues/Decisions


#IssueNotesDecision
1



Analysis



Interface Proposal

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

Sample Request Payload:

{
  "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

{
  "publicCmHandleProperties" : {           
        "module1": "revision1",
		"module2": "revision2"    }
}


Response Body

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

2


Future Example (Out-of-scope)


POST /ncmp/v1/data/ch/searches


{
  "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



  • No labels