Jump to

• Request
• Response

Get all parts

get

/fscmRestApi/resources/11.13.18.05/servicePartReturns

Request

Query Parameters

• 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
• finder: string
  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 parts to be returned according to the specified primary key criteria.
    Finder Variables:
    • ReturnId; integer; Value that uniquely identifies the parts to be returned.
• limit: integer
  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.
• 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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • CreatedBy; string; User who created the row.
  • CreationDate; string; Date and time when the user created the row.
  • DestinationOganizationCode; string; Abbreviation that identifies the organization where the part should be returned.
  • DestinationOrganizationId; integer; Value that uniquely identifies the organization where the part should be returned.
  • DestinationOrganizationName; string; Name of the organization where the part should be returned.
  • DestinationSubinventory; string; Subinventory where the part should be returned.
  • ItemDescription; string; Description of the part to be returned.
  • ItemId; integer; Value that uniquely identifies the inventory item of the part to be returned
  • ItemNumber; string; Number that identifies the inventory item of the part to be returned.
  • LastReceivedDate; string; Date when the part was last received at its current stocking location.
  • LastUpdateDate; string; Date and time when the user most recently updated the row.
  • LastUpdateLogin; string; Login that the user used when updating the row.
  • LastUpdatedBy; string; User who most recently updated the row.
  • OrganizationCode; string; Abbreviation that identifies the inventory organization where the parts are located.
  • OrganizationId; integer; Value that uniquely identifies the inventory organization where the parts are located.
  • OrganizationName; string; Name of the inventory organization where the parts are located.
  • OwningPartyId; integer; Value that uniquely identifies the field service technician assigned to this stocking location.
  • OwningPartyName; string; Name of the field service technician assigned to this stocking location.
  • Quantity; number; Quantity of the part to be returned.
  • RecoveredPartDispositionCode; string; Abbreviation that identifies the recovered part inventory item's disposition.
  • RecoveredPartsDisposition; string; Description of the recovered part disposition. Valid values are Fast return, Slow return, and No return.
  • ReturnAddress; string; Address of stocking location where the part should be returned.
  • ReturnId; integer; Value that uniquely identifies the parts to be returned.
  • ReturnType; string; Type of the return.
  • ReturnTypeCode; string; Abbreviation that identifies the reason why the part should be returned. Valid values are EXCESS or DEFECTIVE.
  • Revision; string; Revision of the inventory item of the part to be returned.
  • StockLocationId; integer; Value that uniquely identifies the stocking location to be searched for parts that need to be returned.
  • Subinventory; string; Subinventory where the parts are located.
  • UOMCode; string; Abbreviation that identifies the unit of measure of the inventory item of the part to be returned.
  • UnitOfMeasure; string; Unit of measure of the inventory item of the part to be returned.
• totalResults: boolean
  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

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

Body ()

Root Schema : servicePartReturns

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/servicePartReturns-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Maintenance",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object servicePartReturns-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/servicePartReturns-item-response"
    }
}

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 : servicePartReturns-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the row.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the row.
• DestinationOganizationCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the organization where the part should be returned.
• DestinationOrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization where the part should be returned.
• DestinationOrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the organization where the part should be returned.
• DestinationSubinventory: string
  Read Only: true

  Maximum Length: 10

  Subinventory where the part should be returned.
• ItemDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the part to be returned.
• ItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory item of the part to be returned
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number that identifies the inventory item of the part to be returned.
• LastReceivedDate: string (date)
  Read Only: true

  Date when the part was last received at its current stocking location.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the row.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the row.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 64

  Login that the user used when updating the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 18

  Abbreviation that identifies the inventory organization where the parts are located.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory organization where the parts are located.
• OrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the inventory organization where the parts are located.
• OwningPartyId: integer (int64)
  Read Only: true

  Value that uniquely identifies the field service technician assigned to this stocking location.
• OwningPartyName: string
  Read Only: true

  Maximum Length: 360

  Name of the field service technician assigned to this stocking location.
• Quantity: number
  Read Only: true

  Quantity of the part to be returned.
• RecoveredPartDispositionCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the recovered part inventory item's disposition.
• RecoveredPartsDisposition: string
  Read Only: true

  Maximum Length: 80

  Description of the recovered part disposition. Valid values are Fast return, Slow return, and No return.
• ReturnAddress: string
  Read Only: true

  Maximum Length: 4000

  Address of stocking location where the part should be returned.
• ReturnId: integer
  Read Only: true

  Value that uniquely identifies the parts to be returned.
• ReturnType: string
  Read Only: true

  Maximum Length: 80

  Type of the return.
• ReturnTypeCode: string
  Read Only: true

  Maximum Length: 10

  Abbreviation that identifies the reason why the part should be returned. Valid values are EXCESS or DEFECTIVE.
• Revision: string
  Read Only: true

  Maximum Length: 18

  Revision of the inventory item of the part to be returned.
• StockLocationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the stocking location to be searched for parts that need to be returned.
• Subinventory: string
  Read Only: true

  Maximum Length: 10

  Subinventory where the parts are located.
• UnitOfMeasure: string
  Read Only: true

  Maximum Length: 25

  Unit of measure of the inventory item of the part to be returned.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure of the inventory item of the part to be returned.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the inventory organization where the parts are located.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecoveredPartsDisposition":{
            "maxLength":80,
            "type":"string",
            "description":"Description of the recovered part disposition. Valid values are Fast return, Slow return, and No return.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the row.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReturnId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parts to be returned.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization where the part should be returned.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DestinationOrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization where the part should be returned.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization where the parts are located.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item of the part to be returned",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the part to be returned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReturnAddress":{
            "maxLength":4000,
            "type":"string",
            "description":"Address of stocking location where the part should be returned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationOganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the organization where the part should be returned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the inventory item of the part to be returned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwningPartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the field service technician assigned to this stocking location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization where the parts are located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure of the inventory item of the part to be returned.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecoveredPartDispositionCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the recovered part inventory item's disposition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure of the inventory item of the part to be returned.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReturnTypeCode":{
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the reason why the part should be returned. Valid values are EXCESS or DEFECTIVE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the part to be returned.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationSubinventory":{
            "maxLength":10,
            "type":"string",
            "description":"Subinventory where the part should be returned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastReceivedDate":{
            "type":"string",
            "description":"Date when the part was last received at its current stocking location.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReturnType":{
            "maxLength":80,
            "type":"string",
            "description":"Type of the return.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwningPartyName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the field service technician assigned to this stocking location.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StockLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the stocking location to be searched for parts that need to be returned.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Revision":{
            "maxLength":18,
            "type":"string",
            "description":"Revision of the inventory item of the part to be returned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Subinventory":{
            "maxLength":10,
            "type":"string",
            "description":"Subinventory where the parts are located.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the row.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":64,
            "type":"string",
            "description":"Login that the user used when updating the row.",
            "nullable":true,
            "readOnly":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 : 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."
        }
    }
}

Back to Top