Skip to main content

 

Planview Customer Success Center

Association Service

POST /association

Description:

Update the associations on a source entity.

Parameters (body)

  • relationshipType: (String) This defines a the relationship between two entities. This property is only required for relationships to a "Person" entity.
  • addedAssocs: (JSON) An array of relationships that will be added. The relationship objects contain a targetBn, a relationshipIdentifier, and a relationshipType. The targetBn is the toBn, and the relationshipIdentifier is a qualifier BN. 
  • removedAssocs: (JSON) An array of relationships that will be removed. The relationship objects contain a targetBn, a relationshipIdentifier, and a relationshipType. The targetBn is the toBn, and the relationshipIdentifier is a qualifier BN. 
  • indexBn: (String)  The indexBn is the toBn.
  • sourceBn: (String) The sourceBn is the fromBn.

Headers:

  • Authorization: (Your Basic Auth String)
  • Accept: application/plain;charset=UTF-8
  • Content-Type: application/json;charset=UTF-8

Example:

Request:

https://[tenant-end-point]/api/c/association
Authorization: Basic {your basic auth}
Accept: application/json;charset=UTF-8
Content-Type: application/json;charset=UTF-8

body: {
  "addedAssocs": [{"targetBn":"041800000MMM","relationshipIdentifier":"040M000007ZR", "relationshipType": "RELATED_TO"}],
  "relationshipType": null,
  "indexBn": "041800000MMM",
  "removedAssocs": [],
  "sourceBn": "04390000063J"
}

Response:

{
  "successfulBns": [
    "041800000MMM"
  ],
  "proposedChangeBns": [],
  "transactionIds": [
    "2d5506cf4a4a42e1892e1f31237ba5c2"
  ]
}

 

 

GET /association

Description:

Read many associated entities by entity type.

Parameters

  • relationshipType: (String) This defines a the relationship between two entities. This property is only required for relationships to a "Person" entity.
  • sourceBn: (String) The sourceBn is the fromBn.
  • targetEntityType: (String) The targetEntityType is the toType.
  • first: (Integer) The index of an array
  • count: (Integer) The number of objects to return

Headers:

  • Authorization: (Your Basic Auth String)
  • Accept: application/plain;charset=UTF-8

Example:

Request:

https://[tenant-end-point]/api/c/association?sourceBn=044L00000044&targetEntityType=PER&relationshipType=HAS_CONTACT
Authorization: Basic {your basic auth}
Accept: application/json;charset=UTF-8

Response:

{
  "columnSpec": null,
  "filterParams": null,
  "filterSpec": null,
  "pivotCount": 0,
  "rowCount": 1,
  "unfilteredRowCount": 1,
  "rows": [
    {
      "thumb": "040E000004LM",
      "entity": {
        "bn": "040E000004LM",
        "name": "Integration Administrator"
      },
      "personOrganizations": [],
      "personPositions": []
    }
  ]
}

 

 

GET /association/{sourceBn}

Description:

Read one associated entity by BN.

Parameters

  • sourceBn: (String) The sourceBn is the fromBn.
  • targetBn: (String) The targetBn is the toBn.

Headers:

  • Authorization: (Your Basic Auth String)
  • Accept: application/plain;charset=UTF-8

Example:

Request:

https://[tenant-end-point]/api/c/association/044L00000044?targetBn=ZZ3900000000
Authorization: Basic {your basic auth}
Accept: application/json;charset=UTF-8

Response:

{
  "columnSpec": null,
  "rows": [
    {
      "entity": {
        "name": "Getting Started Deployment",
        "bn": "044L00000044",
        "color": "666666"
      },
      "040M000002HS": true,
      "040M000002HX": false,
      "040M000002J2": false,
      "040M000002J6": false,
      "children": []
    }
  ]
}

 

 

GET /associationDetails

Description:

Read the relationship qualifiers and other assocition data based on entity types.

Parameters

  • sourceEntityType: (String) The entity type of the origin entity.
  • targetEntityType: (String) The entity type of the target entity.

Headers:

  • Authorization: (Your Basic Auth String)
  • Accept: application/plain;charset=UTF-8

Example:

Request:

https://[tenant-end-point]/api/c/associationDetails?sourceEntityType=SYS&targetEntityType=ORG
Authorization: Basic {your basic auth}
Accept: application/json;charset=UTF-8

Response:

[
  {
    "fromType": "SYS",
    "toType": "ORG",
    "relationshipType": {
      "name": "Owns",
      "type": "OWNS"
    },
    "qualifiers": [
      {
        "bn": "040M0000025K",
        "name": "Owns"
      }
    ]
  },
  {
    "fromType": "SYS",
    "toType": "ORG",
    "relationshipType": {
      "name": "Supports",
      "type": "SUPPORTS"
    },
    "qualifiers": [
      {
        "bn": "040M0000025L",
        "name": "Supports"
      }
    ]
  },
  {
    "fromType": "SYS",
    "toType": "ORG",
    "relationshipType": {
      "name": "Uses",
      "type": "USES"
    },
    "qualifiers": [
      {
        "bn": "040M0000025M",
        "name": "Uses"
      }
    ]
  }
]