API IDM Search Item based on the value of Correlation ID

unknown

In a Workflow, I receive a BOD with an IDM CorrelationID and I need to update the Attributes of the IDM Document associated with the CorrelationID.   To do so, I need to find the PID of the IDM document using the CorrelationID.  

I’m trying to make the API “Search for one item by SearchQueries” to retrieve the PID.   

I do not understand the requested arguments and been trying to find the documentation.  Does anyone know where to find the documentation or how to make the search query with the proper values?

The following xquery does work:   /AP_Trade_Invoice[@CorrelationID = "c640b8d9-5797-4f15-b22f-e832fa7773244"]

{
"queries": {
"query": [
{
"entities": "AP_Trade_Invoice",
"useTextSearch": true,
"arguments": {
"argument": [
{
"key": "CorrelationID",
"operator": "sb90",
"value": "c640b8d9-5797-4f15-b22f-e832fa7773244",
"logicalType": "="
}
]
}
}
]
}
}

Brandon Watson

You are pretty close in your query. Change the Operator to "=". It is not erp operator, it is the Operator you want to use for the key and value, instead of using it in logicalType. LogicalType will be the statement join for multiple arguments, IE - OR or AND. Below is an example with multiple arguments, with proper use of logicalType. If you remove the second argument, that query should work for what you are trying to do.

{
:"queries": {
"query": [
{
"entities": "AP_Trade_Invoice",
"useTextSearch": false,
"arguments": {
"argument": [
{
"key": "CorrelationID",
"operator": "=",
"value": "c640b8d9-5797-4f15-b22f-e832fa7773244",
"logicalType": ""
},
{
"key": "MDS_ID",
"operator": "=",
"value": "XXXXXXXX",
"logicalType": "OR"
}
]
}
}
]
}
}

ercustvendname_property.docx