Jump to

• Request
• Response

Batch Update Resource Demands

put

/api/restapi/resourceDemand/batch

Send a request to this endpoint to update one or more resource demands.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityResourceDemandInput>

Type: array

Title: List<ApiEntityResourceDemandInput>

Show Source

• Array of: object ApiEntityResourceDemandInput
  Title: ApiEntityResourceDemandInput

  This entity represents a ResourceDemand object, a unique ResourceDemand object can be identified by the following combinations of the fields.

  • resourceDemandId
  • projectId,resourceId
  • resourceId,projectCode,workspaceCode
  • projectId,resourceCode,resourceClass,workspaceCode
  • projectCode,resourceCode,resourceClass,workspaceCode

{
    "title":"List<ApiEntityResourceDemandInput>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityResourceDemandInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityResourceDemandInput

Type: object

Title: ApiEntityResourceDemandInput

This entity represents a ResourceDemand object, a unique ResourceDemand object can be identified by the following combinations of the fields.

• resourceDemandId
• projectId,resourceId
• resourceId,projectCode,workspaceCode
• projectId,resourceCode,resourceClass,workspaceCode
• projectCode,resourceCode,resourceClass,workspaceCode

Show Source

• allocationPercentage: number (double)
  The allocation of the current role, displayed as a percentage of the availability of the role.
• commitDuration: number (double)
  The total duration of the commitments.
• commitEndDate: string (date-time)
  The finish date of the allocation commitment.
• commitFTE: number
  The total committed FTE. Calculated as total commitment units divided by total commitment duration.
• commitStartDate: string (date-time)
  The start date of the allocation commitment.
• committedUnits: number (double)
  The sum of committed units for a given project - role demand.
• demandFTE: number
  The total demand FTE. Calculated as total demand units divided by total demand duration.
• demandUnits: number (double)
  The sum of the demand units entered for a single role.
• duration: number (double)
  The total expected duration of the demand.
• endDate: string (date-time)
  The finish date for the demand.
  Calculated as Start plus Total Demand.
• periodId: integer (int64)
  The unique identifier for the period.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId(required): integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• proposedAllocationUnits: number (double)
  The total role allocation units proposed.
• proposedDuration: number (double)
  The total duration of the proposed role allocation units.
• proposedEndDate: string (date-time)
  The finish date of the proposed role allocations.
• proposedFTE: number
  The total proposed allocation FTE. Calculated as total proposed role allocation units divided by the total proposed role allocation duration.
• proposedStartDate: string (date-time)
  The start date of the proposed role allocations.
• requesterId: integer (int64)
  The unique identifier of the user who submitted the demand.
• resourceClass: string
  Allowed Values: [ "RESOURCE", "ROLE" ]

  The class identifies the item as a resource or a role.
• resourceCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the resource or role.
• resourceDemandData: array resourceDemandData
  Data about demand for the resource.
• resourceDemandId: integer (int64)
  The unique identifier of the demand. This value should not be provided in create operation request data, however, it is required for update requests.
• resourceId(required): integer (int64)
  The unique identifier for the resource.The resource object can also be identified by its unique criteria.
• sequenceNumber(required): integer (int32)
  Determines the order of appearance of demands in a list.
• startDate: string (date-time)
  The start date for the demand.
• status: string
  Allowed Values: [ "DRAFT", "COMMITTED", "NEW", "REVISED", "REVIEWED" ]

  The status of the current demand.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityResourceDemandInput",
    "required":[
        "projectId",
        "resourceId",
        "sequenceNumber"
    ],
    "type":"object",
    "properties":{
        "duration":{
            "type":"number",
            "description":"The total expected duration of the demand.",
            "format":"double",
            "exampleSetFlag":false
        },
        "status":{
            "type":"string",
            "description":"The status of the current demand.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DRAFT",
                "COMMITTED",
                "NEW",
                "REVISED",
                "REVIEWED"
            ]
        },
        "endDate":{
            "type":"string",
            "description":"The finish date for the demand. <br />Calculated as Start plus Total Demand.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceDemandData":{
            "type":"array",
            "description":"Data about demand for the resource.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityResourceDemandDataInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "resourceDemandId":{
            "type":"integer",
            "description":"The unique identifier of the demand. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "demandFTE":{
            "type":"number",
            "description":"The total demand FTE. Calculated as total demand units divided by total demand duration.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "requesterId":{
            "type":"integer",
            "description":"The unique identifier of the user who submitted the demand.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "commitFTE":{
            "type":"number",
            "description":"The total committed FTE. Calculated as total commitment units divided by total commitment duration.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "committedUnits":{
            "type":"number",
            "description":"The sum of committed units for a given project - role demand.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedFTE":{
            "type":"number",
            "description":"The total proposed allocation FTE. Calculated as total proposed role allocation units divided by the total proposed role allocation duration.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "proposedDuration":{
            "type":"number",
            "description":"The total duration of the proposed role allocation units.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedAllocationUnits":{
            "type":"number",
            "description":"The total role allocation units proposed.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedEndDate":{
            "type":"string",
            "description":"The finish date of the proposed role allocations.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class identifies the item as a resource or a role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        },
        "resourceCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for the resource or role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "demandUnits":{
            "type":"number",
            "description":"The sum of the demand units entered for a single role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "commitDuration":{
            "type":"number",
            "description":"The total duration of the commitments.",
            "format":"double",
            "exampleSetFlag":false
        },
        "commitEndDate":{
            "type":"string",
            "description":"The finish date of the allocation commitment.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "commitStartDate":{
            "type":"string",
            "description":"The start date of the allocation commitment.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "allocationPercentage":{
            "type":"number",
            "description":"The allocation of the current role, displayed as a percentage of the availability of the role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedStartDate":{
            "type":"string",
            "description":"The start date of the proposed role allocations.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "periodId":{
            "type":"integer",
            "description":"The unique identifier for the period.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "startDate":{
            "type":"string",
            "description":"The start date for the demand.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"Determines the order of appearance of demands in a list.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ResourceDemand object, a unique ResourceDemand object can be identified by the following combinations of the fields.<ul><li>resourceDemandId</li><li>projectId,resourceId</li><li>resourceId,projectCode,workspaceCode</li><li>projectId,resourceCode,resourceClass,workspaceCode</li><li>projectCode,resourceCode,resourceClass,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : resourceDemandData

Type: array

Data about demand for the resource.

Show Source

• Array of: object ApiEntityResourceDemandDataInput
  Title: ApiEntityResourceDemandDataInput

{
    "type":"array",
    "description":"Data about demand for the resource.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityResourceDemandDataInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityResourceDemandDataInput

Type: object

Title: ApiEntityResourceDemandDataInput

Show Source

• allocatedUnits: number (double)
  The unit allocation for the current role.
• commitDate: string (date-time)
  The commitment date for the demand.
• committedFlag: boolean
  Indicates whether the weekly demand data is committed.
• committedUnits: number (double)
  The total committed units of the weekly demand data.
• demandDataId: integer (int64)
  The unique identifier for the weekly demand data.
• demandUnits: number (double)
  The demand units entered for a single role.
• duration: number (double)
  The total expected duration of the weekly demand data.
• endDate: string (date-time)
  The finish date for the weekly demand data.
  Calculated as Start plus Total Demand.
• proposedAllocationUnits: number (double)
  The total proposed duration of the demand.
• proposedDuration: number (double)
  The total role allocation units proposed.
• resourceDemandId(required): integer (int64)
  The unique identifier for the demand.
• startDate: string (date-time)
  The start date for the weekly demand data.
• startOfMonth: string (date-time)
  The month in which the demand starts.
• status: string
  Allowed Values: [ "DRAFT", "COMMITTED", "NEW", "REVISED", "REVIEWED" ]

  The status of the current weekly demand data.

{
    "title":"ApiEntityResourceDemandDataInput",
    "required":[
        "resourceDemandId"
    ],
    "type":"object",
    "properties":{
        "duration":{
            "type":"number",
            "description":"The total expected duration of the weekly demand data.",
            "format":"double",
            "exampleSetFlag":false
        },
        "status":{
            "type":"string",
            "description":"The status of the current weekly demand data.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DRAFT",
                "COMMITTED",
                "NEW",
                "REVISED",
                "REVIEWED"
            ]
        },
        "endDate":{
            "type":"string",
            "description":"The finish date for the weekly demand data. <br />Calculated as Start plus Total Demand.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceDemandId":{
            "type":"integer",
            "description":"The unique identifier for the demand.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "committedUnits":{
            "type":"number",
            "description":"The total committed units of the weekly demand data.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedDuration":{
            "type":"number",
            "description":"The total role allocation units proposed.",
            "format":"double",
            "exampleSetFlag":false
        },
        "proposedAllocationUnits":{
            "type":"number",
            "description":"The total proposed duration of the demand.",
            "format":"double",
            "exampleSetFlag":false
        },
        "demandUnits":{
            "type":"number",
            "description":"The demand units entered for a single role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "demandDataId":{
            "type":"integer",
            "description":"The unique identifier for the weekly demand data.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "allocatedUnits":{
            "type":"number",
            "description":"The unit allocation for the current role.",
            "format":"double",
            "exampleSetFlag":false
        },
        "committedFlag":{
            "type":"boolean",
            "description":"Indicates whether the weekly demand data is committed.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "startOfMonth":{
            "type":"string",
            "description":"The month in which the demand starts.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "commitDate":{
            "type":"string",
            "description":"The commitment date for the demand.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "startDate":{
            "type":"string",
            "description":"The start date for the weekly demand data.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Batch Update Resource Demands Using Resource Demand IDs

Back to Top

Response

200 Response

A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"}}

400 Response

Invalid input for the Resource Demand service.

Back to Top