Skip to main content

 

Planview Customer Success Center

Proposal Service

GET /proposals

Description:

Read proposed changes by entity type or by entity BN.

Query Parameters

  • entityBn: (String) This will search for proposed changes for a specific entity. You must supply either an entityType or entityBn for this request.
  • entityType: (String) This will search for proposed changes for a certain entity type. You must supply either an entityType or entityBn for this request.
  • type: (String) The type parameter filters the focus of your search. The types are either "MINE", or "ALL". The default value is MINE.
  • conflicts: (Boolean) This will return changes that conflict with each other. An example would be two changes that both affect the name field.
  • first: (Integer) The index of an array.
  • count: (Integer) The number of objects to return.

Types

  • MINE: Proposed changes that you are allowed to resolve.
  • ALL: All proposed changes, including changes that you cannot resolve.

Headers:

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

Example:

Request (entityType):

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

Response (entityType) Truncated:

[
  {
    "bn": "041000008B3N",
    "createDate": "2018-09-24T18:19:23.000+0000",
    "lastUpdateDate": "2018-04-18T21:33:27.000+0000",
    "updatedByBn": {
      "bn": "040E0000JH77",
      "firstName": "Registered",
      "lastName": "Cramer",
      "deleted": false
    },
    "relationshipTypeName": "RELATED_TO",
    "conflicted": false,
    "contributedByBn": "040E0000JH77",
    "contributedDate": "2018-04-18T21:33:26.000+0000",
    "controlLevel": "EDITABLE",
    "entityBn": "041800000PBX",
    "entityType": {
      "code": "SYS",
      "name": "System"
    },
    "groupByHash": "A1E871548B6000F2AA69F5B579623FF492087999",
    "processedByBn": null,
    "processedDate": null,
    "propertyChangeType": "ASSOCIATION",
    "propertyFromValue": "044900000CPX",
    "propertyName": "addAssociation",
    "propertyToValue": "041800000PBX",
    "propertyType": "java.lang.String",
    "qualifierValue": null,
    "fieldBn": null,
    "associatedEditStatusId": "2",
    "propertyFromObject": {
      "bn": "044900000CPX",
      "createDate": "2018-04-18T21:33:26.000+0000",
      "lastUpdateDate": "2018-04-18T21:33:26.000+0000",
      "updatedByBn": {
        "bn": "040E0000JH77",
        "firstName": "Registered",
        "lastName": "Cramer",
        "deleted": false
      },
      "dataListItem": {
        "bn": "040M00001WRP",
        "createDate": "2018-04-18T21:32:55.000+0000",
        "lastUpdateDate": "2018-04-18T21:32:55.000+0000",
        "name": "active test, do not use!",
        "order": 2,
        "type": "ACTIVE",
        "updatedByBn": {
          "bn": "040E00009175",
          "firstName": "Tim",
          "lastName": "Cramer",
          "deleted": false
        },
        "displayableName": "active test, do not use!",
        "dataList": {
          "authorizeRoleBn": "00030000000V",
          "bn": "040K00000085",
          "createDate": "2012-10-21T08:32:30.000+0000",
          "description": "System Lifecycle",
          "lastUpdateDate": "2015-11-23T19:09:34.000+0000",
          "name": "Lifecycle State",
          "ordered": true,
          "type": "SYSTEM_LIFECYCLE",
          "updatedByBn": {
            "bn": "040E00009172",
            "firstName": "Patrick",
            "lastName": "Cramer",
            "deleted": false
          },
          "displayableName": "Lifecycle State",
          "new": false
        },
        "new": false
      },
      "startDate": "2018-04-01",
      "endDate": "2018-04-30",
      "entityDiscriminator": "PLL",
      "displayableName": "active test, do not use!",
      "name": "active test, do not use!"
    },
    "propertyOperationType": "ADD",
    "propertyToObject": {
      "acronym": "asdf",
      "bn": "041800000PBX",
      "color": "666666",
      "contentCompletionDate": null,
      "contentStatus": {
        "id": "APPV",
        "displayableName": "Approved",
        "editName": "5) Approved"
      },
      "core": false,
      "createDate": "2016-03-14T02:18:00.000+0000",
      "description": null,
      "details": null,
      "domain": {
        "bn": "040M00001QWT",
        "name": "Default",
        "label": "Domain",
        "description": "System Domain",
        "type": null
      },
      "lastUpdateDate": "2018-04-18T21:04:51.000+0000",
      "aliases": null,
      "lifecycleState": {
        "bn": "040M000000G1",
        "name": "active",
        "label": "Lifecycle State",
        "description": "System Lifecycle",
        "type": "ACTIVE"
      },
      "name": "TCramer test system for lifecycle roadmap",
      "releaseDate": "2017-04-24",
      "sunsetDate": "2018-03-15",
      "systemPriority": {
        "bn": "040M00000032",
        "name": "Low",
        "label": "System Priority",
        "description": "System Priority",
        "type": null
      },
      "systemType": {
        "bn": "040M000002PS",
        "name": "Custom Database",
        "label": "System Type",
        "description": "System Type",
        "type": null
      },
      "systemVersion": null,
      "updatedByBn": {
        "bn": "040E00009175",
        "firstName": "Tim",
        "lastName": "Cramer",
        "deleted": false
      },
      "entityDiscriminator": "SYS",
      "displayableName": "TCramer test system for lifecycle roadmap",
      "new": false
    },
    "proposedChangeDescription": "Update \"044900000CPX\" to \"041800000PBX\"",
    "associatedToSiblingChange": true,
    "associationChange": true,
    "entityChange": false,
    "enumChange": false,
    "newPropertyChange": false,
    "retainExistingPropertyChange": false,
    "securedChange": false,
    "siblingChangeApproved": true,
    "simpleChange": false,
    "ternaryAssociationChange": false,
    "customFieldChange": false
  },

 ...

]

Request (entityBn):

https://[tenant-end-point]/api/c/proposals?entityBn=041800000PBX
Authorization: Basic {your basic auth}
Accept: application/json;charset=UTF-8

Response (entityBn) Truncated:

[
  {
    "bn": "041000008B3N",
    "createDate": "2018-09-24T18:19:23.000+0000",
    "lastUpdateDate": "2018-04-18T21:33:27.000+0000",
    "updatedByBn": {
      "bn": "040E0000JH77",
      "firstName": "Registered",
      "lastName": "Cramer",
      "deleted": false
    },
    "relationshipTypeName": "RELATED_TO",
    "conflicted": false,
    "contributedByBn": "040E0000JH77",
    "contributedDate": "2018-04-18T21:33:26.000+0000",
    "controlLevel": "EDITABLE",
    "entityBn": "041800000PBX",
    "entityType": {
      "code": "SYS",
      "name": "System"
    },
    "groupByHash": "A1E871548B6000F2AA69F5B579623FF492087999",
    "processedByBn": null,
    "processedDate": null,
    "propertyChangeType": "ASSOCIATION",
    "propertyFromValue": "044900000CPX",
    "propertyName": "addAssociation",
    "propertyToValue": "041800000PBX",
    "propertyType": "java.lang.String",
    "qualifierValue": null,
    "fieldBn": null,
    "associatedEditStatusId": "2",
    "propertyFromObject": {
      "bn": "044900000CPX",
      "createDate": "2018-04-18T21:33:26.000+0000",
      "lastUpdateDate": "2018-04-18T21:33:26.000+0000",
      "updatedByBn": {
        "bn": "040E0000JH77",
        "firstName": "Registered",
        "lastName": "Cramer",
        "deleted": false
      },
      "dataListItem": {
        "bn": "040M00001WRP",
        "createDate": "2018-04-18T21:32:55.000+0000",
        "lastUpdateDate": "2018-04-18T21:32:55.000+0000",
        "name": "active test, do not use!",
        "order": 2,
        "type": "ACTIVE",
        "updatedByBn": {
          "bn": "040E00009175",
          "firstName": "Tim",
          "lastName": "Cramer",
          "deleted": false
        },
        "displayableName": "active test, do not use!",
        "dataList": {
          "authorizeRoleBn": "00030000000V",
          "bn": "040K00000085",
          "createDate": "2012-10-21T08:32:30.000+0000",
          "description": "System Lifecycle",
          "lastUpdateDate": "2015-11-23T19:09:34.000+0000",
          "name": "Lifecycle State",
          "ordered": true,
          "type": "SYSTEM_LIFECYCLE",
          "updatedByBn": {
            "bn": "040E00009172",
            "firstName": "Patrick",
            "lastName": "Cramer",
            "deleted": false
          },
          "displayableName": "Lifecycle State",
          "new": false
        },
        "new": false
      },
      "startDate": "2018-04-01",
      "endDate": "2018-04-30",
      "entityDiscriminator": "PLL",
      "displayableName": "active test, do not use!",
      "name": "active test, do not use!"
    },
    "propertyOperationType": "ADD",
    "propertyToObject": {
      "acronym": "asdf",
      "bn": "041800000PBX",
      "color": "666666",
      "contentCompletionDate": null,
      "contentStatus": {
        "id": "APPV",
        "displayableName": "Approved",
        "editName": "5) Approved"
      },
      "core": false,
      "createDate": "2016-03-14T02:18:00.000+0000",
      "description": null,
      "details": null,
      "domain": {
        "bn": "040M00001QWT",
        "name": "Default",
        "label": "Domain",
        "description": "System Domain",
        "type": null
      },
      "lastUpdateDate": "2018-04-18T21:04:51.000+0000",
      "aliases": null,
      "lifecycleState": {
        "bn": "040M000000G1",
        "name": "active",
        "label": "Lifecycle State",
        "description": "System Lifecycle",
        "type": "ACTIVE"
      },
      "name": "TCramer test system for lifecycle roadmap",
      "releaseDate": "2017-04-24",
      "sunsetDate": "2018-03-15",
      "systemPriority": {
        "bn": "040M00000032",
        "name": "Low",
        "label": "System Priority",
        "description": "System Priority",
        "type": null
      },
      "systemType": {
        "bn": "040M000002PS",
        "name": "Custom Database",
        "label": "System Type",
        "description": "System Type",
        "type": null
      },
      "systemVersion": null,
      "updatedByBn": {
        "bn": "040E00009175",
        "firstName": "Tim",
        "lastName": "Cramer",
        "deleted": false
      },
      "entityDiscriminator": "SYS",
      "displayableName": "TCramer test system for lifecycle roadmap",
      "new": false
    },
    "proposedChangeDescription": "Update \"044900000CPX\" to \"041800000PBX\"",
    "associatedToSiblingChange": true,
    "associationChange": true,
    "entityChange": false,
    "enumChange": false,
    "newPropertyChange": false,
    "retainExistingPropertyChange": false,
    "securedChange": false,
    "siblingChangeApproved": true,
    "simpleChange": false,
    "ternaryAssociationChange": false,
    "customFieldChange": false
  },

 ...

]

 

 

POST /proposals

Description:

Resolve a Proposed change. Select a proposed change by its BN, then either "Accept" or "Reject" it.

Body Parameters

  • bn: (String) The barometer number for the Proposed change. You can get the BN for a proposed change by running the Read Proposals request.
  • action: (String) This string will determine if you "Accept" or "Reject" the change. To accept a change, use the value "Approve", and to reject a change, use "Reject".

Headers:

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

Example:

Request:

https://[tenant-end-point]/api/c/proposals
Authorization: Basic {your basic auth}
Accept: application/json;charset=UTF-8
Content-Type: application/json;charset=UTF-8
Body: {
  "bn": "041000008B1V",
  "action": "Reject"
}

Response:

{
    "Approved": false,
    "Rejected": true,
    "Proposed Change": {
        "bn": "041000008B1V",
        "createDate": "2018-04-18T20:46:09.000+0000",
        "lastUpdateDate": "2018-04-18T20:46:09.000+0000",
        "updatedByBn": {
            "bn": "040E0000JH77",
            "firstName": "Registered",
            "lastName": "Cramer",
            "deleted": false
        },
        "relationshipTypeName": null,
        "conflicted": false,
        "contributedByBn": "040E0000JH77",
        "contributedDate": "2018-04-18T20:46:09.000+0000",
        "controlLevel": "EDITABLE",
        "entityBn": "041800000PBX",
        "entityType": {
            "code": "SYS",
            "name": "System"
        },
        "groupByHash": "0C87712EFEA08D77A409B53B1E235D7F730D1E15",
        "processedByBn": "040E00009177",
        "processedDate": "2018-10-01T16:50:24.718+0000",
        "propertyChangeType": "SIMPLE",
        "propertyFromValue": "2018-03-15",
        "propertyName": "sunsetDate",
        "propertyToValue": "2018-03-28",
        "propertyType": "org.joda.time.LocalDate",
        "qualifierValue": null,
        "fieldBn": null,
        "associatedEditStatusId": null,
        "propertyFromObject": null,
        "propertyOperationType": "CHANGE",
        "propertyToObject": null,
        "proposedChangeDescription": "Update \"2018-03-15\" to \"2018-03-28\"",
        "associatedToSiblingChange": false,
        "associationChange": false,
        "entityChange": false,
        "enumChange": false,
        "newPropertyChange": false,
        "retainExistingPropertyChange": false,
        "securedChange": false,
        "siblingChangeApproved": false,
        "simpleChange": true,
        "ternaryAssociationChange": false,
        "customFieldChange": false
    }
}