Get all new item requests

get

/fscmRestApi/resources/11.13.18.05/newItemRequests

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Find new item requests according to the primary key.
      Finder Variables:
      • NewItemRequestId; integer; Value that uniquely identifies the new item request.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ApprovalDate; string; Date when the new item request object was approved.
    • ApprovalRequestDate; string; Date when new item request approval was received.
    • ApprovalStatusType; integer; Value that identifies the approval status of the new item request.
    • ApprovalStatusValue; string; Value that indicates the approval status of the new item request.
    • AssignedTo; string; User assigned to the new item request object.
    • CancellationDate; string; Date when the new item request was canceled.
    • ChangeTypeId; integer; Value that uniquely identifies the type of the new item request.
    • CreatedBy; string; User who created the new item request object.
    • CreationDate; string; Date and time when the user created the new item request.
    • Description; string; Description of the new item request.
    • ImplementationDate; string; Date when the new item request was implemented.
    • InitiationDate; string; Date when the new item request was initiated.
    • LastUpdateDate; string; Date when the user most recently updated the new item request.
    • LastUpdatedBy; string; User who most recently updated the new item request.
    • NeedByDate; string; Date by when the new item request is required.
    • NewItemRequestId; integer; Value that uniquely identifies the new item request.
    • NewItemRequestName; string; Name of the new item request.
    • NewItemRequestNumber; string; Number corresponding to the new item request.
    • NewItemRequestType; string; Value that indicates the type identifier corresponding to the new item request.
    • OrganizationCode; string; Abbreviation that identifies the organization of the new item request.
    • OrganizationId; integer; Value that uniquely identifies the organization of the new item request.
    • Priority; string; Value that indicates the priority of the new item request object.
    • PriorityCode; string; Abbreviation that identifies the priority of the new item request.
    • Reason; string; Value that indicates the reason for requesting the new item request.
    • ReasonCode; string; Abbreviation that identifies the reason for the new item request.
    • RequestedBy; string; User who requested the new item request.
    • Status; string; Value that indicates the status of the new item request.
    • StatusCode; integer; Abbreviation that identifies the status of the new item request.
    • StatusType; integer; Value that indicates the type of status of the new item request.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : newItemRequests
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : newItemRequests-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource gets the attachments of a new item request.
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: object
Show Source
Nested Schema : newItemRequests-newItemRequestAffectedItems-item-response
Type: object
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: object
Show Source
Nested Schema : newItemRequests-newItemRequestsDFF-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all new item requests.

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/receiptCosts/TransactionId/child/ReceiptCostDetails"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"items": [
	{
		"ApprovalDate": null,
		"ApprovalRequestDate": null,
		"ApprovalStatusType": 1,
		"CancellationDate": null,
		"ChangeTypeId": 100000011980001,
		"CreatedBy": "PIMQA",
		"CreationDate": "2018-11-13T00:13:36-08:00",
		"Description": null,
		"ImplementationDate": null,
		"InitiationDate": "2018-11-27T23:51:40-08:00",
		"LastUpdateDate": "2018-11-27T23:51:40.768-08:00",
		"LastUpdatedBy": "PIMQA",
		"NeedByDate": null,
		"OrganizationId": 204,
		"ReasonCode": null,
		"StatusCode": 1,
		"StatusType": 1,
		"Status": "Open",
		"PriorityCode": "HIGH",
		"Reason": null,
		"Priority": "High",
		"NewItemRequestId": 300100151792531,
		"NewItemRequestType": "New Item Request",
		"NewItemRequestName": "PLM26733_RestWS_NIR00051_ZCH",
		"NewItemRequestNumber": "PLM26733_RestWS_NIR00051_ZCH",
		"ApprovalStatusValue": "Not submitted for approval",
		"OrganizationCode": "V1",
		"AssignedTo": "PIMQA",
		"RequestedBy": "PIMQA",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151792531",
			"name": "newItemRequests",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151792531",
			"name": "newItemRequests",
			"kind": "item"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151792531/lov/PrioritiesLookupPVO1",
			"name": "PrioritiesLookupPVO1",
			"kind": "collection"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151792531/lov/ApprovalStatusTypesLookupPVO",
			"name": "ApprovalStatusTypesLookupPVO",
			"kind": "collection"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151792531/lov/UserPVO1",
			"name": "UserPVO1",
			"kind": "collection"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151792531/lov/ReasonsLookupPVO1",
			"name": "ReasonsLookupPVO1",
			"kind": "collection"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151792531/lov/UserPVO2",
			"name": "UserPVO2",
			"kind": "collection"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151792531/lov/LOVForOrganization",
			"name": "LOVForOrganization",
			"kind": "collection"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151792531/lov/ChangeOrderTypeVO1",
			"name": "ChangeOrderTypeVO1",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151792531/child/newItemRequestAffectedItems",
			"name": "newItemRequestAffectedItems",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151792531/child/newItemRequestsDFF",
			"name": "newItemRequestsDFF",
			"kind": "collection"
		}
		]
	},
	{
		"ApprovalDate": null,
		"ApprovalRequestDate": null,
		"ApprovalStatusType": 1,
		"CancellationDate": null,
		"ChangeTypeId": 100000011980001,
		"CreatedBy": "PIMQA",
		"CreationDate": "2018-11-14T23:27:42-08:00",
		"Description": null,
		"ImplementationDate": null,
		"InitiationDate": "2018-11-14T00:00:00-08:00",
		"LastUpdateDate": "2018-11-14T23:28:04.567-08:00",
		"LastUpdatedBy": "PIMQA",
		"NeedByDate": null,
		"OrganizationId": 204,
		"ReasonCode": null,
		"StatusCode": 0,
		"StatusType": 0,
		"Status": "Draft",
		"PriorityCode": "HIGH",
		"Reason": null,
		"Priority": "High",
		"NewItemRequestId": 300100151808525,
		"NewItemRequestType": "New Item Request",
		"NewItemRequestName": "PLM26733_RestWS_NIR00056_ZCH",
		"NewItemRequestNumber": "PLM26733_RestWS_NIR00056_ZCH",
		"ApprovalStatusValue": "Not submitted for approval",
		"OrganizationCode": "V1",
		"AssignedTo": "PIMQA",
		"RequestedBy": "PIMQA",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151808525",
			"name": "newItemRequests",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151808525",
			"name": "newItemRequests",
			"kind": "item"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151808525/lov/PrioritiesLookupPVO1",
			"name": "PrioritiesLookupPVO1",
			"kind": "collection"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151808525/lov/ApprovalStatusTypesLookupPVO",
			"name": "ApprovalStatusTypesLookupPVO",
			"kind": "collection"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151808525/lov/UserPVO1",
			"name": "UserPVO1",
			"kind": "collection"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151808525/lov/ReasonsLookupPVO1",
			"name": "ReasonsLookupPVO1",
			"kind": "collection"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151808525/lov/UserPVO2",
			"name": "UserPVO2",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151808525/child/newItemRequestAffectedItems",
			"name": "newItemRequestAffectedItems",
			"kind": "collection"
		}
		]
	}
	],
	"count": 2,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/newItemRequests",
		"name": "newItemRequests",
		"kind": "collection"
	}
	]
}
Back to Top