Jump to

• Request
• Response

Get one participant of the problem report

get

/fscmRestApi/resources/11.13.18.05/qualityProblemReports/{qualityProblemReportsUniqID}/child/problemReportParticipants/{problemReportParticipantsUniqID}

Request

Path Parameters

• problemReportParticipantsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Problem Report Participants resource and used to uniquely identify an instance of Problem Report Participants. The client should not generate the hash key value. Instead, the client should query on the Problem Report Participants collection resource in order to navigate to a specific instance of Problem Report Participants to get the hash key.
• qualityProblemReportsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Quality Problem Reports resource and used to uniquely identify an instance of Quality Problem Reports. The client should not generate the hash key value. Instead, the client should query on the Quality Problem Reports collection resource in order to navigate to a specific instance of Quality Problem Reports to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : qualityProblemReports-problemReportParticipants-item-response

Type: object

Show Source

• ActivityTypeCode: string
  Maximum Length: 255

  Problem Reports Activity type code.
• ActivityTypeValue: string
  Maximum Length: 255

  Problem Reports Activity type value.
• AssigneeName: string
  Maximum Length: 400

  The assignee name for problem report participants of the problem report.
• AssigneeTypeCode: string
  Maximum Length: 20

  The assignee type code for the problem report participant of the problem report.
• AssigneeTypeValue: string
  Maximum Length: 255

  Assignee type value describe participant is an individual or a role for a problem report object.
• Comments: string
  Read Only: true

  Maximum Length: 255

  Comments provided at the time of approving or rejecting the problem report object.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReassignedTime: string (date-time)
  Read Only: true

  Time that the problem report participants were reassigned to a problem report object.
• ReassignedTo: string
  Read Only: true

  Maximum Length: 4000

  Name to which a problem report participant is to be reassigned for a problem report object.
• ResponseCode: string
  Read Only: true

  Maximum Length: 30

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

  The response required from participants of the problem report.
• ResponseRequiredFromValue: string
  Maximum Length: 255

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

  Maximum Length: 255

  Response value describe action taken by an approver on a problem report object.
• StatusCode: integer
  Abbreviation that identifies the status of the Problem Report Object.
• StatusCodeValue: string
  Maximum Length: 255

  Status code value that identifies the status of the Problem Report Object.

{
    "type":"object",
    "properties":{
        "AssigneeName":{
            "maxLength":400,
            "type":"string",
            "description":"The assignee name for problem report participants of the problem report.",
            "nullable":true,
            "x-queryable":false
        },
        "ResponseCode":{
            "maxLength":30,
            "type":"string",
            "description":"Response code value describe action taken by an approver on a problem report object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Problem Reports Activity type code.",
            "nullable":true,
            "x-queryable":true
        },
        "AssigneeTypeCode":{
            "maxLength":20,
            "type":"string",
            "description":"The assignee type code for the problem report participant of the problem report.",
            "nullable":false,
            "x-queryable":true
        },
        "Comments":{
            "maxLength":255,
            "type":"string",
            "description":"Comments provided at the time of approving or rejecting the problem report object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "type":"integer",
            "description":"Abbreviation that identifies the status of the Problem Report Object.",
            "nullable":true,
            "x-queryable":true
        },
        "ReassignedTime":{
            "type":"string",
            "description":"Time that the problem report participants were reassigned to a problem report object.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityTypeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Problem Reports Activity type value.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReassignedTo":{
            "maxLength":4000,
            "type":"string",
            "description":"Name to which a problem report participant is to be reassigned for a problem report 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 problem report 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 problem report 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 problem report 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 Problem Report Object.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseRequiredFrom":{
            "maxLength":10,
            "type":"string",
            "description":"The response required from participants of the problem report.",
            "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