Jump to

• Request
• Response
• Examples

Get one affected item

get

/fscmRestApi/resources/11.13.18.05/newItemRequests/{NewItemRequestId}/child/newItemRequestAffectedItems/{newItemRequestAffectedItemsUniqID}

Request

Path Parameters

• NewItemRequestId(required): integer
  Value that uniquely identifies the new item request.
• newItemRequestAffectedItemsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the New Item Request Lines resource and used to uniquely identify an instance of New Item Request Lines. The client should not generate the hash key value. Instead, the client should query on the New Item Request Lines collection resource in order to navigate to a specific instance of New Item Request Lines 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:
  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 : newItemRequests-newItemRequestAffectedItems-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the item in the new item request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user added the item to the new item request.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemClass":{
            "maxLength":"255",
            "type":"string",
            "description":"Class of the item in the new item request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the status of the item.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemRevisionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item revision.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemClassCode":{
            "title":"Item Class",
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that identifies the item class.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who added the item to the new item request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineStatusCode":{
            "type":"integer",
            "description":"Abbreviation that identifies the status of the item within the new item request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "newItemRequestLineTranslations":{
            "title":"New Item Request Line Translations",
            "type":"array",
            "description":"The New Item Request Line Translations resource contains details of the translations of a item in the new item request.",
            "items":{
                "$ref":"#/components/schemas/newItemRequests-newItemRequestAffectedItems-newItemRequestLineTranslations-item-response"
            }
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "nullable":false,
            "x-queryable":true
        },
        "LineStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the status of the item within the new item request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "NewItemRequestNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the new item request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NewItemRequestId":{
            "type":"integer",
            "description":"Value that uniquely identifies the new item request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"1000",
            "type":"string",
            "description":"Number that identifies the item in the new item request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemStatusCode":{
            "title":"Item Status",
            "maxLength":"10",
            "type":"string",
            "description":"Abbreviation that identifies the status of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemRevision":{
            "maxLength":"255",
            "type":"string",
            "description":"Revision of the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "NewItemRequestLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item in the new item request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the item was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveDate":{
            "type":"string",
            "description":"Date when the item becomes effective.",
            "format":"date-time",
            "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 : 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

• Array of: object newItemRequests-newItemRequestAffectedItems-newItemRequestLineTranslations-item-response

{
    "title":"New Item Request Line Translations",
    "type":"array",
    "description":"The New Item Request Line Translations resource contains details of the translations of a item in the new item request.",
    "items":{
        "$ref":"#/components/schemas/newItemRequests-newItemRequestAffectedItems-newItemRequestLineTranslations-item-response"
    }
}

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."
        }
    }
}

Nested Schema : newItemRequests-newItemRequestAffectedItems-newItemRequestLineTranslations-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the translation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Creation date of the translation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the translation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the translation.",
            "nullable":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":"4",
            "type":"string",
            "description":"Language of the translation.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number of the translation.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":"4",
            "type":"string",
            "description":"Source language of the translation.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CancelComments":{
            "maxLength":"240",
            "type":"string",
            "description":"Comments for the cancel action.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the translation was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login that the user used when updating the translation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the translation.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"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"
    }
}

Links

newItemRequestLineTranslations

Operation: /fscmRestApi/resources/11.13.18.05/newItemRequests/{NewItemRequestId}/child/newItemRequestAffectedItems/{newItemRequestAffectedItemsUniqID}/child/newItemRequestLineTranslations

Parameters:

• NewItemRequestId: $request.path.NewItemRequestId
• newItemRequestAffectedItemsUniqID: $request.path.newItemRequestAffectedItemsUniqID

The New Item Request Line Translations resource contains details of the translations of a item in the new item request.

Back to Top

Examples

This example describes how to get one affected item.

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/child/newItemRequestAffectedItems/NewItemRequestLineId"

For example, the following command gets one affected item:

curl -u username:password "https://servername/fscmRestApi/resources/version/newItemRequests/300100151809560/child/newItemRequestAffectedItems/00030000000EACED0005770800000000000000CC0000000EACED00057708000110F082F2D5720000000EACED00057708000110F082F1A90E"

Example Response Body

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

{
	"ItemNumber": "PLM_ZCH_020",
	"ItemClassCode": "300100039973349",
	"Description": "PLM_ZCH_020 DES",
	"CreatedBy": "PIMQA",
	"CreationDate": "2018-12-06T23:21:13-08:00",
	"LastUpdateDate": "2018-12-06T23:21:16.002-08:00",
	"LastUpdatedBy": "PIMQA",
	"ItemClass": "R9QA_EFF_Product_Review_NT_TR_NIR",
	"ItemStatus": "Active",
	"LineStatus": "Open",
	"NewItemRequestLineId": 300100151858546,
	"ItemStatusCode": "Active",
	"LineStatusCode": 1,
	"ItemRevisionId": 300100151781666,
	"ItemId": 300100151781646,
	"EffectiveDate": null,
	"NewItemRequestId": 300100151809560,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151809560/child/newItemRequestAffectedItems/00030000000EACED0005770800000000000000CC0000000EACED00057708000110F082F2D5720000000EACED00057708000110F082F1A90E",
		"name": "newItemRequestAffectedItems",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151809560/child/newItemRequestAffectedItems/00030000000EACED0005770800000000000000CC0000000EACED00057708000110F082F2D5720000000EACED00057708000110F082F1A90E",
		"name": "newItemRequestAffectedItems",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151809560",
		"name": "newItemRequests",
		"kind": "item"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151809560/child/newItemRequestAffectedItems/00030000000EACED0005770800000000000000CC0000000EACED00057708000110F082F2D5720000000EACED00057708000110F082F1A90E/lov/ItemClassPVO1",
		"name": "ItemClassPVO1",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151809560/child/newItemRequestAffectedItems/00030000000EACED0005770800000000000000CC0000000EACED00057708000110F082F2D5720000000EACED00057708000110F082F1A90E/lov/LookupPVO1",
		"name": "LookupPVO1",
		"kind": "collection"
	},
	{
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/newItemRequests/300100151809560/child/newItemRequestAffectedItems/00030000000EACED0005770800000000000000CC0000000EACED00057708000110F082F2D5720000000EACED00057708000110F082F1A90E/lov/ItemStatusPVO1",
		"name": "ItemStatusPVO1",
		"kind": "collection"
	}
	]
}

Back to Top