Transfer comment ownership between users

PUT /task/v1/comments/transfer

Operation id: transferOwnerComments

Description

Transfers all comment records for a cluster from one user to another. Updates both assignUser and userId fields in all matching records.

Before executing the transfer, the following validations are applied:

  1. new_owner_id and old_owner_id are verified as real users via the RTM Kernel (E167 / E169).
  2. At least one comment must exist for old_owner_id in the cluster, checked across both assignUser and userId fields (E168 if none found).

Requires ROS_UNIT_DOMAIN line-of-sight authorization.

Tags: MyWorkComments

Security

  • ApiKeyHeader (apiKey)
    • APIGEE API key header validated by VerifyAPIKey policy.
  • AuthTokenHeader (apiKey)
    • Session authentication token validated server-side against the user session store.

Responses

200 — Success — {status: OK, message: "Comments transferred successfully."}.

Also returned with status: ER for: E168 (no comments found for the specified cluster_id and old_owner_id).

Content type: application/json

400 — E108 cluster_id mandatory | E123 new_owner_id mandatory | E124 old_owner_id mandatory | E167 new_owner_id is not a valid user | E169 old_owner_id is not a valid user

Content type: application/json

401 — Invalid or expired X-reflexis-csrf-token-X token (HTTP 401)

Content type: application/json

500 — Unexpected server-side error

Content type: application/json

Request body

Required: Yes

application/x-www-form-urlencoded

Schema

PropertyTypeRequiredDescription
cluster_idstringYesProject cluster ID whose comments are being transferred — mandatory (E108)
new_owner_idstringYesUser ID of the new comment owner — mandatory (E123), must be a valid RTM user (E167)
old_owner_idstringYesUser ID of the current/old comment owner — mandatory (E124), must be a valid RTM user (E169)
{
  "type": "object",
  "required": [
    "cluster_id",
    "new_owner_id",
    "old_owner_id"
  ],
  "properties": {
    "cluster_id": {
      "type": "string",
      "description": "Project cluster ID whose comments are being transferred — mandatory (E108)"
    },
    "new_owner_id": {
      "type": "string",
      "description": "User ID of the new comment owner — mandatory (E123), must be a valid RTM user (E167)"
    },
    "old_owner_id": {
      "type": "string",
      "description": "User ID of the current/old comment owner — mandatory (E124), must be a valid RTM user (E169)"
    }
  }
}

Response models

200 — Success — {status: OK, message: "Comments transferred successfully."}.

Also returned with status: ER for: E168 (no comments found for the specified cluster_id and old_owner_id).

Content type: application/json

Schema

JSON object (structure varies by endpoint).

{
  "type": "object",
  "description": "JSON object (structure varies by endpoint)."
}

400 — E108 cluster_id mandatory | E123 new_owner_id mandatory | E124 old_owner_id mandatory | E167 new_owner_id is not a valid user | E169 old_owner_id is not a valid user

Content type: application/json

Schema

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E204, E112, E302)
responsestringYesHuman-readable error message
{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E204",
    "response": "Invalid or expired token"
  },
  "required": [
    "status",
    "errorCode",
    "response"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Always \"ER\" for error responses",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Application-level error code (e.g. E204, E112, E302)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

401 — Invalid or expired X-reflexis-csrf-token-X token (HTTP 401)

Content type: application/json

Schema

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E204, E112, E302)
responsestringYesHuman-readable error message
{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E204",
    "response": "Invalid or expired token"
  },
  "required": [
    "status",
    "errorCode",
    "response"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Always \"ER\" for error responses",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Application-level error code (e.g. E204, E112, E302)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E204",
  "response": "Invalid or expired token"
}

500 — Unexpected server-side error

Content type: application/json

Schema

PropertyTypeRequiredDescription
statusstringYesAlways "ER" for error responses
errorCodestringYesApplication-level error code (e.g. E204, E112, E302)
responsestringYesHuman-readable error message
{
  "type": "object",
  "example": {
    "status": "ER",
    "errorCode": "E204",
    "response": "Invalid or expired token"
  },
  "required": [
    "status",
    "errorCode",
    "response"
  ],
  "properties": {
    "status": {
      "type": "string",
      "description": "Always \"ER\" for error responses",
      "enum": [
        "ER"
      ]
    },
    "errorCode": {
      "type": "string",
      "description": "Application-level error code (e.g. E204, E112, E302)"
    },
    "response": {
      "type": "string",
      "description": "Human-readable error message"
    }
  }
}

Example:

{
  "status": "ER",
  "errorCode": "E302",
  "response": "Internal server error"
}