Jump to

• Request
• Response

Get query details on a verbatim term from Clinical One

get

/ec-coding-svc/rest/v1.0/studies/{studyId}/{mode}/query/transaction

Retrieves query details using transaction ID from Central Coding.

Request

Query Parameters

• transactionId(required): string
  Query update request with status, revision and discrepancy ID.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object GetByTransactionIdResponseGetByTransactionIdResult

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DetailByTransactionIdResponse"
    }
}

Nested Schema : GetByTransactionIdResponseGetByTransactionIdResult

Type: object

Show Source

• discrepancyRevisionInstanceList: object DiscrepancyRevisionInstanceList

{
    "type":"object",
    "properties":{
        "discrepancyRevisionInstanceList":{
            "$ref":"#/components/schemas/DiscrepancyRevisionInstanceList"
        }
    },
    "xml":{
        "name":"GetByTransactionIdResponseGetByTransactionIdResult",
        "namespace":"http://www.phaseforward.com/InForm/2010/01/Discrepancy"
    }
}

Nested Schema : DiscrepancyRevisionInstanceList

Type: object

Show Source

• discrepancyRevisionInstance(required): array DiscrepancyRevisionInstance

{
    "required":[
        "discrepancyRevisionInstance"
    ],
    "type":"object",
    "properties":{
        "discrepancyRevisionInstance":{
            "type":"array",
            "xml":{
                "name":"DiscrepancyRevisionInstance"
            },
            "items":{
                "$ref":"#/components/schemas/DiscrepancyRevisionInstance"
            }
        }
    }
}

Nested Schema : DiscrepancyRevisionInstance

Type: array

Show Source

• Array of: object DiscrepancyRevisionInstance

{
    "type":"array",
    "xml":{
        "name":"DiscrepancyRevisionInstance"
    },
    "items":{
        "$ref":"#/components/schemas/DiscrepancyRevisionInstance"
    }
}

Nested Schema : DiscrepancyRevisionInstance

Type: object

Show Source

• dateEntered: string (date-time)
• guid(required): string
• reason: string
• reissued: boolean
• revision(required): number (double)
• state: string
  Allowed Values: [ "CANDIDATE", "OPENED", "ANSWERED", "CLOSED", "DELETED", "SPONSOR_CONFLICT", "SITE_CONFLICT" ]
• type: string
  Allowed Values: [ "AUTO", "MANUAL", "UNSPECIFIED" ]
• userName: string

{
    "required":[
        "guid",
        "revision"
    ],
    "type":"object",
    "properties":{
        "guid":{
            "type":"string",
            "xml":{
                "name":"Guid"
            }
        },
        "revision":{
            "type":"number",
            "format":"double",
            "xml":{
                "name":"Revision"
            }
        },
        "state":{
            "type":"string",
            "xml":{
                "name":"State"
            },
            "enum":[
                "CANDIDATE",
                "OPENED",
                "ANSWERED",
                "CLOSED",
                "DELETED",
                "SPONSOR_CONFLICT",
                "SITE_CONFLICT"
            ]
        },
        "type":{
            "type":"string",
            "xml":{
                "name":"Type"
            },
            "enum":[
                "AUTO",
                "MANUAL",
                "UNSPECIFIED"
            ]
        },
        "reissued":{
            "type":"boolean",
            "xml":{
                "name":"Reissued"
            }
        },
        "reason":{
            "type":"string",
            "xml":{
                "name":"Reason"
            }
        },
        "dateEntered":{
            "type":"string",
            "format":"date-time",
            "xml":{
                "name":"DateEntered"
            }
        },
        "userName":{
            "type":"string",
            "xml":{
                "name":"UserName"
            }
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : GetByTransactionIdResponseGetByTransactionIdResult

Type: object

Show Source

• discrepancyRevisionInstanceList: object DiscrepancyRevisionInstanceList

{
    "type":"object",
    "properties":{
        "discrepancyRevisionInstanceList":{
            "$ref":"#/components/schemas/DiscrepancyRevisionInstanceList"
        }
    },
    "xml":{
        "name":"GetByTransactionIdResponseGetByTransactionIdResult",
        "namespace":"http://www.phaseforward.com/InForm/2010/01/Discrepancy"
    }
}

Nested Schema : DiscrepancyRevisionInstanceList

Type: object

Show Source

• discrepancyRevisionInstance(required): array DiscrepancyRevisionInstance

{
    "required":[
        "discrepancyRevisionInstance"
    ],
    "type":"object",
    "properties":{
        "discrepancyRevisionInstance":{
            "type":"array",
            "xml":{
                "name":"DiscrepancyRevisionInstance"
            },
            "items":{
                "$ref":"#/components/schemas/DiscrepancyRevisionInstance"
            }
        }
    }
}

Nested Schema : DiscrepancyRevisionInstance

Type: array

Show Source

• Array of: object DiscrepancyRevisionInstance

{
    "type":"array",
    "xml":{
        "name":"DiscrepancyRevisionInstance"
    },
    "items":{
        "$ref":"#/components/schemas/DiscrepancyRevisionInstance"
    }
}

Nested Schema : DiscrepancyRevisionInstance

Type: object

Show Source

• dateEntered: string (date-time)
• guid(required): string
• reason: string
• reissued: boolean
• revision(required): number (double)
• state: string
  Allowed Values: [ "CANDIDATE", "OPENED", "ANSWERED", "CLOSED", "DELETED", "SPONSOR_CONFLICT", "SITE_CONFLICT" ]
• type: string
  Allowed Values: [ "AUTO", "MANUAL", "UNSPECIFIED" ]
• userName: string

{
    "required":[
        "guid",
        "revision"
    ],
    "type":"object",
    "properties":{
        "guid":{
            "type":"string",
            "xml":{
                "name":"Guid"
            }
        },
        "revision":{
            "type":"number",
            "format":"double",
            "xml":{
                "name":"Revision"
            }
        },
        "state":{
            "type":"string",
            "xml":{
                "name":"State"
            },
            "enum":[
                "CANDIDATE",
                "OPENED",
                "ANSWERED",
                "CLOSED",
                "DELETED",
                "SPONSOR_CONFLICT",
                "SITE_CONFLICT"
            ]
        },
        "type":{
            "type":"string",
            "xml":{
                "name":"Type"
            },
            "enum":[
                "AUTO",
                "MANUAL",
                "UNSPECIFIED"
            ]
        },
        "reissued":{
            "type":"boolean",
            "xml":{
                "name":"Reissued"
            }
        },
        "reason":{
            "type":"string",
            "xml":{
                "name":"Reason"
            }
        },
        "dateEntered":{
            "type":"string",
            "format":"date-time",
            "xml":{
                "name":"DateEntered"
            }
        },
        "userName":{
            "type":"string",
            "xml":{
                "name":"UserName"
            }
        }
    }
}

Back to Top