Get Delete Group Details by Delete Group Name

You can manage, create, and edit delete groups using the Delete Groups REST resource. The resource allows you to add and remove items, structures, components, change orders, and new item requests to delete groups.

Note:

See the Privileges topic for access requirements for this REST operation.

Get Delete Group Details by Delete Group Name

In this scenario, you can use the REST API to fetch a delete group's details by using the delete group name as a query parameter.

GET

Example cURL Command

Use this URL format.

curl -u username:password "https://servername/fscmRestApi/resources/version/deleteGroups/?q=DeleteGroupName=IDC13_DG_ITEMS_01"

Example Response

Here's an example of the response body in JSON format.

{
    "items": [
        {
            "CreatedBy": "PIMQA",
            "CreationDate": "2023-12-24T13:59:02.002+00:00",
            "DateLastSubmitted": null,
            "DeleteGroupName": "IDC13_DG_ITEMS_01",
            "DeleteGroupSequenceId": 300100597873441,
            "Description": "IDC13_DG_WITH_ITEMs",
            "LastActivity": null,
            "LastActivityStatus": null,
            "LastUpdateDate": "2023-12-24T13:59:02.036+00:00",
            "LastUpdateLogin": "0C4F67A0D30DFDF6E063026415AC937B",
            "LastUpdatedBy": "PIMQA",
            "ObjectVersionNumber": 1,
            "ProcessStatus": null,
            "InstanceId": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/deleteGroups/300100597873441",
                    "name": "deleteGroups",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/deleteGroups/300100597873441",
                    "name": "deleteGroups",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/deleteGroups/300100597873441/child/changeOrders",
                    "name": "changeOrders",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/deleteGroups/300100597873441/child/components",
                    "name": "components",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/deleteGroups/300100597873441/child/items",
                    "name": "items",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/deleteGroups/300100597873441/child/newItemRequests",
                    "name": "newItemRequests",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/deleteGroups/300100597873441/child/structures",
                    "name": "structures",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/deleteGroups",
            "name": "deleteGroups",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/deleteGroups/action/submitForDelete",
            "name": "submitForDelete",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/deleteGroups/action/checkConstraints",
            "name": "checkConstraints",
            "kind": "other"
        }
    ]
}