Jump to

• Request
• Response

Read Relationship

get

/relationship

Reads Relationship objects from the database.

Request

Query Parameters

• Fields(required): string
  Fields to load

  Example:

  Name,ObjectId

• Filter(required): string
  Supported Filter Operators - :gt:, :lt:, :eq:, :gte:, :lte:, :and:, :or:

  Example:

  ObjectId IN(1,2) :and: CreateDate:gte:'2021-04-20' :and: LastUpdateDate:lt:'2022-04-20' :and: Name :like: 'abc%'

• LagProjectId(required): string
  LagProjectId should be passed while trying to load Driving field

  Example:

  1234

• OrderBy(required): string
  OrderBy condition

  Example:

  ObjectId desc

Header Parameters

• Authorization(required):
  OAuth token

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : List<Relationship>

Type: array

Title: List<Relationship>

Show Source

• Array of: object Relationship
  Title: Relationship

  Relationship Entity

{
    "title":"List<Relationship>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Relationship"
    }
}

Nested Schema : Relationship

Type: object

Title: Relationship

Relationship Entity

Show Source

• Aref: string (date-time)
  The Adjusted Relationship Early Finish where one of the activities of the relationship is in a project which is not present in this database.
• Arls: string (date-time)
  The Adjusted Relationship Late Start where one of the activities of the relationship is in a project which is not present in this database.
• Comments: string
• CreateDate: string (date-time)
  The date this dependency was created.
• CreateUser: string
  The name of the user that created this dependency.
• Driving: boolean
• IsPredecessorBaseline: boolean
  The YesNo value indicating if the predecessor activity is related to a Project or Baseline
• IsPredecessorTemplate: boolean
  The boolean value indicating if this business object is related to a template Project.
• IsSuccessorBaseline: boolean
  The YesNo value indicating if the successor activity is related to a Project or Baseline
• IsSuccessorTemplate: boolean
  The boolean value indicating if this business object is related to a template Project.
• Lag: number (double)
  The time lag of the relationship. This is the time lag between the predecessor activity's start or finish date and the successor activity's start or finish date, depending on the relationship type. The time lag is based on the successor activity's calendar. This value is specified by the project manager and is used by the project scheduler when scheduling activities.
• LastUpdateDate: string (date-time)
  The date this dependency was last updated.
• LastUpdateUser: string
  The name of the user that last updated this dependency.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• PredecessorActivityId: string
  The activity ID of the predecessor activity.
• PredecessorActivityName: string
  The name of the predecessor activity.
• PredecessorActivityObjectId(required): integer (int32)
  The unique ID of the predecessor activity.
• PredecessorActivityType: string
  The type of the predecessor activity, either 'Task Dependent', 'Resource Dependent', 'Level of Effort', or 'Milestone'.
• PredecessorFinishDate: string (date-time)
  The finish date of the predecessor activity.
• PredecessorProjectId: string
  The project ID of the project that owns the predecessor activity.
• PredecessorProjectObjectId: integer (int32)
  The unique ID of the project that owns the predecessor activity.
• PredecessorStartDate: string (date-time)
  The start date of the predecessor activity.
• PredecessorWbsName: string
  The name of each WBS element in the predecessor activity.
• SuccessorActivityId: string
  The activity ID of the successor activity.
• SuccessorActivityName: string
  The name of the successor activity.
• SuccessorActivityObjectId(required): integer (int32)
  The unique ID of the successor activity.
• SuccessorActivityType: string
  The type of the successor activity, either 'Task Dependent', 'Resource Dependent', 'Level of Effort', or 'Milestone'.
• SuccessorFinishDate: string (date-time)
  The finish date of the successor activity.
• SuccessorProjectId: string
  The project ID of the project that owns the successor activity.
• SuccessorProjectObjectId: integer (int32)
  The unique ID of the project that owns the successor activity.
• SuccessorStartDate: string (date-time)
  The start date of the successor activity.
• SuccessorWbsName: string
  The name of each WBS element in the successor activity.
• Type: string
  The type of relationship: 'Finish to Start', 'Finish to Finish', 'Start to Start', or 'Start to Finish'.

{
    "title":"Relationship",
    "required":[
        "PredecessorActivityObjectId",
        "SuccessorActivityObjectId"
    ],
    "type":"object",
    "properties":{
        "Aref":{
            "type":"string",
            "description":"The Adjusted Relationship Early Finish where one of the activities of the relationship is in a project which is not present in this database.",
            "format":"date-time"
        },
        "Arls":{
            "type":"string",
            "description":"The Adjusted Relationship Late Start where one of the activities of the relationship is in a project which is not present in this database.",
            "format":"date-time"
        },
        "Comments":{
            "type":"string"
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this dependency was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this dependency."
        },
        "Driving":{
            "type":"boolean"
        },
        "IsPredecessorBaseline":{
            "type":"boolean",
            "description":"The YesNo value indicating if the predecessor activity is related to a Project or Baseline"
        },
        "IsPredecessorTemplate":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a template Project."
        },
        "IsSuccessorBaseline":{
            "type":"boolean",
            "description":"The YesNo value indicating if the successor activity is related to a Project or Baseline"
        },
        "IsSuccessorTemplate":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a template Project."
        },
        "Lag":{
            "type":"number",
            "description":"The time lag of the relationship. This is the time lag between the predecessor activity's start or finish date and the successor activity's start or finish date, depending on the relationship type. The time lag is based on the successor activity's calendar. This value is specified by the project manager and is used by the project scheduler when scheduling activities.",
            "format":"double"
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this dependency was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this dependency."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "PredecessorActivityId":{
            "type":"string",
            "description":"The activity ID of the predecessor activity."
        },
        "PredecessorActivityName":{
            "type":"string",
            "description":"The name of the predecessor activity."
        },
        "PredecessorActivityObjectId":{
            "type":"integer",
            "description":"The unique ID of the predecessor activity.",
            "format":"int32"
        },
        "PredecessorActivityType":{
            "type":"string",
            "description":"The type of the predecessor activity, either 'Task Dependent', 'Resource Dependent', 'Level of Effort', or 'Milestone'."
        },
        "PredecessorFinishDate":{
            "type":"string",
            "description":"The finish date of the predecessor activity.",
            "format":"date-time"
        },
        "PredecessorProjectId":{
            "type":"string",
            "description":"The project ID of the project that owns the predecessor activity."
        },
        "PredecessorProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the project that owns the predecessor activity.",
            "format":"int32"
        },
        "PredecessorStartDate":{
            "type":"string",
            "description":"The start date of the predecessor activity.",
            "format":"date-time"
        },
        "PredecessorWbsName":{
            "type":"string",
            "description":"The name of each WBS element in the predecessor activity."
        },
        "SuccessorActivityId":{
            "type":"string",
            "description":"The activity ID of the successor activity."
        },
        "SuccessorActivityName":{
            "type":"string",
            "description":"The name of the successor activity."
        },
        "SuccessorActivityObjectId":{
            "type":"integer",
            "description":"The unique ID of the successor activity.",
            "format":"int32"
        },
        "SuccessorActivityType":{
            "type":"string",
            "description":"The type of the successor activity, either 'Task Dependent', 'Resource Dependent', 'Level of Effort', or 'Milestone'."
        },
        "SuccessorFinishDate":{
            "type":"string",
            "description":"The finish date of the successor activity.",
            "format":"date-time"
        },
        "SuccessorProjectId":{
            "type":"string",
            "description":"The project ID of the project that owns the successor activity."
        },
        "SuccessorProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the project that owns the successor activity.",
            "format":"int32"
        },
        "SuccessorStartDate":{
            "type":"string",
            "description":"The start date of the successor activity.",
            "format":"date-time"
        },
        "SuccessorWbsName":{
            "type":"string",
            "description":"The name of each WBS element in the successor activity."
        },
        "Type":{
            "type":"string",
            "description":"The type of relationship: 'Finish to Start', 'Finish to Finish', 'Start to Start', or 'Start to Finish'."
        }
    },
    "description":"Relationship Entity"
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top