Get one action
get
/fscmRestApi/resources/11.13.18.05/qualityActions/{ActionId}
Request
Path Parameters
-
ActionId(required): integer(int64)
Value that uniquely identifies the quality action.
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: string
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: string
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 TopResponse
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.
Root Schema : qualityActions-item-response
Type:
Show Source
object-
ActionAutonumber: string
Title:
NumberMaximum Length:100Number that uniquely identifies the quality action. -
ActionId: integer
(int64)
Read Only:
trueValue that uniquely identifies the quality action. -
ActionTypeCode: string
Abbreviation that identifies the type of quality action.
-
ActionTypeId: integer
(int64)
Title:
TypeValue that identifies the type of quality action. -
ActionTypeName: string
Title:
TypeRead Only:trueName of the quality action type. -
ActualResolutionDate: string
(date-time)
Title:
Actual Resolution DateDate when the application resolved the quality action. -
AffectedObjects: array
Affected Objects
Title:
Affected ObjectsThe Affected Objects resource manages the objects that a quality action affects. It references an item, inspection, work order operation, or some other object in manufacturing or inspection that caused a quality issue or that a quality issue affected. -
AssignedTo: string
Title:
Assigned ToMaximum Length:64User whom the application assigned to the quality action. -
AssignedUser: string
Read Only:
trueUser who is assigned to the quality action. -
Attachments: array
Attachments
Title:
AttachmentsThe Attachments resource manages details about the quality action or document and provides details about how the application resolved the quality action. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the quality action. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the application created the quality action. -
CustomerId: integer
(int64)
Value that uniquely identifies the customer related to this action.
-
CustomerName: string
Read Only:
trueName of the customer. -
DateReleased: string
(date-time)
Date when the application released the quality action.
-
DateSubmitted: string
(date-time)
Date when the application submitted the quality action.
-
Description: string
(byte)
Title:
DescriptionLong description of the quality action. -
Disposition: string
Title:
DispositionMaximum Length:30Proposed disposition of the quality action. -
DispositionComment: string
Title:
Disposition CommentMaximum Length:4000Comment on the disposition of the quality action. -
DispositionName: string
Read Only:
trueName of the disposition. -
ExpectedResolutionDate: string
(date-time)
Title:
Expected Resolution DateDate when the application must resolve the quality action. -
FinalCompletionDate: string
(date-time)
Date when the application completed the quality action.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueDate when the application most recently updated the quality action. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who performed the most recent update. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Title:
NameMaximum Length:400Short name of the quality action. -
OrganizationCode: string
Abbreviation that identifies the organization where the quality action occurred.
-
OrganizationId: integer
(int64)
Title:
OrganizationValue that uniquely identifies the organization where the quality action occurred. -
OrganizationName: string
Title:
OrganizationRead Only:trueName of the organization. -
Priority: string
Title:
PriorityMaximum Length:30Severity of the quality action. -
PriorityName: string
Read Only:
trueName of the priority. -
ProductLineId: string
Maximum Length:
30Value that uniquely identifies the item line related to the quality action. -
Relationships: array
Relationships
Title:
RelationshipsThe Relationships resource manages the objects related to a quality action. The objects reference a quality issue, an item, or other objects. -
ResolutionDescription: string
(byte)
Description of the resolution of the quality action.
-
Security: array
Security Grantees
Title:
Security GranteesThe Security Grantees resource manages the security grantees who have access to the quality action. -
Source: string
Title:
SourceMaximum Length:30Source or location where the quality action occurred. -
SourceName: string
Read Only:
trueName of the source. -
StatusTypeId: integer
(int64)
Read Only:
trueInternal value that uniquely identifies the quality action's status type. -
StatusTypeName: string
Read Only:
trueDisplay name of the type of status of the quality action. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier related to this action.
-
SupplierName: string
Read Only:
trueName of the supplier. -
TextDescription: string
Plain text description of the quality action.
-
WorkflowApprovers: array
Workflow Approvers
Title:
Workflow ApproversThe Workflow Approvers resource manages the workflow approvers. -
WorkflowStatusCode: string
Workflow status of the quality action.
-
WorkflowStatusId: integer
(int64)
Value that identifies the workflow status.
-
WorkflowStatusName: string
Title:
StatusRead Only:trueName of the workflow status. -
WorkflowTemplateCode: string
Maximum Length:
80Abbreviation that identifies the workflow template. -
WorkflowTemplateId: integer
Value that uniquely identifies the workflow template.
-
WorkflowTemplateName: string
Title:
WorkflowRead Only:trueName of the workflow template.
Nested Schema : Affected Objects
Type:
arrayTitle:
Affected ObjectsThe Affected Objects resource manages the objects that a quality action affects. It references an item, inspection, work order operation, or some other object in manufacturing or inspection that caused a quality issue or that a quality issue affected.
Show Source
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe Attachments resource manages details about the quality action or document and provides details about how the application resolved the quality action.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Relationships
Type:
arrayTitle:
RelationshipsThe Relationships resource manages the objects related to a quality action. The objects reference a quality issue, an item, or other objects.
Show Source
Nested Schema : Security Grantees
Type:
arrayTitle:
Security GranteesThe Security Grantees resource manages the security grantees who have access to the quality action.
Show Source
Nested Schema : Workflow Approvers
Type:
arrayTitle:
Workflow ApproversThe Workflow Approvers resource manages the workflow approvers.
Show Source
Nested Schema : qualityActions-AffectedObjects-item-response
Type:
Show Source
object-
AffectedObjectId: integer
(int64)
Title:
Affected ObjectValue that uniquely identifies the affected object. -
ContextCode: string
Abbreviation that identifies the context of the affected object.
-
ContextId: integer
(int64)
Value that uniquely identifies the context of the affected object.
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who added the affected object. -
CreationDate: string
(date-time)
Read Only:
trueDate when the application added the affected object. -
Description: string
Title:
DescriptionMaximum Length:400Description of the affected object. -
ImpactType: string
Title:
Impact TypeMaximum Length:30Type of impact the affected object causes. -
ImpactTypeName: string
Read Only:
trueName of the impact type. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the application most recently updated the affected object. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who performed the most recent update. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectId: integer
(int64)
Title:
ObjectValue that identifies the affected object. -
Status: string
Title:
Relation StatusMaximum Length:30Status of the affected object. -
StatusName: string
Read Only:
trueName of the status. -
SubContextCode: string
Abbreviation that identifies the subcontext of the affected object.
-
SubContextFiveId: string
Maximum Length:
80Value that uniquely identifies the fifth subcontext of the affected object. -
SubContextFourId: integer
(int64)
Value that uniquely identifies the fourth subcontext of the affected object.
-
SubContextId: integer
(int64)
Value that uniquely identifies the subcontext of the affected object.
-
SubContextSixId: string
Maximum Length:
80Value that uniquely identifies the sixth subcontext of the affected object. -
SubContextThreeId: integer
(int64)
Value that uniquely identifies the third subcontext of the affected object.
-
SubContextTwoCode: string
Abbreviation that identifies the second subcontext of the affected object.
-
SubContextTwoId: integer
(int64)
Value that uniquely identifies the second subcontext of the affected object.
-
SupportedEntityCode: string
Abbreviation that identifies the type of affected object.
-
SupportedEntityId: integer
(int64)
Value that identifies the type of affected object.
-
SupportedEntityName: string
Name of the supported entity.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : qualityActions-Attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAn identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdValue that identifies the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueLogin that the user used when creating the attachment for the specification. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the user created the attachment. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEAbbreviation that identifies the data type. -
Description: string
Title:
DescriptionMaximum Length:255Description of the attachment. -
DmDocumentId: string
Maximum Length:
255Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path where the attachment resides. -
DmVersionNumber: string
Maximum Length:
255Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeAbbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageText of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateDate when the contents of the attachment expires. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048File name of the attachment. -
FileUrl: string
Title:
File UrlURL (Uniform Resource Locator) that locates the attachment. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueBase64-encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate and time when the application most recently updated the attached document. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255Login of the user who most recently updated the attached document. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueLogin that the user used when updating the attachment for the specification. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the attachment. -
UploadedFileLength: integer
Title:
File SizeLength of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameName of the attachment file. -
UploadedText: string
Title:
Uploaded TextText of the attachment. -
Uri: string
Title:
UriMaximum Length:4000URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
UrlMaximum Length:4000URL (Uniform Resource Locator) that locates the attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : qualityActions-Relationships-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the relationship. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the relationship. -
Description: string
Description of the related object.
-
DestObjId: integer
(int64)
Value that uniquely identifies the destination object.
-
DestObjType: string
Maximum Length:
30Type of the destination object. -
DestObjTypeName: string
Read Only:
trueName of the destination object type. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the relationship. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the relationship. -
LatestFlag: boolean
Contains one of the following values: true or false. If true, then the related object is the latest. If false, then the related object is not the latest. This attribute does not have a default value.
-
LatestFlagName: string
Read Only:
trueName of the latest flag. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Name of the related object.
-
RelationshipId: integer
(int64)
Read Only:
trueValue that uniquely identifies the relationship. -
RelationshipType: string
Title:
Relationship TypeMaximum Length:30Type of relationship. -
RelationshipTypeName: string
Read Only:
trueName of the relationship type. -
SrcObjId: integer
(int64)
Value that uniquely identifies the source object.
-
SrcObjType: string
Maximum Length:
30Type of the source object. -
Status: string
Status of the related object.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : qualityActions-Security-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the security grantee. -
CreationDate: string
(date-time)
Read Only:
trueDate when the user created the security grantee. -
GranteeName: string
Maximum Length:
256Name of the security grantee. -
GranteeType: string
Title:
PrincipalMaximum Length:30Type of the security grantee. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the user most recently updated the security grantee. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the security grantee. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : qualityActions-WorkflowApprovers-item-response
Type:
Show Source
object-
ActivityType: string
Type of the workflow approval activity.
-
AssigneeName: string
Name of the workflow approval assignee.
-
AssigneeType: string
Type of the workflow approval assignee.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
WfRoutePeopleId: integer
(int64)
Value that uniquely identifies the workflow approver.
-
WorkflowStatusCode: string
Abbreviation that identifies the workflow approval status.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- AffectedObjects
-
Parameters:
- ActionId:
$request.path.ActionId
The Affected Objects resource manages the objects that a quality action affects. It references an item, inspection, work order operation, or some other object in manufacturing or inspection that caused a quality issue or that a quality issue affected. - ActionId:
- Attachments
-
Parameters:
- ActionId:
$request.path.ActionId
The Attachments resource manages details about the quality action or document and provides details about how the application resolved the quality action. - ActionId:
- Relationships
-
Parameters:
- ActionId:
$request.path.ActionId
The Relationships resource manages the objects related to a quality action. The objects reference a quality issue, an item, or other objects. - ActionId:
- Security
-
Parameters:
- ActionId:
$request.path.ActionId
The Security Grantees resource manages the security grantees who have access to the quality action. - ActionId:
- WorkflowApprovers
-
Parameters:
- ActionId:
$request.path.ActionId
The Workflow Approvers resource manages the workflow approvers. - ActionId:
Examples
This example describes how to get one action.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/qualityActions/ActionId"
For example, the following command gets one action:
curl -u username:password "https://servername/fscmRestApi/resources/version/qualityActions/300100255109683"
Example Response Body
The following shows an example of the response body in JSON format.
{
"ActionId": 300100255109683,
"ActionAutonumber": "ACTION151",
"Name": "Action XYZ",
"ActionTypeId": 5110,
"ActionTypeCode": "ORA_ENQ_CORRECTIVE",
"ActionTypeName": "CAPA - Corrective Action",
"Priority": "ORA_MEDIUM",
"PriorityName": "Medium",
"Source": null,
"SourceName": null,
"CustomerId": null,
"SupplierId": null,
"Disposition": null,
"DispositionName": null,
"DispositionComment": null,
"CreationDate": "2020-09-16T12:22:49+00:00",
"LastUpdateDate": "2020-09-16T12:22:50.207+00:00",
"ExpectedResolutionDate": null,
"ActualResolutionDate": null,
"WorkflowTemplateId": null,
"WorkflowTemplateCode": null,
"WorkflowTemplateName": null,
"WorkflowStatusId": 999,
"WorkflowStatusCode": "ORA_ENQ_DEFAULT_STATUS",
"WorkflowStatusName": "Default",
"CreatedBy": "QUALITY_ANALYST",
"AssignedTo": "QUALITY_ANALYST",
"DateSubmitted": null,
"FinalCompletionDate": null,
"DateReleased": null,
"LastUpdatedBy": "QUALITY_ANALYST",
"ProductLineId": null,
"ActionEO_QA_DCL_QI_Id_c": null,
"ActionEO_QA_DCL_QI_c": null,
"Relationships": [],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/qualityActions/300100255109683",
"name": "qualityActions",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/qualityActions/300100255109683",
"name": "qualityActions",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/qualityActions/300100255109683/child/AffectedObjects",
"name": "AffectedObjects",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/qualityActions/300100255109683/child/Attachments",
"name": "Attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/qualityActions/300100255109683/child/Relationships",
"name": "Relationships",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/qualityActions/300100255109683/child/WorkflowApprovers",
"name": "WorkflowApprovers",
"kind": "collection"
},
{
"rel": "enclosure",
"href": "https://servername/fscmRestApi/resources/version/qualityActions/300100255109683/enclosure/Description",
"name": "Description",
"kind": "other"
},
{
"rel": "enclosure",
"href": "https://servername/fscmRestApi/resources/version/qualityActions/300100255109683/enclosure/ResolutionDescription",
"name": "ResolutionDescription",
"kind": "other"
}
]
}