update_relationship

Partially update a relationship; use clear_description to remove its description.

Input schema

{
  "additionalProperties": false,
  "properties": {
    "application_id": {
      "title": "Application Id",
      "type": "string"
    },
    "clear_description": {
      "default": false,
      "title": "Clear Description",
      "type": "boolean"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Description"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "relationship_id": {
      "title": "Relationship Id",
      "type": "string"
    },
    "settings": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Settings"
    },
    "type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Type"
    }
  },
  "required": [
    "application_id",
    "relationship_id"
  ],
  "title": "update_relationshipArguments",
  "type": "object"
}

Output schema

{
  "properties": {
    "applicationId": {
      "format": "uuid",
      "title": "Applicationid",
      "type": "string"
    },
    "createdAt": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Createdat"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Description"
    },
    "id": {
      "format": "uuid",
      "title": "Id",
      "type": "string"
    },
    "name": {
      "title": "Name",
      "type": "string"
    },
    "settings": {
      "additionalProperties": true,
      "title": "Settings",
      "type": "object"
    },
    "sourceFieldId": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sourcefieldid"
    },
    "sourceModelId": {
      "format": "uuid",
      "title": "Sourcemodelid",
      "type": "string"
    },
    "targetFieldId": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Targetfieldid"
    },
    "targetModelId": {
      "anyOf": [
        {
          "format": "uuid",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Targetmodelid"
    },
    "type": {
      "enum": [
        "one_to_one",
        "one_to_many",
        "many_to_one",
        "many_to_many"
      ],
      "title": "RelationshipType",
      "type": "string"
    },
    "updatedAt": {
      "anyOf": [
        {
          "format": "date-time",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updatedat"
    }
  },
  "required": [
    "id",
    "applicationId",
    "name",
    "type",
    "sourceModelId",
    "settings"
  ],
  "title": "PublicRelationshipResponse",
  "type": "object"
}