Jump to

• Request
• Response

Get one organization

get

/fscmRestApi/resources/11.13.18.05/massReplacementOrgs/{massReplacementOrgsUniqID}

Request

Path Parameters

• massReplacementOrgsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- OrganizationId and RequisitioningBUId ---for the Mass Replacement Organizations resource and used to uniquely identify an instance of Mass Replacement Organizations. The client should not generate the hash key value. Instead, the client should query on the Mass Replacement Organizations collection resource with a filter on the primary key values in order to navigate to a specific instance of Mass Replacement Organizations.
  
  For example: massReplacementOrgs?q=OrganizationId=<value1>;RequisitioningBUId=<value2>

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

Type: object

Show Source

• AlternateItem: string
  Read Only: true

  Attribute that indicates the values of the substitute master item and the corresponding item description for the disrupted item in an impacted inventory organization.
• AlternateItemCount: integer
  Read Only: true

  Count of alternate internal items for an inventory organization.
• AlternateMPN: string
  Read Only: true

  Attribute that indicates the values of the alternate manufacturer part number (MPN) and the corresponding manufacturer part description for the disrupted MPN in an impacted inventory organization.
• AlternateMPNCount: integer
  Read Only: true

  Count of alternate manufacturer part numbers for an inventory organization.
• AlternateSupplier: string
  Read Only: true

  Attribute that indicates the values of the alternate supplier and the corresponding supplier site for the disrupted item or manufacturer part number (MPN) in an impacted inventory organization.
• AlternateSupplierCount: integer
  Read Only: true

  Count of alternate suppliers for an inventory organization.
• ErrorFlag: boolean
  Read Only: true

  Attribute indicating that an exception occurred during the execution of the mass replacement process for a replacement organization.
• GroupedOrgIds: string
  Read Only: true

  Maximum Length: 255

  Unique identifier for a set of grouped organizations.
• GroupedRequisitioningBUIds: string
  Read Only: true

  Maximum Length: 255

  Unique identifier for a set of grouped requisitioning business units.
• GroupId: integer
  Read Only: true

  Attribute that indicates the unique identifier for the grouping done on the impacted organizations for an item replacement task.
• 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 master organization with which the primary item is associated.
• OrganizationId: integer
  Read Only: true

  Value that uniquely identifies the inventory organization.
• OrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the inventory organization.
• PrimarySourceDetails: string
  Read Only: true

  Maximum Length: 255

  Value that represents the source agreement details for the disrupted item.
• PurchaseOrderLinesCount: integer
  Read Only: true

  Count of purchase order lines that can possibly undergo replacement.
• ReinstateDate: string (date)
  Read Only: true

  Date on which the reinstate action is initiated and the replacement period ends.
• ReplacementDate: string (date)
  Read Only: true

  Date on which the replacement action is initiated and the replacement period begins.
• ReplacementDetailId: integer
  Read Only: true

  Value that uniquely identifies the replacement line.
• ReplacementMethod: string
  Read Only: true

  Value that indicates the replacement method selected, whether alternate supplier or alternate item.
• RequisitioningBUId: integer (int64)
  Read Only: true

  Value that uniquely identifies the requisitioning business unit.
• RequisitioningBUName: string
  Read Only: true

  Maximum Length: 240

  Name of the requisitioning business unit.
• SearchOrganizationCode: string
  Read Only: true

  Maximum Length: 255

  Organization code attribute used as a search criteria to get the impacted organizations for an item-replacement task.
• SelectedReplacement: string
  Read Only: true

  Value of the replacement option selected. When the replacement method is alternate supplier, this value is populated with the supplier name. If the replacement method is alternate item, this value is populated with MPN or internal item number depending on the item number type selected while defining the replacement.
• Status: string
  Read Only: true

  Status of replacement at the organization level.
• StatusCode: string
  Read Only: true

  Lookup value code of the replacement status at the organization level.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the inventory organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitioningBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requisitioning business unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AlternateMPNCount":{
            "type":"integer",
            "description":"Count of alternate manufacturer part numbers for an inventory organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PurchaseOrderLinesCount":{
            "type":"integer",
            "description":"Count of purchase order lines that can possibly undergo replacement.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "StatusCode"
                ]
            },
            "x-queryable":true
        },
        "ReplacementDate":{
            "type":"string",
            "description":"Date on which the replacement action is initiated and the replacement period begins.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "type":"string",
            "description":"Lookup value code of the replacement status at the organization level.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "AlternateItem",
                    "AlternateMPN",
                    "AlternateSupplier"
                ]
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that identifies the master organization with which the primary item is associated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateMPN":{
            "type":"string",
            "description":"Attribute that indicates the values of the alternate manufacturer part number (MPN) and the corresponding manufacturer part description for the disrupted MPN in an impacted inventory organization.",
            "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"
            }
        },
        "AlternateItemCount":{
            "type":"integer",
            "description":"Count of alternate internal items for an inventory organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SelectedReplacement":{
            "type":"string",
            "description":"Value of the replacement option selected. When the replacement method is alternate supplier, this value is populated with the supplier name. If the replacement method is alternate item, this value is populated with MPN or internal item number depending on the item number type selected while defining the replacement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"Status of replacement at the organization level.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "StatusCode"
                ]
            },
            "x-queryable":true
        },
        "PrimarySourceDetails":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that represents the source agreement details for the disrupted item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateItem":{
            "type":"string",
            "description":"Attribute that indicates the values of the substitute master item and the corresponding item description for the disrupted item in an impacted inventory organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorFlag":{
            "type":"boolean",
            "description":"Attribute indicating that an exception occurred during the execution of the mass replacement process for a replacement organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SearchOrganizationCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Organization code attribute used as a search criteria to get the impacted organizations for an item-replacement task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "OrganizationCode"
                ]
            },
            "x-queryable":true
        },
        "ReplacementMethod":{
            "type":"string",
            "description":"Value that indicates the replacement method selected, whether alternate supplier or alternate item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReinstateDate":{
            "type":"string",
            "description":"Date on which the reinstate action is initiated and the replacement period ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitioningBUName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the requisitioning business unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateSupplier":{
            "type":"string",
            "description":"Attribute that indicates the values of the alternate supplier and the corresponding supplier site for the disrupted item or manufacturer part number (MPN) in an impacted inventory organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateSupplierCount":{
            "type":"integer",
            "description":"Count of alternate suppliers for an inventory organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Attribute that indicates the unique identifier for the grouping done on the impacted organizations for an item replacement task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupedRequisitioningBUIds":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier for a set of grouped requisitioning business units.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReplacementDetailId":{
            "type":"integer",
            "description":"Value that uniquely identifies the replacement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupedOrgIds":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier for a set of grouped organizations.",
            "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