PwsSaveProjectTaskType
Overview
This web service inserts or updates a single project task type based on a detailed project task type structure (PwsProjectTaskTypeDetail). The service returns the identity (PwsProjectTaskTypeRef) of the project task type that has been inserted or updated.
Rate Limiting
In order to protect our servers from inadvertent service overuse or intentional attack, and to fairly distribute services to all our customers, we have implemented a rate limiting algorithm. When fully deployed, this new algorithm will cause services to either succeed with new warnings or fail with new errors when services are consumed at too high a rate. Programs that consume Projector services should be enhanced to handle rate limiting errors so that they can continue functioning properly. For more information please visit: Projector Rate Limiting Behavior.
Request Format
- PwsSaveProjectTaskType
- serviceRequest: PwsSaveProjectTaskTypeRq
- RequestId: Int32
- SessionTicket: String
- AllowedProjectRateTypesClearFlag: Boolean
- EngagementTimestamp: String **deprecated**
- ProjectIdentity: PwsProjectRef
- ProjectTaskType: PwsProjectTaskTypeDetail
- StealLockFlag: Boolean **deprecated**
- LocksToSteal: PwsEntityLockSummary[1.100]
- ProjectorLockSetId: Int32
- RateTaskTimestamp: String
- serviceRequest: PwsSaveProjectTaskTypeRq
Request Elements
Element | Data Type | Required? | Default | Description | Sample Data |
---|---|---|---|---|---|
Int32 | No | Click here for more information. | |||
String | Yes | Click here for more information. | |||
AllowedProjectRateTypesClearFlag | Boolean | No | false | If set to 'true', non-default allowed project rate types are cleared. Allowed project rate types supplied in PwsProjectTaskTypeDetail are ignored. | true |
EngagementTimestamp | String | **deprecated** | |||
ProjectIdentity | Yes | The identity of the project for the project task type. Click here for more information. | |||
ProjectTaskType | Yes | The complete set of information for project task type. Click here for more information. | |||
StealLockFlag | Boolean | **deprecated** | |||
LocksToSteal | PwsEntityLockSummary[1.100] | No | The detailed information of the locks that are to be stolen. If not specified, the request will fail if any requested locks are already held. If specified, the information supplied must exactly match the current state of existing locks or the attempt to steal the existing locks will fail. Typically, this service is invoked with LocksToSteal empty or null. If there are existing locks, they will be returned in the LockHolders member of PwsFault. This data can then be sent, as is, back to the server in a second invocation of this service, as LocksToSteal, if the caller desires to steal the locks. | ||
ProjectorLockSetId | Int32 | No | A projector lock set id is an identifier for a group of one or more locks held as a unit. | ||
RateTaskTimestamp | String | No | This is an optimistic locking timestamp that, if provided on update request, will cause the request to fail when the timestamp stored in the database does not match the provided value. |
Request Usage Example(s)
Response Format
- PwsSaveProjectTaskTypeResponse
- PwsSaveProjectTaskTypeResult: PwsSaveProjectTaskTypeRs
- Messages: PwsMessage[]
- ResponseId: Int32
- Status: RequestStatus
- ServerTimestampUtc: DateTime
- ProjectTaskTypeIdentity: PwsProjectTaskTypeRef
- EngagementTimestamp: String **deprecated**
- LockStolenFromUserIdentity: PwsUserRef **deprecated**
- RateTaskTimestamp: String
- StolenLocks: PwsEntityLockSummary
- PwsSaveProjectTaskTypeResult: PwsSaveProjectTaskTypeRs
Response Elements
Element | Data Type | Description | Sample Data |
---|---|---|---|
Messages | The web service response status and message. Click here for more information. | ||
Int32 | Click here for more information. | 0 | |
Status | Click here for more information | Ok | |
DateTime | Click here for more information. | 2018-03-01T17:44:55.4574017Z | |
ProjectTaskTypeIdentity | The identity of the project task type that was just saved. Click here for more information. | ||
EngagementTimestamp | String | **deprecated** | |
LockStolenFromUserIdentity | **deprecated** | ||
RateTaskTimestamp | String | This is an optimistic locking timestamp that, if provided on update request, will cause the request to fail when the timestamp stored in the database does not match the provided value. | |
StolenLocks | PwsEntityLockSummary | This structure contains information about the locks that were stolen in order to complete this request, Will be included only when LocksToSteal is specified in the request. |
Response Usage Example(s)
PwsSaveProjectTaskType - Common Errors and Warnings
- For all errors and warnings please refer to the Complete List of Errors and Warnings
ErrorNumber | ErrorCode | ErrorText |
---|---|---|
15002 | ProjectNotSpecifiedForSaveTaskType | No project was specified for saving project task type. |
54645 | ProjectTaskTypeNameIsRequired | The project task type name is required for new project task types. |
54646 | ProjectTaskTypeNameAlreadyInUse | The specified project task type name is already in use. |
54647 | ProjectRateTypeIsRequired | The default project rate type is required for new project task types. |
54650 | ProjectRateTypeNotFound | The specified default project rate type does not exist. |
55069 | TaskTypePurchaseOrderSpecifiedWhenInheriting | Purchase order number may not be specified when inheriting purchase order number. |
57556 | TaskTypeNotSpecified | The standard task type is required for new project task types. |