Jump to

• Request
• Response

Patch Work Activity Schedule Window

patch

https://server:port/rest/apis/asset/work/workActivity/scheduleWindow/{activityId}

Updates the scheduling window of activities. There is a work window start date/time through a work window end date/time that can be updated from other external systems that manage enterprise project planning.

Request

Path Parameters

• activityId(required): string
  System generated primary key up to 14 numeric digit identifier for the work activity record.

  Example:

  01678656581367

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• activityId: string
  Maximum Length: 14

  Activity
• externalSystem: string
  Maximum Length: 30

  External System
• windowEndDateTime: string (date-time)
  Work Window End Date/Time
• windowStartDateTime: string (date-time)
  Work Window Start Date/Time

{
    "type":"object",
    "properties":{
        "externalSystem":{
            "type":"string",
            "maxLength":30,
            "description":"External System"
        },
        "activityId":{
            "type":"string",
            "maxLength":14,
            "description":"Activity"
        },
        "windowStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Work Window Start Date/Time"
        },
        "windowEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Work Window End Date/Time"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• W1-UpdSchWin: object schema

{
    "type":"object",
    "properties":{
        "W1-UpdSchWin":{
            "type":"object",
            "properties":{
                "externalSystem":{
                    "type":"string",
                    "maxLength":30,
                    "description":"External System"
                },
                "activityId":{
                    "type":"string",
                    "maxLength":14,
                    "description":"Activity"
                },
                "windowStartDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Work Window Start Date/Time"
                },
                "windowEndDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Work Window End Date/Time"
                }
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• activityId: string
  Maximum Length: 14

  Activity
• externalSystem: string
  Maximum Length: 30

  External System
• windowEndDateTime: string (date-time)
  Work Window End Date/Time
• windowStartDateTime: string (date-time)
  Work Window Start Date/Time

{
    "type":"object",
    "properties":{
        "externalSystem":{
            "type":"string",
            "maxLength":30,
            "description":"External System"
        },
        "activityId":{
            "type":"string",
            "maxLength":14,
            "description":"Activity"
        },
        "windowStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Work Window Start Date/Time"
        },
        "windowEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Work Window End Date/Time"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response. The request was successfully completed. A 200 status is returned for a successful PATCH method.

Body ()

Root Schema : W1-UPDSCHWIN_response

Type: object

Show Source

• W1-UpdSchWin: object W1-UpdSchWin

{
    "type":"object",
    "properties":{
        "W1-UpdSchWin":{
            "type":"object",
            "properties":{
                "externalSystem":{
                    "type":"string",
                    "maxLength":30,
                    "description":"External System"
                },
                "activityId":{
                    "type":"string",
                    "maxLength":14,
                    "description":"Activity"
                },
                "windowStartDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Work Window Start Date/Time"
                },
                "windowEndDateTime":{
                    "type":"string",
                    "format":"date-time",
                    "description":"Work Window End Date/Time"
                }
            }
        }
    }
}

Nested Schema : W1-UpdSchWin

Type: object

Show Source

• activityId: string
  Maximum Length: 14

  Activity
• externalSystem: string
  Maximum Length: 30

  External System
• windowEndDateTime: string (date-time)
  Work Window End Date/Time
• windowStartDateTime: string (date-time)
  Work Window Start Date/Time

{
    "type":"object",
    "properties":{
        "externalSystem":{
            "type":"string",
            "maxLength":30,
            "description":"External System"
        },
        "activityId":{
            "type":"string",
            "maxLength":14,
            "description":"Activity"
        },
        "windowStartDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Work Window Start Date/Time"
        },
        "windowEndDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Work Window End Date/Time"
        }
    }
}

400 Response

Bad Request. The request could not be processed because it contains missing or invalid information (such as a validation error on an input field, a missing required value, and so on).

Body ()

Root Schema : W1-UPDSCHWIN_error

Type: object

Show Source

• problemDetailDocument: object problemDetailDocument

{
    "type":"object",
    "properties":{
        "problemDetailDocument":{
            "type":"object",
            "properties":{
                "problemType":{
                    "type":"string",
                    "maxLength":60,
                    "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
                },
                "title":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "httpStatus":{
                    "type":"number",
                    "maximum":9999,
                    "minimum":0,
                    "description":"The HTTP Status code for the error."
                },
                "detail":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                },
                "problemInstance":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
                },
                "stackTrace":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The stack trace shows where the error occurs during the execution of a program."
                },
                "serverMessage":{
                    "type":"object",
                    "properties":{
                        "messageCategory":{
                            "type":"number",
                            "maximum":0,
                            "minimum":0,
                            "description":"Message Category within Oracle Utilities Application Framework."
                        },
                        "messageNbr":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"Message Number within Oracle Utilities Application Framework."
                        },
                        "callSequence":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Delimited sequence of programs called."
                        },
                        "programName":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Name of the program that encountered the error."
                        },
                        "messageText":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                        },
                        "longDescription":{
                            "type":"string",
                            "maxLength":60,
                            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition that prevented it from fulfilling the request.

Body ()

Root Schema : W1-UPDSCHWIN_error

Type: object

Show Source

• problemDetailDocument: object problemDetailDocument

{
    "type":"object",
    "properties":{
        "problemDetailDocument":{
            "type":"object",
            "properties":{
                "problemType":{
                    "type":"string",
                    "maxLength":60,
                    "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
                },
                "title":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "httpStatus":{
                    "type":"number",
                    "maximum":9999,
                    "minimum":0,
                    "description":"The HTTP Status code for the error."
                },
                "detail":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                },
                "problemInstance":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
                },
                "stackTrace":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The stack trace shows where the error occurs during the execution of a program."
                },
                "serverMessage":{
                    "type":"object",
                    "properties":{
                        "messageCategory":{
                            "type":"number",
                            "maximum":0,
                            "minimum":0,
                            "description":"Message Category within Oracle Utilities Application Framework."
                        },
                        "messageNbr":{
                            "type":"number",
                            "maximum":99999,
                            "minimum":-99999,
                            "description":"Message Number within Oracle Utilities Application Framework."
                        },
                        "callSequence":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Delimited sequence of programs called."
                        },
                        "programName":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Name of the program that encountered the error."
                        },
                        "messageText":{
                            "type":"string",
                            "maxLength":60,
                            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                        },
                        "longDescription":{
                            "type":"string",
                            "maxLength":60,
                            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top