Jump to

• Request
• Response

Create and run mass edit job for advanced controls incidents

post

/fscmRestApi/resources/11.13.18.05/advancedControlMassEditIncidents

Request

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

• Comments: string
  Maximum Length: 2000

  The comments that are being added to the incidents as part of the mass edit job.
• IncidentId: string
  Maximum Length: 255

  The unique identifier of each incident that's being updated as part of the mass edit job.
• ResultInvestigator: string
  Maximum Length: 255

  The user name of each result investigator being added, removed, or replaced as part of the mass update job.
• Status: string
  Maximum Length: 30

  The value to which status of all incidents is being updated as part of the mass edit job.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":"30",
            "type":"string",
            "description":"The value to which status of all incidents is being updated as part of the mass edit job.",
            "nullable":true
        },
        "ResultInvestigator":{
            "maxLength":"255",
            "type":"string",
            "description":"The user name of each result investigator being added, removed, or replaced as part of the mass update job.",
            "nullable":true
        },
        "Comments":{
            "maxLength":"2000",
            "type":"string",
            "description":"The comments that are being added to the incidents as part of the mass edit job.",
            "nullable":true
        },
        "IncidentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of each incident that's being updated as part of the mass edit job.",
            "nullable":true
        }
    }
}

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 : advancedControlMassEditIncidents-item-response

Type: object

Show Source

• Comments: string
  Maximum Length: 2000

  The comments that are being added to the incidents as part of the mass edit job.
• IncidentId: string
  Maximum Length: 255

  The unique identifier of each incident that's being updated as part of the mass edit job.
• JobRunId: string
  Read Only: true

  The unique identifier of the mass edit job run.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResultInvestigator: string
  Maximum Length: 255

  The user name of each result investigator being added, removed, or replaced as part of the mass update job.
• Status: string
  Maximum Length: 30

  The value to which status of all incidents is being updated as part of the mass edit job.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":"30",
            "type":"string",
            "description":"The value to which status of all incidents is being updated as part of the mass edit job.",
            "nullable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResultInvestigator":{
            "maxLength":"255",
            "type":"string",
            "description":"The user name of each result investigator being added, removed, or replaced as part of the mass update job.",
            "nullable":true
        },
        "JobRunId":{
            "type":"string",
            "description":"The unique identifier of the mass edit job run.",
            "nullable":true,
            "readOnly":true
        },
        "Comments":{
            "maxLength":"2000",
            "type":"string",
            "description":"The comments that are being added to the incidents as part of the mass edit job.",
            "nullable":true
        },
        "IncidentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of each incident that's being updated as part of the mass edit job.",
            "nullable":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."
        }
    }
}

Back to Top