setAttributeValue
This method allows setting an attribute (in planning or execution) belonging to an action plan, plan action, isolated action, action plan template, isolated action template, and action plan template action. To insert each of these items, it is necessary to follow the standard documented below.
caution
Note: The ActionPlanID and ActionID fields, by default, are not required, but at least one of them must be filled in order to identify the object that must be changed.
Java class | |
---|---|
Request | web/wwwroot/ws/java/timecontrol/SetAttributeValueRequestType.java |
Return | web/wwwroot/ws/java/timecontrol/SetAttributeValueResponseType.java |
Request​
Default​
ID # | Required | Description |
---|---|---|
ActionPlanID | Action plan or action plan template ID #. | |
ActionID | Action, isolated action or isolated action template ID #. | |
IsModel | Identifies whether it is a template: 1 - Yes 2 - No Note: The default value is 2. | |
NmAttribute | X | Attribute ID #. |
VlAttribute | X | Attribute value. |
Step | Attribute step: 1 - Planning 2 - Execution Note: Action plan, plan template action, and action plan and isolated action templates only have the planning step. If the parameter is not set, the status rule will be used ((1,2) - Planning) and status ((3,4,5,6 = Execution). |
Action plan​
ID # | Required | Description |
---|---|---|
ActionPlanID | X | Action plan ID #. |
ActionID | Action, isolated action or isolated action template ID #. | |
IsModel | Identifies whether it is a template: 1 - Yes 2 - No Note: The default value is 2. | |
NmAttribute | X | Attribute ID #. |
VlAttribute | X | Attribute value. |
Step | Attribute step: 1 - Planning 2 - Execution |
Isolated action​
ID # | Required | Description |
---|---|---|
ActionPlanID | Action plan or action plan template ID #. | |
ActionID | X | Isolated action ID #. |
IsModel | Identifies whether it is a template: 1 - Yes 2 - No Note: The default value is 2. | |
NmAttribute | X | Attribute ID #. |
VlAttribute | X | Attribute value. |
Step | Attribute step: 1 - Planning 2 - Execution |
Action of action plan:​
ID # | Required | Description |
---|---|---|
ActionPlanID | X | Action plan ID #. |
ActionID | X | Plan action ID #. |
IsModel | Identifies whether it is a template: 1 - Yes 2 - No Note: The default value is 2. | |
NmAttribute | X | Attribute ID #. |
VlAttribute | X | Attribute value. |
Step | Attribute step: 1 - Planning 2 - Execution |
Action plan templates:​
ID # | Required | Description |
---|---|---|
ActionPlanID | X | Action plan template ID #. |
ActionID | Action, isolated action or isolated action template ID #. | |
IsModel | X | Identifies whether it is a template: 1 - Yes 2 - No Note: The default value is 2. |
NmAttribute | X | Attribute ID #. |
VlAttribute | X | Attribute value. |
Step | Attribute step: 1 - Planning 2 - Execution |
Isolated action template:​
ID # | Required | Description |
---|---|---|
ActionPlanID | Action plan or action plan template ID #. | |
ActionID | X | Isolated action template ID #. |
IsModel | X | Identifies whether it is a template: 1 - Yes 2 - No Note: The default value is 2. |
NmAttribute | X | Attribute ID #. |
VlAttribute | X | Attribute value. |
Step | Attribute step: 1 - Planning 2 - Execution |
Action plan template action​
ID # | Required | Description |
---|---|---|
ActionPlanID | X | Action plan template ID #. |
ActionID | X | Action ID #. |
IsModel | X | Identifies whether it is a template: 1 - Yes 2 - No Note: The default value is 2. |
NmAttribute | X | Attribute ID #. |
VlAttribute | X | Attribute value. |
Step | Attribute step: 1 - Planning 2 - Execution |
Request structure​
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:timecontrol">
<soapenv:Header/>
<soapenv:Body>
<urn:setAttributeValue>
<!--You may enter the following 6 items in any order-->
<urn:ActionPlanID>?</urn:ActionPlanID>
<urn:ActionID>?</urn:ActionID>
<urn:IsModel>?</urn:IsModel>
<urn:NmAttribute>?</urn:NmAttribute>
<urn:VlAttribute>?</urn:VlAttribute>
<urn:Step>?</urn:Step>
</urn:setAttributeValue>
</soapenv:Body>
</soapenv:Envelope>
Return​
ID # | Description |
---|---|
Status | Method execution status. Its value may be: SUCCESS: Method executed successfully. FAILURE: An error occurred during the method execution. |
Code | 1. Method executed successfully. -1. ID # not found. -2. This record does not have the attribute. -3. Missing required data. Field: -4. It is not possible to edit this record in the planning step. -30. Error when validating the attribute. |
Detail | SUCCESS: Action successfully executed. FAILURE: Description of the error that was found. |