NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

Update a step for a wizard template

put

/spms/v1/stepTemplates

This is to update a step for a wizard template

Request

Supported Media Types

• application/json

Body ()

Step Templates

Root Schema : StepTemplatesWithId

Type: object

Step Templates

Show Source

• enabled(optional): boolean
  Example: true
• id(optional): integer
  Minimum Value: 1

  Maximum Value: 20

  This is the Step Template primary key

  Example: 1
• sequence: integer
  Minimum Value: 1

  This is will be used for sorting so that the steps can be configured

  Example: 1
• stepType: integer
  Minimum Value: 1

  This is the id of a Step type

  Example: 1
• stepVersion: integer
  This is the foreign key of the respective step template version number

  Example: 1001
• wizardId: integer
  Minimum Value: 1

  This is the id of the Wizard Template

  Example: 1

{
    "description":"Step Templates",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "minimum":1,
            "maximum":20,
            "example":"1",
            "description":"This is the Step Template primary key"
        },
        "sequence":{
            "type":"integer",
            "minimum":1,
            "example":"1",
            "description":"This is will be used for sorting so that the steps can be configured"
        },
        "stepType":{
            "type":"integer",
            "minimum":1,
            "example":"1",
            "description":"This is the id of a Step type"
        },
        "wizardId":{
            "type":"integer",
            "minimum":1,
            "example":"1",
            "description":"This is the id of the Wizard Template"
        },
        "enabled":{
            "type":"boolean",
            "example":true
        },
        "stepVersion":{
            "type":"integer",
            "example":"1001",
            "description":"This is the foreign key of the respective step template version number"
        }
    },
    "required":[
        "sequence",
        "stepType",
        "wizardId",
        "stepVersion"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Step Template updated successfully

Body ()

Root Schema : StepTemplatesWithId

Type: object

Step Templates

Show Source

• enabled(optional): boolean
  Example: true
• id(optional): integer
  Minimum Value: 1

  Maximum Value: 20

  This is the Step Template primary key

  Example: 1
• sequence: integer
  Minimum Value: 1

  This is will be used for sorting so that the steps can be configured

  Example: 1
• stepType: integer
  Minimum Value: 1

  This is the id of a Step type

  Example: 1
• stepVersion: integer
  This is the foreign key of the respective step template version number

  Example: 1001
• wizardId: integer
  Minimum Value: 1

  This is the id of the Wizard Template

  Example: 1

{
    "description":"Step Templates",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "minimum":1,
            "maximum":20,
            "example":"1",
            "description":"This is the Step Template primary key"
        },
        "sequence":{
            "type":"integer",
            "minimum":1,
            "example":"1",
            "description":"This is will be used for sorting so that the steps can be configured"
        },
        "stepType":{
            "type":"integer",
            "minimum":1,
            "example":"1",
            "description":"This is the id of a Step type"
        },
        "wizardId":{
            "type":"integer",
            "minimum":1,
            "example":"1",
            "description":"This is the id of the Wizard Template"
        },
        "enabled":{
            "type":"boolean",
            "example":true
        },
        "stepVersion":{
            "type":"integer",
            "example":"1001",
            "description":"This is the foreign key of the respective step template version number"
        }
    },
    "required":[
        "sequence",
        "stepType",
        "wizardId",
        "stepVersion"
    ]
}

400 Response

The supplied parameter(s) is not valid

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

401 Response

You are not authorized to use this API

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

403 Response

You are forbidden to use this API

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

404 Response

The step template does not exist

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

405 Response

This method is not available

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

409 Response

Conflict occurred while trying to update

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

415 Response

The media supplied is not supported

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

500 Response

Error occurred while processing this request

Body ()

Root Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

• detail(optional): string
  Example: There are validation errors for the object......
• title(optional): string
  Example: validation fails for row with key={123}
• type(optional): string
  Example: HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "example":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1"
        },
        "title":{
            "type":"string",
            "example":"validation fails for row with key={123}"
        },
        "detail":{
            "type":"string",
            "example":"There are validation errors for the object......"
        }
    }
}

502 Response

Bad Gateway

503 Response

Service not available

Back to Top