Jump to

• Request
• Response

Update one task change request

patch

/fscmRestApi/resources/11.13.18.05/productChangeRequests/{productChangeRequestsUniqID}/child/changeRequestTasks/{changeRequestTasksUniqID}

Request

Path Parameters

• changeRequestTasksUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Change Request Tasks resource and used to uniquely identify an instance of Change Request Tasks. The client should not generate the hash key value. Instead, the client should query on the Change Request Tasks collection resource in order to navigate to a specific instance of Change Request Tasks to get the hash key.
• productChangeRequestsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Product Change Requests resource and used to uniquely identify an instance of Product Change Requests. The client should not generate the hash key value. Instead, the client should query on the Product Change Requests collection resource in order to navigate to a specific instance of Product Change Requests to get the hash key.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssignedTo: string
  User who was assigned to the change request object task
• CompleteBeforeStatusCode: integer (int64)
  The complete before status code of the change request status
• CompleteBeforeStatusCodeValue: string
  The complete before status code value of the change request status
• Description: string
  Maximum Length: 2000

  Description of the change request object task
• Name: string
  Maximum Length: 240

  The name of the change request task.
• NeedByDateTime: string (date-time)
  Date by when the change request task is expected to be completed.
• RequiredFlag: boolean
  Maximum Length: 1

  The required Boolean value of the change request task.
• SequenceNumber: integer
  The sequence number of the change request task.
• StartAfterStatusCode: integer (int64)
  The start after status code of the change request task.
• StartAfterStatusCodeValue: string
  The start after status code value of the change request task.
• StatusCode: integer (int64)
  Abbreviation that identifies the status of the change request object task.
• StatusCodeValue: string
  Status code value that identifies the status of the change request object.

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the change request object task",
            "nullable":true
        },
        "StartAfterStatusCodeValue":{
            "type":"string",
            "description":"The start after status code value of the change request task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NeedByDateTime":{
            "type":"string",
            "description":"Date by when the change request task is expected to be completed.",
            "format":"date-time",
            "nullable":true
        },
        "StatusCode":{
            "type":"integer",
            "description":"Abbreviation that identifies the status of the change request object task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "Name":{
            "maxLength":"240",
            "type":"string",
            "description":"The name of the change request task.",
            "nullable":false
        },
        "AssignedTo":{
            "type":"string",
            "description":"User who was assigned to the change request object task",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CompleteBeforeStatusCode":{
            "type":"integer",
            "description":"The complete before status code of the change request status",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number of the change request task.",
            "nullable":false
        },
        "RequiredFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The required Boolean value of the change request task.",
            "nullable":true
        },
        "StatusCodeValue":{
            "type":"string",
            "description":"Status code value that identifies the status of the change request object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StartAfterStatusCode":{
            "type":"integer",
            "description":"The start after status code of the change request task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "CompleteBeforeStatusCodeValue":{
            "type":"string",
            "description":"The complete before status code value of the change request status",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : productChangeRequests-changeRequestTasks-item-response

Type: object

Show Source

• AssignedBy: string
  Read Only: true

  Maximum Length: 64

  User who assigned the change request task to the assignee.
• AssignedDate: string (date-time)
  Read Only: true

  Date when the task assignee of the change request object is assigned.
• AssignedTo: string
  User who was assigned to the change request object task
• CompleteBeforeStatusCode: integer (int64)
  The complete before status code of the change request status
• CompleteBeforeStatusCodeValue: string
  The complete before status code value of the change request status
• Description: string
  Maximum Length: 2000

  Description of the change request object task
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 240

  The name of the change request task.
• NeedByDateTime: string (date-time)
  Date by when the change request task is expected to be completed.
• RequiredFlag: boolean
  Maximum Length: 1

  The required Boolean value of the change request task.
• SequenceNumber: integer
  The sequence number of the change request task.
• StartAfterStatusCode: integer (int64)
  The start after status code of the change request task.
• StartAfterStatusCodeValue: string
  The start after status code value of the change request task.
• StatusCode: integer (int64)
  Abbreviation that identifies the status of the change request object task.
• StatusCodeValue: string
  Status code value that identifies the status of the change request object.
• TaskId: integer (int64)
  Read Only: true

  The task identifier of the change request task.

{
    "type":"object",
    "properties":{
        "TaskId":{
            "type":"integer",
            "description":"The task identifier of the change request task.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Description":{
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the change request object task",
            "nullable":true,
            "x-queryable":true
        },
        "StartAfterStatusCodeValue":{
            "type":"string",
            "description":"The start after status code value of the change request task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "NeedByDateTime":{
            "type":"string",
            "description":"Date by when the change request task is expected to be completed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "type":"integer",
            "description":"Abbreviation that identifies the status of the change request object task.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "maxLength":"240",
            "type":"string",
            "description":"The name of the change request task.",
            "nullable":false,
            "x-queryable":true
        },
        "AssignedTo":{
            "type":"string",
            "description":"User who was assigned to the change request object task",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CompleteBeforeStatusCode":{
            "type":"integer",
            "description":"The complete before status code of the change request status",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignedDate":{
            "type":"string",
            "description":"Date when the task assignee of the change request object is assigned.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number of the change request task.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequiredFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"The required Boolean value of the change request task.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCodeValue":{
            "type":"string",
            "description":"Status code value that identifies the status of the change request object.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssignedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who assigned the change request task to the assignee.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartAfterStatusCode":{
            "type":"integer",
            "description":"The start after status code of the change request task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "CompleteBeforeStatusCodeValue":{
            "type":"string",
            "description":"The complete before status code value of the change request status",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

TaskStatusesPVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DEGO_CHANGE_LINE_STATUSES

The following properties are defined on the LOV link relation:

• Source Attribute: StatusCodeValue; Target Attribute: Meaning
• Display Attribute: Meaning, LookupCode

UserPVO1

Operation: /hcmRestApi/resources/11.13.18.05/userAccountsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: AssignedTo; Target Attribute: Username
• Display Attribute: Username, UserGuid

Back to Top