Jump to

• Request
• Response

Create or add multiple participants to a corrective action

post

/fscmRestApi/resources/11.13.18.05/qualityCorrectiveAndPreventiveActions/{qualityCorrectiveAndPreventiveActionsUniqID}/child/correctiveActionParticipants

Request

Path Parameters

• qualityCorrectiveAndPreventiveActionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Quality Corrective and Preventive Actions resource and used to uniquely identify an instance of Quality Corrective and Preventive Actions. The client should not generate the hash key value. Instead, the client should query on the Quality Corrective and Preventive Actions collection resource in order to navigate to a specific instance of Quality Corrective and Preventive Actions 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

• ActivityTypeCode: string
  Maximum Length: 255

  Corrective Actions Activity type code.
• ActivityTypeValue: string
  Maximum Length: 255

  Corrective Actions Activity type value.
• AssigneeName: string
  Maximum Length: 400

  The assignee name for change participants of the corrective action.
• AssigneeTypeCode: string
  Maximum Length: 20

  The assignee type code for change participants of the corrective action.
• AssigneeTypeValue: string
  Maximum Length: 255

  Assignee type value describe participant is an individual or a role for a corrective and preventive action object.
• ResponseRequiredFrom: string
  Maximum Length: 10

  The response required from change participants of the corrective action.
• ResponseRequiredFromValue: string
  Maximum Length: 255

  Response required from value describe about whether a response is required from one or all participants for a corrective and preventive action object.
• StatusCode: integer
  Abbreviation that identifies the status code of the corrective and preventive action object.
• StatusCodeValue: string
  Maximum Length: 255

  Status code value that identifies the status of the corrective and preventive action object.

{
    "type":"object",
    "properties":{
        "AssigneeName":{
            "maxLength":"400",
            "type":"string",
            "description":"The assignee name for change participants of the corrective action.",
            "nullable":true,
            "x-queryable":false
        },
        "ActivityTypeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Corrective Actions Activity type code.",
            "nullable":true
        },
        "AssigneeTypeCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The assignee type code for change participants of the corrective action.",
            "nullable":false
        },
        "AssigneeTypeValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Assignee type value describe participant is an individual or a role for a corrective and preventive action object.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResponseRequiredFromValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Response required from value describe about whether a response is required from one or all participants for a corrective and preventive action object.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StatusCodeValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Status code value that identifies the status of the corrective and preventive action object.",
            "nullable":true
        },
        "StatusCode":{
            "type":"integer",
            "description":"Abbreviation that identifies the status code of the corrective and preventive action object.",
            "nullable":true
        },
        "ResponseRequiredFrom":{
            "maxLength":"10",
            "type":"string",
            "description":"The response required from change participants of the corrective action.",
            "nullable":true
        },
        "ActivityTypeValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Corrective Actions Activity type value.",
            "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 : qualityCorrectiveAndPreventiveActions-correctiveActionParticipants-item-response

Type: object

Show Source

• ActivityTypeCode: string
  Maximum Length: 255

  Corrective Actions Activity type code.
• ActivityTypeValue: string
  Maximum Length: 255

  Corrective Actions Activity type value.
• AssigneeName: string
  Maximum Length: 400

  The assignee name for change participants of the corrective action.
• AssigneeTypeCode: string
  Maximum Length: 20

  The assignee type code for change participants of the corrective action.
• AssigneeTypeValue: string
  Maximum Length: 255

  Assignee type value describe participant is an individual or a role for a corrective and preventive action object.
• Comments: string
  Read Only: true

  Maximum Length: 255

  Comments provided at the time of approving or rejecting the corrective and preventive action object.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OriginalRoleAssignee: string
  Read Only: true

  Maximum Length: 4000

  User role that the application assigned to the corrective and preventive action object.
• ReassignedTime: string (date-time)
  Read Only: true

  Time that the corrective action participants were reassigned to a corrective and preventive action object.
• ReassignedTo: string
  Read Only: true

  Maximum Length: 4000

  Name to which a corrective action participant is to be reassigned for a corrective and preventive action object.
• ResponseCode: string
  Read Only: true

  Maximum Length: 30

  Response code value describe action taken by an approver on a corrective and preventive action object.
• ResponseRequiredFrom: string
  Maximum Length: 10

  The response required from change participants of the corrective action.
• ResponseRequiredFromValue: string
  Maximum Length: 255

  Response required from value describe about whether a response is required from one or all participants for a corrective and preventive action object.
• ResponseValue: string
  Read Only: true

  Maximum Length: 255

  Response value describe action taken by an approver on a corrective and preventive action object.
• StatusCode: integer
  Abbreviation that identifies the status code of the corrective and preventive action object.
• StatusCodeValue: string
  Maximum Length: 255

  Status code value that identifies the status of the corrective and preventive action object.

{
    "type":"object",
    "properties":{
        "AssigneeName":{
            "maxLength":"400",
            "type":"string",
            "description":"The assignee name for change participants of the corrective action.",
            "nullable":true,
            "x-queryable":false
        },
        "ResponseCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Response code value describe action taken by an approver on a corrective and preventive action object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityTypeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Corrective Actions Activity type code.",
            "nullable":true,
            "x-queryable":true
        },
        "AssigneeTypeCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The assignee type code for change participants of the corrective action.",
            "nullable":false,
            "x-queryable":true
        },
        "Comments":{
            "maxLength":"255",
            "type":"string",
            "description":"Comments provided at the time of approving or rejecting the corrective and preventive action object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "type":"integer",
            "description":"Abbreviation that identifies the status code of the corrective and preventive action object.",
            "nullable":true,
            "x-queryable":true
        },
        "ReassignedTime":{
            "type":"string",
            "description":"Time that the corrective action participants were reassigned to a corrective and preventive action object.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityTypeValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Corrective Actions Activity type value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OriginalRoleAssignee":{
            "maxLength":"4000",
            "type":"string",
            "description":"User role that the application assigned to the corrective and preventive action object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReassignedTo":{
            "maxLength":"4000",
            "type":"string",
            "description":"Name to which a corrective action participant is to be reassigned for a corrective and preventive action object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeTypeValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Assignee type value describe participant is an individual or a role for a corrective and preventive action object.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResponseValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Response value describe action taken by an approver on a corrective and preventive action object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseRequiredFromValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Response required from value describe about whether a response is required from one or all participants for a corrective and preventive action object.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StatusCodeValue":{
            "maxLength":"255",
            "type":"string",
            "description":"Status code value that identifies the status of the corrective and preventive action object.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseRequiredFrom":{
            "maxLength":"10",
            "type":"string",
            "description":"The response required from change participants of the corrective action.",
            "nullable":true,
            "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."
        }
    }
}

Back to Top