Get one requirement line item
get
/fscmRestApi/resources/11.13.18.05/requirementSpecifications/{RequirementId}/child/RequirementVersion/{RequirementVersionId}/child/RequirementLineItem/{RequirementLineItemId}
Request
Path Parameters
-
RequirementId(required): integer
Value that uniquely identifies the requirement specification.
-
RequirementLineItemId(required): integer(int64)
Value that uniquely identifies the requirement line item.
-
RequirementVersionId(required): integer(int64)
Value that uniquely identifies the requirement version.
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(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.
Root Schema : requirementSpecifications-RequirementVersion-RequirementLineItem-item-response
Type:
Show Source
object
-
Attachments: array
Attachments
Title:
Attachments
The Attachments resource manages the attachments of a requirement. -
Content: string
(byte)
Title:
Content
Details of the requirement line item. -
Description: string
Title:
Description
Maximum Length:1000
Description of the requirement line item. -
Estimates: number
Title:
Estimates
Estimates needed to complete the requirement line item. -
Fulfilled: string
Title:
Fulfilled
Maximum Length:30
Value that indicates whether the requirement line item has been fulfilled. -
FulfilledName: string
Read Only:
true
Name of the fulfilled flag. -
Impacts: integer
Read Only:
true
Number of objects impacted by the requirement line item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Requirement
Maximum Length:400
Name of the requirement specification. -
ParentLineItemId: integer
(int64)
Value that uniquely identifies parent line item.
-
ParentSectionNumber: string
Number that identifies the section of the parent line item.
-
Priority: string
Title:
Priority
Maximum Length:30
Priority of the requirement line item. -
PriorityName: string
Read Only:
true
Name of the priority. -
RequirementId: integer
Value that uniquely identifies the requirement.
-
RequirementLineItemId: integer
(int64)
Value that uniquely identifies the requirement line item.
-
RequirementName: string
Read Only:
true
Name of the requirement. -
RequirementVersionId: integer
(int64)
Title:
Requirement Version ID
Value that uniquely identifies the requirement version. -
RequirementVersionNumber: integer
Read Only:
true
Number that identifies the version of the requirement. -
Scope: string
Title:
In Scope
Maximum Length:30
Scope of the requirement line item. -
ScopeName: string
Read Only:
true
Name of the scope. -
SectionNumber: string
Title:
Number
Maximum Length:400
Number that identifies the section of the requirement line item.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The Attachments resource manages the attachments of a requirement.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : requirementSpecifications-RequirementVersion-RequirementLineItem-Attachments-item-response
Type:
Show Source
object
-
AttachedDocumentId: integer
(int64)
Value that uniquely identifies the attached document.
-
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
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 affected item. -
CreationDate: string
(date-time)
Read Only:
true
Date when the attachment was created. -
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 attachment. -
DmFolderPath: string
Maximum Length:
1000
Repository folder path of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Abbreviation that identifies the error code, if any, for the attachment.
-
ErrorStatusMessage: string
Text of the error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
Date when the attachment is no longer valid.
-
FileContents: string
(byte)
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 user most recently updated the attachment. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who most recently updated the attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the attachment for the affected item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Content type of the attachment.
-
UploadedFileLength: integer
Title:
File Size
Length of the attached file. -
UploadedFileName: string
Name of the attached file.
-
UploadedText: string
Text of the attachment.
-
Uri: string
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
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.
Links
- Attachments
-
Parameters:
- RequirementId:
$request.path.RequirementId
- RequirementLineItemId:
$request.path.RequirementLineItemId
- RequirementVersionId:
$request.path.RequirementVersionId
The Attachments resource manages the attachments of a requirement. - RequirementId: