QW_Update_Object

OVERVIEW

This REST API helps to update the objects(Work Items)

Method: Post

Input: 

Authorization: Basic Auth token in the Request Headers 

Post body:

Purpose of Fields given in this API: 

Parameter Value Mandatory Description
Updated_Date
String No The item’s updated date.

The format must be the date format of the local machine

Updated_By String No The name of the user-updated the item.
Object_ID
0 Yes  Input the item id which you want to update like, 6758,7897etc
View_Version
String  Yes  Input the view version of the project which displays in the URL.
Make_Branch
0 No  define 0/1 if wants to branch the item or not.
Object_Name String Yes The item name which the user wants to put
Description String No Item description in plain text/HTML format
Release_Version String No Release value (major.minor.RELEASE.build) Default is 0
Build_Version String No Build value (major.minor.release.BUILD) Default is 0
Assigned_to String No The user names the item should be assigned to. Users must belong to the project.

Default is the default assigned user in the status workflow

Customer_ID Enter the customer id if required
Site_ID Enter the site id if required
Category String No Item category.

Default is the category default value (Taken from admin system tables)

Status String No Item status.

Default is status default process flow value (Taken from admin system tables)

Priority String No Item priority.

Default is the priority default value (taken from admin system tables)

Start_date String No The item start date.

The format must be the date format of the local machine

Default is Current date & time

Effort_estimation String No Item effort estimation.

Default is 0

Due_date String No The item due date.

The format must be the date format of the local machine

 Default is Current date & time

CS1_Name String No Item 1st custom field name
CS1_value String No Item 1st custom field value
Up to CS60_Name String No Up to item 60th custom field name
Up to CS60_value String No Up to item 60th custom field value
Insert_to_Pool For change requests/requirements only: Determine whether an item is inserted to pool (value=Y) of to product tree (value=N)

Default: N

MigrationReference String No For each item inserted, you can add a reference string. Later on, you will be able to use this reference in reports, or in order to delete a group of items – you will be able to delete a group of items by the migration reference string
External_ID String No If the item source is from 3rd party system. You can add the ID from the 3rd party system for later use.

Output:

Orcanos Output class:

IsSuccess: if successful then true else false

Data: JSON object ID which is updated

Message: Error message in case IsSuccess is false

HttpCode: Response HttpCode

Leave A Comment?

You must be logged in to post a comment.