Get one new item request
get
/fscmRestApi/resources/11.13.18.05/newItemRequests/{NewItemRequestId}
Request
Path Parameters
-
NewItemRequestId(required): integer
Value that uniquely identifies the new item request.
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 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 : newItemRequests-item-response
Type:
Show Source
object
-
ApprovalDate: string
(date-time)
Read Only:
true
Date when the new item request object was approved. -
ApprovalRequestDate: string
(date-time)
Read Only:
true
Date when new item request approval was received. -
ApprovalStatusType: integer
(int64)
Read Only:
true
Value that identifies the approval status of the new item request. -
ApprovalStatusValue: string
Read Only:
true
Maximum Length:255
Value that indicates the approval status of the new item request. -
AssignedTo: string
User assigned to the new item request object.
-
attachments: array
Attachments
Title:
Attachments
The Attachments resource gets the attachments of a new item request. -
CancellationDate: string
(date-time)
Read Only:
true
Date when the new item request was canceled. -
ChangeTypeId: integer
(int64)
Value that uniquely identifies the type of the new item request.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the new item request object. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the new item request. -
Description: string
Title:
Description
Maximum Length:2000
Description of the new item request. -
ImplementationDate: string
(date-time)
Read Only:
true
Date when the new item request was implemented. -
InitiationDate: string
(date-time)
Read Only:
true
Date when the new item request was initiated. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the new item request. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the new item request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NeedByDate: string
(date-time)
Date by when the new item request is required.
-
newItemRequestAffectedItems: array
New Item Request Lines
Title:
New Item Request Lines
The New Item Request Affected Items resource contains details of the items in the new item request. -
NewItemRequestId: integer
(int64)
Read Only:
true
Value that uniquely identifies the new item request. -
NewItemRequestName: string
Title:
Name
Maximum Length:240
Name of the new item request. -
NewItemRequestNumber: string
Title:
Number
Maximum Length:50
Number corresponding to the new item request. -
newItemRequestsDFF: array
Flexfields for New Item Requests
Title:
Flexfields for New Item Requests
The Flexfields for New Item Requests resource manages details of the descriptive flexfields in the new item request. -
NewItemRequestType: string
Maximum Length:
255
Value that indicates the type identifier corresponding to the new item request. -
OrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the organization of the new item request. -
OrganizationId: integer
(int64)
Value that uniquely identifies the organization of the new item request.
-
Priority: string
Maximum Length:
255
Value that indicates the priority of the new item request object. -
PriorityCode: string
Maximum Length:
30
Abbreviation that identifies the priority of the new item request. -
Reason: string
Maximum Length:
255
Value that indicates the reason for requesting the new item request. -
ReasonCode: string
Maximum Length:
30
Abbreviation that identifies the reason for the new item request. -
RequestedBy: string
User who requested the new item request.
-
Status: string
Read Only:
true
Maximum Length:255
Value that indicates the status of the new item request. -
StatusCode: integer
(int64)
Read Only:
true
Default Value:0
Abbreviation that identifies the status of the new item request. -
StatusType: integer
(int64)
Read Only:
true
Default Value:0
Value that indicates the type of status of the new item request.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource gets the attachments of a new item request.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : New Item Request Lines
Type:
array
Title:
New Item Request Lines
The New Item Request Affected Items resource contains details of the items in the new item request.
Show Source
Nested Schema : Flexfields for New Item Requests
Type:
array
Title:
Flexfields for New Item Requests
The Flexfields for New Item Requests resource manages details of the descriptive flexfields in the new item request.
Show Source
Nested Schema : newItemRequests-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment for the change object. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type of the attachment. -
Description: string
Title:
Description
Maximum Length:255
Description of the attached file. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Repository folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the attachment expires. -
FileContents: string
(byte)
Title:
File Contents
Contents of the file attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attached file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the attached document was most recently updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who most recently updated the attached document. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the attachment for the change object. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attached file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) of the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : newItemRequests-newItemRequestAffectedItems-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who added the item to the new item request. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user added the item to the new item request. -
Description: string
Read Only:
true
Maximum Length:240
Description of the item. -
EffectiveDate: string
(date-time)
Date when the item becomes effective.
-
ItemClass: string
Read Only:
true
Maximum Length:255
Class of the item in the new item request. -
ItemClassCode: string
Title:
Item Class
Read Only:true
Maximum Length:80
Abbreviation that identifies the item class. -
ItemId: integer
Value that uniquely identifies the item.
-
ItemNumber: string
Read Only:
true
Maximum Length:1000
Number that identifies the item in the new item request. -
ItemRevision: string
Maximum Length:
255
Revision of the item. -
ItemRevisionId: integer
Value that uniquely identifies the item revision.
-
ItemStatus: string
Read Only:
true
Maximum Length:255
Value that identifies the status of the item. -
ItemStatusCode: string
Title:
Item Status
Read Only:true
Maximum Length:10
Abbreviation that identifies the status of the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the item was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the item in the new item request. -
LineStatus: string
Read Only:
true
Maximum Length:255
Value that identifies the status of the item within the new item request. -
LineStatusCode: integer
(int64)
Read Only:
true
Abbreviation that identifies the status of the item within the new item request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NewItemRequestId: integer
Read Only:
true
Value that uniquely identifies the new item request. -
NewItemRequestLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item in the new item request. -
newItemRequestLineTranslations: array
New Item Request Line Translations
Title:
New Item Request Line Translations
The New Item Request Line Translations resource contains details of the translations of a item in the new item request. -
NewItemRequestNumber: string
Read Only:
true
Maximum Length:255
Number that identifies the new item request.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : New Item Request Line Translations
Type:
array
Title:
New Item Request Line Translations
The New Item Request Line Translations resource contains details of the translations of a item in the new item request.
Show Source
Nested Schema : newItemRequests-newItemRequestAffectedItems-newItemRequestLineTranslations-item-response
Type:
Show Source
object
-
CancelComments: string
Maximum Length:
240
Comments for the cancel action. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the translation. -
CreationDate: string
(date-time)
Read Only:
true
Creation date of the translation. -
Description: string
Maximum Length:
2000
Description of the translation. -
Language: string
Maximum Length:
4
Language of the translation. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the translation was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the translation. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login that the user used when updating the translation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Maximum Length:
240
Name of the translation. -
ObjectVersionNumber: integer
(int32)
Version number of the translation.
-
SourceLang: string
Maximum Length:
4
Source language of the translation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : newItemRequests-newItemRequestsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Descriptive flexfield context name for new item requests. -
BaseChangeMgmtTypeCode: string
Maximum Length:
30
Abbreviation that identifies the base change management type of the new item request. -
ChangeId: integer
(int64)
Value that uniquely identifies the new item request.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- attachments
-
Parameters:
- NewItemRequestId:
$request.path.NewItemRequestId
The Attachments resource gets the attachments of a new item request. - NewItemRequestId:
- newItemRequestAffectedItems
-
Parameters:
- NewItemRequestId:
$request.path.NewItemRequestId
The New Item Request Affected Items resource contains details of the items in the new item request. - NewItemRequestId:
- newItemRequestsDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/newItemRequests/{NewItemRequestId}/child/newItemRequestsDFFParameters:
- NewItemRequestId:
$request.path.NewItemRequestId
The Flexfields for New Item Requests resource manages details of the descriptive flexfields in the new item request. - NewItemRequestId:
Examples
This example describes how to get one new item request.
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/newItemRequests/NewItemRequestId"
For example, the following command gets one new item request:
curl -u username:password "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534"
Example Response Body
The following shows an example of the response body in JSON format.
{ "ApprovalDate": null, "ApprovalRequestDate": null, "ApprovalStatusType": 1, "CancellationDate": null, "ChangeTypeId": 100000011980001, "CreatedBy": "PIMQA", "CreationDate": "2018-12-06T22:19:45-08:00", "Description": null, "ImplementationDate": null, "InitiationDate": "2018-12-06T00:00:00-08:00", "LastUpdateDate": "2018-12-06T22:20:04.114-08:00", "LastUpdatedBy": "PIMQA", "NeedByDate": null, "OrganizationId": 204, "ReasonCode": null, "StatusCode": 0, "StatusType": 0, "Status": "Draft", "PriorityCode": "HIGH", "Reason": null, "Priority": "High", "NewItemRequestId": 300100151858534, "NewItemRequestType": "New Item Request", "NewItemRequestName": "PLM26733_RestWS_NIR00061_ZCH", "NewItemRequestNumber": "PLM26733_RestWS_NIR00061_ZCH", "ApprovalStatusValue": "Not submitted for approval", "OrganizationCode": "V1", "AssignedTo": "PIMQA", "RequestedBy": "PIMQA", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534", "name": "newItemRequests", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534", "name": "newItemRequests", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534/lov/PrioritiesLookupPVO1", "name": "PrioritiesLookupPVO1", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534/lov/ApprovalStatusTypesLookupPVO", "name": "ApprovalStatusTypesLookupPVO", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534/lov/UserPVO1", "name": "UserPVO1", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534/lov/ReasonsLookupPVO1", "name": "ReasonsLookupPVO1", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534/lov/UserPVO2", "name": "UserPVO2", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534/lov/LOVForOrganization", "name": "LOVForOrganization", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534/lov/ChangeOrderTypeVO1", "name": "ChangeOrderTypeVO1", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534/child/newItemRequestAffectedItems", "name": "newItemRequestAffectedItems", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151858534/child/newItemRequestsDFF", "name": "newItemRequestsDFF", "kind": "collection" } ] }