action unicourt_get_case_related_cases {
  label: "Gets Related Cases for a requested Case ID."
  description: "Retrieve cases that UniCourt has identified as related to the case with the specified caseId value."
  provider: unicourt
  method: GET
  path: "/case/{caseId}/relatedCases"
  encoding: json
  input: {
    type: "object"
    properties: {
      pageNumber: {
        type: "integer"
      }
    }
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["nextPageAPI", "object", "pageNumber", "relatedCaseArray", "totalCount", "totalPages"]
    properties: {
      nextPageAPI: {
        type: "string"
        description: "Link to next page of a particular entity in a Case."
      }
      object: {
        type: "string"
        description: "Name of the object"
      }
      pageNumber: {
        type: "integer"
        description: "Page number for which results where obtained."
      }
      relatedCaseArray: {
        type: "array"
        items: {
          type: "object"
          required: ["object", "caseId", "caseNumber", "caseName", "caseRelationshipType", "sourceCaseRelationshipType", "isVisible", "additionalSourceData", "caseAPI"]
          properties: {
            additionalSourceData: {
              type: "object"
              required: ["rawOrderedDataArray", "extractedFields"]
              properties: {
                extractedFields: {
                  type: "object"
                  properties: {
                    key: {
                      type: "string"
                      description: "This can be an field that is extracted from rawOrderedDataArray on request of different users."
                    }
                  }
                }
                rawOrderedDataArray: {
                  type: "array"
                  items: {
                    type: "object"
                    required: ["ord", "lbl", "val", "childArray"]
                    properties: {
                      childArray: {
                        type: "array"
                        description: "Any docket text that belongs to the main docket text is added in the child."
                        items: {
                          type: "object"
                          required: ["ord", "lbl", "val", "childArray"]
                          properties: {
                            childArray: {
                              type: "object"
                              additionalProperties: true
                            }
                            lbl: {
                              type: "object"
                              additionalProperties: true
                            }
                            ord: {
                              type: "object"
                              additionalProperties: true
                            }
                            val: {
                              type: "object"
                              additionalProperties: true
                            }
                          }
                        }
                      }
                      lbl: {
                        type: "string"
                        description: "Label of the docket from the source."
                      }
                      ord: {
                        type: "integer"
                        description: "Structure order"
                      }
                      val: {
                        type: "string"
                        description: "List of available addresses."
                      }
                    }
                  }
                }
              }
            }
            caseAPI: {
              type: "string"
              description: "Link to the Case API of the current related case."
            }
            caseId: {
              type: "string"
              description: "Case ID of the related Case. This can be null if this case in not found in our database. However the meta information of the related case will be present."
            }
            caseName: {
              type: "string"
              description: "Case Name of the related Case."
            }
            caseNumber: {
              type: "string"
              description: "Case Number of the related Case."
            }
            caseRelationshipType: {
              type: "object"
              required: ["object", "caseRelationshipTypeId", "name", "createdDate"]
              properties: {
                caseRelationshipTypeId: {
                  type: "string"
                }
                createdDate: {
                  type: "string"
                  format: "date-time"
                  description: "The date and time when it was first created. This date and time is in UTC. Formatted as YYYY-MM-DD HH:MM:SS."
                }
                name: {
                  type: "string"
                }
                object: {
                  type: "string"
                }
              }
            }
            isVisible: {
              type: "boolean"
              description: "This specifies if the related cases is still related to the parent case or not."
            }
            object: {
              type: "string"
              description: "Name of the object"
            }
            sourceCaseRelationshipType: {
              type: "string"
              description: "Case Relationship Type provided by court."
            }
          }
        }
      }
      totalCount: {
        type: "integer"
        description: "Total number of parties of the Case entity in a Case."
      }
      totalPages: {
        type: "integer"
        description: "Total number of pages to obtain all the objects of a party in the Case."
      }
    }
  }
}